public final class Site extends java.lang.Object implements java.io.Serializable, StaticStructure
Modifier and Type | Class and Description |
---|---|
static class |
Site.Builder
Builder class for
Site . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
static java.lang.String |
TUNNEL_STATUS_CONNECTED |
static java.lang.String |
TUNNEL_STATUS_DISCONNECTED |
static java.lang.String |
TUNNEL_STATUS_UNKNOWN |
Modifier | Constructor and Description |
---|---|
|
Site()
Default constructor.
|
protected |
Site(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
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.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which
have getters/setters).
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static Site |
_newInstance(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 Site |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDroppedRxPackets()
Number of received packets dropped.
|
java.lang.String |
getDroppedTxPackets()
Number of transmitted packets dropped.
|
java.lang.String |
getEstablishedDate()
Date tunnel was established.
|
java.lang.String |
getFailureMessage()
failure message.
|
java.lang.String |
getName()
Unique name for the site getting configured.
|
java.lang.String |
getPassword()
Site password.
|
java.lang.Long |
getRxBytesOnLocalSubnet()
Bytes received on local network.
|
java.lang.Boolean |
getSecureTraffic()
Enable/disable encription.
|
java.lang.String |
getTunnelStatus()
Possible values are:
TUNNEL_STATUS_CONNECTED TUNNEL_STATUS_DISCONNECTED TUNNEL_STATUS_UNKNOWN Site tunnel status. |
java.lang.Long |
getTxBytesFromLocalSubnet()
Bytes transmitted from local subnet.
|
java.lang.String |
getUserId()
Site user id.
|
int |
hashCode() |
void |
setDroppedRxPackets(java.lang.String droppedRxPackets)
Number of received packets dropped.
|
void |
setDroppedTxPackets(java.lang.String droppedTxPackets)
Number of transmitted packets dropped.
|
void |
setEstablishedDate(java.lang.String establishedDate)
Date tunnel was established.
|
void |
setFailureMessage(java.lang.String failureMessage)
failure message.
|
void |
setName(java.lang.String name)
Unique name for the site getting configured.
|
void |
setPassword(java.lang.String password)
Site password.
|
void |
setRxBytesOnLocalSubnet(java.lang.Long rxBytesOnLocalSubnet)
Bytes received on local network.
|
void |
setSecureTraffic(java.lang.Boolean secureTraffic)
Enable/disable encription.
|
void |
setTunnelStatus(java.lang.String tunnelStatus)
Possible values are:
TUNNEL_STATUS_CONNECTED TUNNEL_STATUS_DISCONNECTED TUNNEL_STATUS_UNKNOWN Site tunnel status. |
void |
setTxBytesFromLocalSubnet(java.lang.Long txBytesFromLocalSubnet)
Bytes transmitted from local subnet.
|
void |
setUserId(java.lang.String userId)
Site user id.
|
java.lang.String |
toString()
Returns a string representation of this structure.
|
public static final java.lang.String TUNNEL_STATUS_CONNECTED
public static final java.lang.String TUNNEL_STATUS_DISCONNECTED
public static final java.lang.String TUNNEL_STATUS_UNKNOWN
protected StructValue __dynamicStructureFields
public Site()
protected Site(StructValue __dynamicStructureFields)
public java.lang.String getPassword()
public void setPassword(java.lang.String password)
password
- New value for the property.public java.lang.String getUserId()
public void setUserId(java.lang.String userId)
userId
- New value for the property.public java.lang.String getName()
public void setName(java.lang.String name)
name
- New value for the property.public java.lang.Long getRxBytesOnLocalSubnet()
public void setRxBytesOnLocalSubnet(java.lang.Long rxBytesOnLocalSubnet)
rxBytesOnLocalSubnet
- New value for the property.public java.lang.Boolean getSecureTraffic()
public void setSecureTraffic(java.lang.Boolean secureTraffic)
secureTraffic
- New value for the property.public java.lang.String getEstablishedDate()
public void setEstablishedDate(java.lang.String establishedDate)
establishedDate
- New value for the property.public java.lang.String getFailureMessage()
public void setFailureMessage(java.lang.String failureMessage)
failureMessage
- New value for the property.public java.lang.String getDroppedTxPackets()
public void setDroppedTxPackets(java.lang.String droppedTxPackets)
droppedTxPackets
- New value for the property.public java.lang.String getDroppedRxPackets()
public void setDroppedRxPackets(java.lang.String droppedRxPackets)
droppedRxPackets
- New value for the property.public java.lang.String getTunnelStatus()
public void setTunnelStatus(java.lang.String tunnelStatus)
tunnelStatus
- New value for the property.public java.lang.Long getTxBytesFromLocalSubnet()
public void setTxBytesFromLocalSubnet(java.lang.Long txBytesFromLocalSubnet)
txBytesFromLocalSubnet
- 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 structureprotected void _updateDataValue(StructValue structValue)
public 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 boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.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 java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.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(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.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 java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static Site _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
public static Site _newInstance2(StructValue structValue)