SnmpServiceProperties (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class SnmpServiceProperties
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
SNMP Service properties

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SnmpServiceProperties.Builder
Builder class for SnmpServiceProperties.

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

Field Summary

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SnmpServiceProperties()` Default constructor.
`protected`	`SnmpServiceProperties(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 SnmpServiceProperties`	`_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 SnmpServiceProperties`	`_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.util.List<java.lang.String>`	`getCommunities()` SNMP v1, v2c community strings
`java.lang.Boolean`	`getStartOnBoot()` Start when system boots
`java.lang.Boolean`	`getV2Configured()` SNMP v2 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getV3AuthProtocol()` Possible values are: `V3AUTH_PROTOCOL_SHA1` SNMP v3 auth protocol
`java.lang.Boolean`	`getV3Configured()` SNMP v3 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getV3PrivProtocol()` Possible values are: `V3PRIV_PROTOCOL_AES128` SNMP v3 private protocol
`java.util.List<SnmpV3User>`	`getV3Users()` SNMP v3 users information
`int`	`hashCode()`
`void`	`setCommunities(java.util.List<java.lang.String> communities)` SNMP v1, v2c community strings
`void`	`setStartOnBoot(java.lang.Boolean startOnBoot)` Start when system boots
`void`	`setV2Configured(java.lang.Boolean v2Configured)` SNMP v2 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setV3AuthProtocol(java.lang.String v3AuthProtocol)` Possible values are: `V3AUTH_PROTOCOL_SHA1` SNMP v3 auth protocol
`void`	`setV3Configured(java.lang.Boolean v3Configured)` SNMP v3 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setV3PrivProtocol(java.lang.String v3PrivProtocol)` Possible values are: `V3PRIV_PROTOCOL_AES128` SNMP v3 private protocol
`void`	`setV3Users(java.util.List<SnmpV3User> v3Users)` SNMP v3 users information
`java.lang.String`	`toString()`

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

- Field Detail
  - V3AUTH_PROTOCOL_SHA1
```
public static final java.lang.String V3AUTH_PROTOCOL_SHA1
```
    See Also:
    
    Constant Field Values
  - V3PRIV_PROTOCOL_AES128
```
public static final java.lang.String V3PRIV_PROTOCOL_AES128
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - SnmpServiceProperties
```
public SnmpServiceProperties()
```
    Default constructor.
  - SnmpServiceProperties
```
protected SnmpServiceProperties(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getCommunities
```
public java.util.List<java.lang.String> getCommunities()
```
    SNMP v1, v2c community strings
    
    Returns:
    
    The current value of the property.
  - setCommunities
```
public void setCommunities(java.util.List<java.lang.String> communities)
```
    SNMP v1, v2c community strings
    
    Parameters:
    
    communities - New value for the property.
  - getStartOnBoot
```
public java.lang.Boolean getStartOnBoot()
```
    Start when system boots
    
    Returns:
    
    The current value of the property.
  - setStartOnBoot
```
public void setStartOnBoot(java.lang.Boolean startOnBoot)
```
    Start when system boots
    
    Parameters:
    
    startOnBoot - New value for the property.
  - getV2Configured
```
public java.lang.Boolean getV2Configured()
```
    SNMP v2 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setV2Configured
```
public void setV2Configured(java.lang.Boolean v2Configured)
```
    SNMP v2 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    v2Configured - New value for the property.
  - getV3AuthProtocol
```
public java.lang.String getV3AuthProtocol()
```
    Possible values are:
    - V3AUTH_PROTOCOL_SHA1
    SNMP v3 auth protocol
    Returns:
    
    The current value of the property.
  - setV3AuthProtocol
```
public void setV3AuthProtocol(java.lang.String v3AuthProtocol)
```
    Possible values are:
    - V3AUTH_PROTOCOL_SHA1
    SNMP v3 auth protocol
    Parameters:
    
    v3AuthProtocol - New value for the property.
  - getV3Configured
```
public java.lang.Boolean getV3Configured()
```
    SNMP v3 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setV3Configured
```
public void setV3Configured(java.lang.Boolean v3Configured)
```
    SNMP v3 is configured or not This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    v3Configured - New value for the property.
  - getV3PrivProtocol
```
public java.lang.String getV3PrivProtocol()
```
    Possible values are:
    - V3PRIV_PROTOCOL_AES128
    SNMP v3 private protocol
    Returns:
    
    The current value of the property.
  - setV3PrivProtocol
```
public void setV3PrivProtocol(java.lang.String v3PrivProtocol)
```
    Possible values are:
    - V3PRIV_PROTOCOL_AES128
    SNMP v3 private protocol
    Parameters:
    
    v3PrivProtocol - New value for the property.
  - getV3Users
```
public java.util.List<SnmpV3User> getV3Users()
```
    SNMP v3 users information
    
    Returns:
    
    The current value of the property.
  - setV3Users
```
public void setV3Users(java.util.List<SnmpV3User> v3Users)
```
    SNMP v3 users information
    
    Parameters:
    
    v3Users - 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 SnmpServiceProperties _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 SnmpServiceProperties _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class SnmpServiceProperties

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

V3AUTH_PROTOCOL_SHA1

V3PRIV_PROTOCOL_AES128

__dynamicStructureFields

Constructor Detail

SnmpServiceProperties

SnmpServiceProperties

Method Detail

getCommunities

setCommunities

getStartOnBoot

setStartOnBoot

getV2Configured

setV2Configured

getV3AuthProtocol

setV3AuthProtocol

getV3Configured

setV3Configured

getV3PrivProtocol

setV3PrivProtocol

getV3Users

setV3Users

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2