com.vmware.nsx_policy.model

Class LBPoolStatus

java.lang.Object

com.vmware.nsx_policy.model.LBPoolStatus

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class LBPoolStatus
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LBPoolStatus.Builder Builder class for LBPoolStatus.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	_TYPE_IDENTIFIER Identifier denoting this class, when it is used in polymorphic context.
static java.lang.String	STATUS_DETACHED
static java.lang.String	STATUS_DOWN
static java.lang.String	STATUS_PARTIALLY_UP
static java.lang.String	STATUS_PRIMARY_DOWN
static java.lang.String	STATUS_UNKNOWN
static java.lang.String	STATUS_UP

Constructor Summary

Constructors

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

Method Summary

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 LBPoolStatus	_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 LBPoolStatus	_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)
PolicyRuntimeAlarm	getAlarm()
java.lang.String	getEnforcementPointPath() Policy Path referencing the enforcement point where the info is fetched.
java.lang.Long	getLastUpdateTimestamp() Timestamp when the data was last updated.
java.util.List<LBPoolMemberStatus>	getMembers() Status of load balancer pool members.
java.lang.String	getPoolPath() Load balancer pool object path.
java.lang.String	getResourceType() The value of this property is automatically populated to "LBPoolStatus".
java.lang.String	getStatus() Possible values are: STATUS_UP STATUS_PARTIALLY_UP STATUS_PRIMARY_DOWN STATUS_DOWN STATUS_DETACHED STATUS_UNKNOWN UP means that all primary members are in UP status.
int	hashCode()
void	setAlarm(PolicyRuntimeAlarm alarm)
void	setEnforcementPointPath(java.lang.String enforcementPointPath) Policy Path referencing the enforcement point where the info is fetched.
void	setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp) Timestamp when the data was last updated.
void	setMembers(java.util.List<LBPoolMemberStatus> members) Status of load balancer pool members.
void	setPoolPath(java.lang.String poolPath) Load balancer pool object path.
void	setStatus(java.lang.String status) Possible values are: STATUS_UP STATUS_PARTIALLY_UP STATUS_PRIMARY_DOWN STATUS_DOWN STATUS_DETACHED STATUS_UNKNOWN UP means that all primary members are in UP status.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

_TYPE_IDENTIFIER

public static final java.lang.String _TYPE_IDENTIFIER

Identifier denoting this class, when it is used in polymorphic context.

This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.

See Also:

Constant Field Values

STATUS_UP

public static final java.lang.String STATUS_UP

See Also:

Constant Field Values

STATUS_PARTIALLY_UP

public static final java.lang.String STATUS_PARTIALLY_UP

See Also:

Constant Field Values

STATUS_PRIMARY_DOWN

public static final java.lang.String STATUS_PRIMARY_DOWN

See Also:

Constant Field Values

STATUS_DOWN

public static final java.lang.String STATUS_DOWN

See Also:

Constant Field Values

STATUS_DETACHED

public static final java.lang.String STATUS_DETACHED

See Also:

Constant Field Values

STATUS_UNKNOWN

public static final java.lang.String STATUS_UNKNOWN

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

LBPoolStatus

public LBPoolStatus()

Default constructor.

LBPoolStatus

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

Method Detail

getLastUpdateTimestamp

public java.lang.Long getLastUpdateTimestamp()

Timestamp when the data was last updated. format: int64 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.

setLastUpdateTimestamp

public void setLastUpdateTimestamp(java.lang.Long lastUpdateTimestamp)

Timestamp when the data was last updated. format: int64 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:

lastUpdateTimestamp - New value for the property.

getMembers

public java.util.List<LBPoolMemberStatus> getMembers()

Status of load balancer pool members. 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.

setMembers

public void setMembers(java.util.List<LBPoolMemberStatus> members)

Status of load balancer pool members. 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:

members - New value for the property.

getPoolPath

public java.lang.String getPoolPath()

Load balancer pool object path. 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.

setPoolPath

public void setPoolPath(java.lang.String poolPath)

Load balancer pool object path. 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:

poolPath - New value for the property.

getStatus

public java.lang.String getStatus()

Possible values are:

• STATUS_UP
• STATUS_PARTIALLY_UP
• STATUS_PRIMARY_DOWN
• STATUS_DOWN
• STATUS_DETACHED
• STATUS_UNKNOWN

UP means that all primary members are in UP status. PARTIALLY_UP means that some(not all) primary members are in UP status, the number of these active members is larger or equal to certain number(min_active_members) which is defined in LBPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members are in UP status but backup members are in UP status, connections to this pool would be dispatched to backup members. DOWN means that all primary and backup members are DOWN. DETACHED means that the pool is not bound to any virtual server. UNKOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working). 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.

setStatus

public void setStatus(java.lang.String status)

Possible values are:

• STATUS_UP
• STATUS_PARTIALLY_UP
• STATUS_PRIMARY_DOWN
• STATUS_DOWN
• STATUS_DETACHED
• STATUS_UNKNOWN

UP means that all primary members are in UP status. PARTIALLY_UP means that some(not all) primary members are in UP status, the number of these active members is larger or equal to certain number(min_active_members) which is defined in LBPool. When there are no backup members which are in the UP status, the number(min_active_members) would be ignored. PRIMARY_DOWN means that less than certain(min_active_members) primary members are in UP status but backup members are in UP status, connections to this pool would be dispatched to backup members. DOWN means that all primary and backup members are DOWN. DETACHED means that the pool is not bound to any virtual server. UNKOWN means that no status reported from transport-nodes. The associated load balancer service may be working(or not working). 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:

status - New value for the property.

getAlarm

public PolicyRuntimeAlarm getAlarm()

Returns:

The current value of the property.

setAlarm

public void setAlarm(PolicyRuntimeAlarm alarm)

Parameters:

alarm - New value for the property.

getEnforcementPointPath

public java.lang.String getEnforcementPointPath()

Policy Path referencing the enforcement point where the info is fetched. 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.

setEnforcementPointPath

public void setEnforcementPointPath(java.lang.String enforcementPointPath)

Policy Path referencing the enforcement point where the info is fetched. 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:

enforcementPointPath - New value for the property.

getResourceType

public java.lang.String getResourceType()

The value of this property is automatically populated to "LBPoolStatus".

Returns:

The current value of 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 LBPoolStatus _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 LBPoolStatus _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.