Snmpv3User (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Snmpv3User
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
This object contains properties for a SNMP v3 user that can be used to receive SNMP traps/notifications from NSX and/or poll NSX nodes over SNMP.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Snmpv3User.Builder
Builder class for Snmpv3User.

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

Field Summary

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

Constructor Summary

Constructors
Modifier Constructor and Description

Snmpv3User()
Default constructor.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete 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 Snmpv3User`	`_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 Snmpv3User`	`_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`	`getAccess()` Possible values are: `ACCESS_ONLY` Access permissions for polling NSX nodes over SNMP v3.
`java.lang.String`	`getAuthPassword()` Authentication password used for SNMP v3 communication.
`java.lang.String`	`getPrivPassword()` Privacy password used for SNMP v3 communication.
`java.lang.String`	`getSecurityLevel()` Possible values are: `SECURITY_LEVEL_PRIV` Security level indicates whether SNMP communication involves authentication and privacy protocols for this user.
`java.lang.String`	`getUserId()` Unique SNMP v3 user id.
`int`	`hashCode()`
`void`	`setAccess(java.lang.String access)` Possible values are: `ACCESS_ONLY` Access permissions for polling NSX nodes over SNMP v3.
`void`	`setAuthPassword(java.lang.String authPassword)` Authentication password used for SNMP v3 communication.
`void`	`setPrivPassword(java.lang.String privPassword)` Privacy password used for SNMP v3 communication.
`void`	`setSecurityLevel(java.lang.String securityLevel)` Possible values are: `SECURITY_LEVEL_PRIV` Security level indicates whether SNMP communication involves authentication and privacy protocols for this user.
`void`	`setUserId(java.lang.String userId)` Unique SNMP v3 user id.
`java.lang.String`	`toString()`

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

- Field Detail
  - ACCESS_ONLY
```
public static final java.lang.String ACCESS_ONLY
```
    See Also:
    
    Constant Field Values
  - SECURITY_LEVEL_PRIV
```
public static final java.lang.String SECURITY_LEVEL_PRIV
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - Snmpv3User
```
public Snmpv3User()
```
    Default constructor.
  - Snmpv3User
```
protected Snmpv3User(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAccess
```
public java.lang.String getAccess()
```
    Possible values are:
    - ACCESS_ONLY
    Access permissions for polling NSX nodes over SNMP v3.
    Returns:
    
    The current value of the property.
  - setAccess
```
public void setAccess(java.lang.String access)
```
    Possible values are:
    - ACCESS_ONLY
    Access permissions for polling NSX nodes over SNMP v3.
    Parameters:
    
    access - New value for the property.
  - getAuthPassword
```
public java.lang.String getAuthPassword()
```
    Authentication password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for authentication password.
    
    Returns:
    
    The current value of the property.
  - setAuthPassword
```
public void setAuthPassword(java.lang.String authPassword)
```
    Authentication password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for authentication password.
    
    Parameters:
    
    authPassword - New value for the property.
  - getPrivPassword
```
public java.lang.String getPrivPassword()
```
    Privacy password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for privacy password.
    
    Returns:
    
    The current value of the property.
  - setPrivPassword
```
public void setPrivPassword(java.lang.String privPassword)
```
    Privacy password used for SNMP v3 communication. This field is required when adding a user. When updating a user, do not include this field in the request. If this field is present in an update request, it will be considered as a new value for privacy password.
    
    Parameters:
    
    privPassword - New value for the property.
  - getSecurityLevel
```
public java.lang.String getSecurityLevel()
```
    Possible values are:
    - SECURITY_LEVEL_PRIV
    Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.
    Returns:
    
    The current value of the property.
  - setSecurityLevel
```
public void setSecurityLevel(java.lang.String securityLevel)
```
    Possible values are:
    - SECURITY_LEVEL_PRIV
    Security level indicates whether SNMP communication involves authentication and privacy protocols for this user. Value \"AUTH_PRIV\" indicates both authentication and privacy protocols will be used for SNMP communication.
    Parameters:
    
    securityLevel - New value for the property.
  - getUserId
```
public java.lang.String getUserId()
```
    Unique SNMP v3 user id.
    
    Returns:
    
    The current value of the property.
  - setUserId
```
public void setUserId(java.lang.String userId)
```
    Unique SNMP v3 user id.
    
    Parameters:
    
    userId - 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 Snmpv3User _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 Snmpv3User _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Snmpv3User

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ACCESS_ONLY

SECURITY_LEVEL_PRIV

__dynamicStructureFields

Constructor Detail

Snmpv3User

Snmpv3User

Method Detail

getAccess

setAccess

getAuthPassword

setAuthPassword

getPrivPassword

setPrivPassword

getSecurityLevel

setSecurityLevel

getUserId

setUserId

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2