public static final class SnmpTypes.SNMPConfigReadOnly extends Object implements Serializable, StaticStructure
SNMPConfigReadOnly
class Structure that defines the SNMP configuration,
the result of get(), and never provided as input to set(). This structure
differs from SNMPConfig because it contains localized keys (as defined in
http://tools.ietf.org/html/rfc3826#section-1.2), instead of raw secret strings.
This structure can be used to configure SNMP v1, v2c, and v3. Keep this
structure in sync with vmw_snmp.py:_default_config(). Note that if a field if
left empty, it is considered unset and will be ignored. Existing array elements
below can be unset by sending an element with the string 'reset'.Modifier and Type | Class and Description |
---|---|
static class |
SnmpTypes.SNMPConfigReadOnly.Builder
Builder class for
SnmpTypes.SNMPConfigReadOnly . |
Constructor and Description |
---|
SnmpTypes.SNMPConfigReadOnly()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
String |
_getCanonicalName()
Returns the canonical name of the structure.
|
static String |
_getCanonicalTypeName()
Returns the canonical type name.
|
static com.vmware.vapi.bindings.type.StructType |
_getClassType()
WARNING: Internal API, subject to change in future versions.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(String fieldName)
Get dynamic filed value.
|
Set<String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal API, subject to change in future versions.
|
boolean |
_hasTypeNameOf(Class<? extends Structure> clazz)
Checks that the runtime type name matches the type name from the binding
class.
|
static SnmpTypes.SNMPConfigReadOnly |
_newInstance(StructValue structValue)
WARNING: Internal API, 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. |
void |
_setDynamicField(String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(Object obj) |
SnmpTypes.SNMPAuthProto |
getAuthentication()
Set the default authentication protocol.
|
List<String> |
getCommunities()
Set up to ten communities, each of no more than 64 characters long.
|
boolean |
getEnable()
Set enable to true/false
|
String |
getEngineid()
Set SNMPv3 engine ID.
|
String |
getLoglevel()
System Agent syslog logging level: debug|info|warning|error.
|
List<String> |
getNotraps()
Comma-separated list of trap OIDs (object identifiers) for traps not to be sent
by the agent.
|
String |
getPid()
Set up pid
|
long |
getPort()
Set up a UDP port which the SNMP agent uses to listen on for polling requests.
|
SnmpTypes.SNMPPrivProto |
getPrivacy()
Set the default privacy protocol.
|
List<SnmpTypes.SNMPRemoteUser> |
getRemoteusers()
Set up remote users.
|
String |
getSyscontact()
System contact string as presented in sysContact.0.
|
String |
getSyslocation()
System location string as presented in sysLocation.0.
|
List<SnmpTypes.SNMPv1TrapTarget> |
getTargets()
Set up to three targets to which to send SNMPv1 traps.
|
List<SnmpTypes.SNMPUser> |
getUsers()
Set up to five local users.
|
List<SnmpTypes.SNMPv3Target> |
getV3targets()
Set up to three SNMPv3 notification targets.
|
int |
hashCode() |
void |
setAuthentication(SnmpTypes.SNMPAuthProto authentication)
Set the default authentication protocol.
|
void |
setCommunities(List<String> communities)
Set up to ten communities, each of no more than 64 characters long.
|
void |
setEnable(boolean enable)
Set enable to true/false
|
void |
setEngineid(String engineid)
Set SNMPv3 engine ID.
|
void |
setLoglevel(String loglevel)
System Agent syslog logging level: debug|info|warning|error.
|
void |
setNotraps(List<String> notraps)
Comma-separated list of trap OIDs (object identifiers) for traps not to be sent
by the agent.
|
void |
setPid(String pid)
Set up pid
|
void |
setPort(long port)
Set up a UDP port which the SNMP agent uses to listen on for polling requests.
|
void |
setPrivacy(SnmpTypes.SNMPPrivProto privacy)
Set the default privacy protocol.
|
void |
setRemoteusers(List<SnmpTypes.SNMPRemoteUser> remoteusers)
Set up remote users.
|
void |
setSyscontact(String syscontact)
System contact string as presented in sysContact.0.
|
void |
setSyslocation(String syslocation)
System location string as presented in sysLocation.0.
|
void |
setTargets(List<SnmpTypes.SNMPv1TrapTarget> targets)
Set up to three targets to which to send SNMPv1 traps.
|
void |
setUsers(List<SnmpTypes.SNMPUser> users)
Set up to five local users.
|
void |
setV3targets(List<SnmpTypes.SNMPv3Target> v3targets)
Set up to three SNMPv3 notification targets.
|
String |
toString()
Returns a string representation of this structure.
|
public SnmpTypes.SNMPConfigReadOnly()
public SnmpTypes.SNMPAuthProto getAuthentication()
public void setAuthentication(SnmpTypes.SNMPAuthProto authentication)
authentication
- New value for the property.public List<String> getCommunities()
public void setCommunities(List<String> communities)
communities
- New value for the property.public boolean getEnable()
public void setEnable(boolean enable)
enable
- New value for the property.public String getEngineid()
public void setEngineid(String engineid)
engineid
- New value for the property.public String getLoglevel()
public void setLoglevel(String loglevel)
loglevel
- New value for the property.public List<String> getNotraps()
public void setNotraps(List<String> notraps)
notraps
- New value for the property.public long getPort()
public void setPort(long port)
port
- New value for the property.public SnmpTypes.SNMPPrivProto getPrivacy()
public void setPrivacy(SnmpTypes.SNMPPrivProto privacy)
privacy
- New value for the property.public String getSyscontact()
public void setSyscontact(String syscontact)
syscontact
- New value for the property.public String getSyslocation()
public void setSyslocation(String syslocation)
syslocation
- New value for the property.public List<SnmpTypes.SNMPv1TrapTarget> getTargets()
public void setTargets(List<SnmpTypes.SNMPv1TrapTarget> targets)
targets
- New value for the property.public List<SnmpTypes.SNMPUser> getUsers()
public void setUsers(List<SnmpTypes.SNMPUser> users)
users
- New value for the property.public List<SnmpTypes.SNMPRemoteUser> getRemoteusers()
public void setRemoteusers(List<SnmpTypes.SNMPRemoteUser> remoteusers)
remoteusers
- New value for the property.public List<SnmpTypes.SNMPv3Target> getV3targets()
public void setV3targets(List<SnmpTypes.SNMPv3Target> v3targets)
v3targets
- New value for the property.public String getPid()
public void setPid(String pid)
pid
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structurepublic void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class Object
public boolean _hasTypeNameOf(Class<? extends Structure> clazz)
Structure
_hasTypeNameOf
in interface Structure
clazz
- type of the result structure. cannot be null.public <T extends Structure> T _convertTo(Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic Set<String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static String _getCanonicalTypeName()
_getCanonicalName()
.public static SnmpTypes.SNMPConfigReadOnly _newInstance(StructValue structValue)
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.StructType
Copyright © 2016. All Rights Reserved.