Snmpv3Properties (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.Snmpv3Properties

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Snmpv3Properties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This object contains list of SNMP v3 users used to poll NSX nodes over SNMP and list of SNMP v3 targets used to receive SNMP traps/notifications from NSX nodes. Users specified in a SNMP v3 target must exist in the list of SNMP v3 users.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Snmpv3Properties.Builder
Builder class for Snmpv3Properties.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Snmpv3Properties.Builder` Builder class for `Snmpv3Properties`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`AUTH_PROTOCOL_SHA1`
`static java.lang.String`	`PRIV_PROTOCOL_AES128`

Constructor Summary

Constructors
Modifier Constructor and Description

Snmpv3Properties()
Default constructor.

protected Snmpv3Properties(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Snmpv3Properties()` Default constructor.
`protected`	`Snmpv3Properties(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static Snmpv3Properties`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static Snmpv3Properties`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getAuthProtocol()` Possible values are: `AUTH_PROTOCOL_SHA1` Authentication protocol used for SNMP v3 communication.
`java.util.List<CCSnmpV3User>`	`getCcUsers()` List of CentralConfig SNMP v3 users allowed to poll NSX nodes over SNMP.
`java.lang.String`	`getPrivProtocol()` Possible values are: `PRIV_PROTOCOL_AES128` Privacy protocol used for SNMP v3 communication.
`java.util.List<Snmpv3Target>`	`getTargets()` List of SNMP v3 targets/receivers where SNMP v3 traps/notifications will be sent from NSX nodes.
`java.util.List<Snmpv3User>`	`getUsers()` Deprecated.
`int`	`hashCode()`
`void`	`setAuthProtocol(java.lang.String authProtocol)` Possible values are: `AUTH_PROTOCOL_SHA1` Authentication protocol used for SNMP v3 communication.
`void`	`setCcUsers(java.util.List<CCSnmpV3User> ccUsers)` List of CentralConfig SNMP v3 users allowed to poll NSX nodes over SNMP.
`void`	`setPrivProtocol(java.lang.String privProtocol)` Possible values are: `PRIV_PROTOCOL_AES128` Privacy protocol used for SNMP v3 communication.
`void`	`setTargets(java.util.List<Snmpv3Target> targets)` List of SNMP v3 targets/receivers where SNMP v3 traps/notifications will be sent from NSX nodes.
`void`	`setUsers(java.util.List<Snmpv3User> users)` Deprecated.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - AUTH_PROTOCOL_SHA1
```
public static final java.lang.String AUTH_PROTOCOL_SHA1
```
    See Also:
    
    Constant Field Values
  - PRIV_PROTOCOL_AES128
```
public static final java.lang.String PRIV_PROTOCOL_AES128
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - Snmpv3Properties
```
public Snmpv3Properties()
```
    Default constructor.
  - Snmpv3Properties
```
protected Snmpv3Properties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAuthProtocol
```
public java.lang.String getAuthProtocol()
```
    Possible values are:
    - AUTH_PROTOCOL_SHA1
    Authentication protocol used for SNMP v3 communication.
    Returns:
    
    The current value of the property.
  - setAuthProtocol
```
public void setAuthProtocol(java.lang.String authProtocol)
```
    Possible values are:
    - AUTH_PROTOCOL_SHA1
    Authentication protocol used for SNMP v3 communication.
    Parameters:
    
    authProtocol - New value for the property.
  - getCcUsers
```
public java.util.List<CCSnmpV3User> getCcUsers()
```
    List of CentralConfig SNMP v3 users allowed to poll NSX nodes over SNMP. Also, users specified in a SNMP v3 target must exist in this list.
    
    Returns:
    
    The current value of the property.
  - setCcUsers
```
public void setCcUsers(java.util.List<CCSnmpV3User> ccUsers)
```
    List of CentralConfig SNMP v3 users allowed to poll NSX nodes over SNMP. Also, users specified in a SNMP v3 target must exist in this list.
    
    Parameters:
    
    ccUsers - New value for the property.
  - getPrivProtocol
```
public java.lang.String getPrivProtocol()
```
    Possible values are:
    - PRIV_PROTOCOL_AES128
    Privacy protocol used for SNMP v3 communication.
    Returns:
    
    The current value of the property.
  - setPrivProtocol
```
public void setPrivProtocol(java.lang.String privProtocol)
```
    Possible values are:
    - PRIV_PROTOCOL_AES128
    Privacy protocol used for SNMP v3 communication.
    Parameters:
    
    privProtocol - New value for the property.
  - getTargets
```
public java.util.List<Snmpv3Target> getTargets()
```
    List of SNMP v3 targets/receivers where SNMP v3 traps/notifications will be sent from NSX nodes.
    
    Returns:
    
    The current value of the property.
  - setTargets
```
public void setTargets(java.util.List<Snmpv3Target> targets)
```
    List of SNMP v3 targets/receivers where SNMP v3 traps/notifications will be sent from NSX nodes.
    
    Parameters:
    
    targets - New value for the property.
  - getUsers
```
@Deprecated
public java.util.List<Snmpv3User> getUsers()
```
    Deprecated.
    
    List of SNMP v3 users allowed to poll NSX nodes over SNMP. Also, users specified in a SNMP v3 target must exist in this list.
    
    Returns:
    
    The current value of the property.
  - setUsers
```
@Deprecated
public void setUsers(java.util.List<Snmpv3User> users)
```
    Deprecated.
    
    List of SNMP v3 users allowed to poll NSX nodes over SNMP. Also, users specified in a SNMP v3 target must exist in this list.
    
    Parameters:
    
    users - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static Snmpv3Properties _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static Snmpv3Properties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Snmpv3Properties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

AUTH_PROTOCOL_SHA1

PRIV_PROTOCOL_AES128

__dynamicStructureFields

Constructor Detail

Snmpv3Properties

Snmpv3Properties

Method Detail

getAuthProtocol

setAuthProtocol

getCcUsers

setCcUsers

getPrivProtocol

setPrivProtocol

getTargets

setTargets

getUsers

setUsers

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2