com.vmware.nsx.model

Class PoolMember

java.lang.Object

com.vmware.nsx.model.PoolMember

All Implemented Interfaces:

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

public final class PoolMember
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	PoolMember.Builder Builder class for PoolMember.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	ADMIN_STATE_DISABLED
static java.lang.String	ADMIN_STATE_ENABLED
static java.lang.String	ADMIN_STATE_GRACEFUL_DISABLED

Constructor Summary

Constructors

Modifier	Constructor and Description
	PoolMember() Default constructor.
protected	PoolMember(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 PoolMember	_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 PoolMember	_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	getAdminState() Possible values are: ADMIN_STATE_ENABLED ADMIN_STATE_DISABLED ADMIN_STATE_GRACEFUL_DISABLED member admin state
java.lang.Boolean	getBackupMember() Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable.
java.lang.String	getDisplayName() pool member name
java.lang.String	getIpAddress() pool member IP address format: ip
java.lang.Long	getMaxConcurrentConnections() To ensure members are not overloaded, connections to a member can be capped by the load balancer.
java.lang.String	getPort() If port is specified, all connections will be sent to this port.
java.lang.Long	getWeight() Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm.
int	hashCode()
void	setAdminState(java.lang.String adminState) Possible values are: ADMIN_STATE_ENABLED ADMIN_STATE_DISABLED ADMIN_STATE_GRACEFUL_DISABLED member admin state
void	setBackupMember(java.lang.Boolean backupMember) Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable.
void	setDisplayName(java.lang.String displayName) pool member name
void	setIpAddress(java.lang.String ipAddress) pool member IP address format: ip
void	setMaxConcurrentConnections(java.lang.Long maxConcurrentConnections) To ensure members are not overloaded, connections to a member can be capped by the load balancer.
void	setPort(java.lang.String port) If port is specified, all connections will be sent to this port.
void	setWeight(java.lang.Long weight) Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

ADMIN_STATE_ENABLED

public static final java.lang.String ADMIN_STATE_ENABLED

See Also:

Constant Field Values

ADMIN_STATE_DISABLED

public static final java.lang.String ADMIN_STATE_DISABLED

See Also:

Constant Field Values

ADMIN_STATE_GRACEFUL_DISABLED

public static final java.lang.String ADMIN_STATE_GRACEFUL_DISABLED

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

PoolMember

public PoolMember()

Default constructor.

PoolMember

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

Method Detail

getAdminState

public java.lang.String getAdminState()

Possible values are:

• ADMIN_STATE_ENABLED
• ADMIN_STATE_DISABLED
• ADMIN_STATE_GRACEFUL_DISABLED

member admin state

Returns:

The current value of the property.

setAdminState

public void setAdminState(java.lang.String adminState)

Possible values are:

• ADMIN_STATE_ENABLED
• ADMIN_STATE_DISABLED
• ADMIN_STATE_GRACEFUL_DISABLED

member admin state

Parameters:

adminState - New value for the property.

getBackupMember

public java.lang.Boolean getBackupMember()

Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).

Returns:

The current value of the property.

setBackupMember

public void setBackupMember(java.lang.Boolean backupMember)

Backup servers are typically configured with a sorry page indicating to the user that the application is currently unavailable. While the pool is active (a specified minimum number of pool members are active) BACKUP members are skipped during server selection. When the pool is inactive, incoming connections are sent to only the BACKUP member(s).

Parameters:

backupMember - New value for the property.

getDisplayName

public java.lang.String getDisplayName()

pool member name

Returns:

The current value of the property.

setDisplayName

public void setDisplayName(java.lang.String displayName)

pool member name

Parameters:

displayName - New value for the property.

getIpAddress

public java.lang.String getIpAddress()

pool member IP address format: ip

Returns:

The current value of the property.

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

pool member IP address format: ip

Parameters:

ipAddress - New value for the property.

getMaxConcurrentConnections

public java.lang.Long getMaxConcurrentConnections()

To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited. format: int64

Returns:

The current value of the property.

setMaxConcurrentConnections

public void setMaxConcurrentConnections(java.lang.Long maxConcurrentConnections)

To ensure members are not overloaded, connections to a member can be capped by the load balancer. When a member reaches this limit, it is skipped during server selection. If it is not specified, it means that connections are unlimited. format: int64

Parameters:

maxConcurrentConnections - New value for the property.

getPort

public java.lang.String getPort()

If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case. format: port-or-range

Returns:

The current value of the property.

setPort

public void setPort(java.lang.String port)

If port is specified, all connections will be sent to this port. Only single port is supported. If unset, the same port the client connected to will be used, it could be overrode by default_pool_member_port setting in virtual server. The port should not specified for port range case. format: port-or-range

Parameters:

port - New value for the property.

getWeight

public java.lang.Long getWeight()

Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms. format: int64

Returns:

The current value of the property.

setWeight

public void setWeight(java.lang.Long weight)

Pool member weight is used for WEIGHTED_ROUND_ROBIN balancing algorithm. The weight value would be ignored in other algorithms. format: int64

Parameters:

weight - 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 PoolMember _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 PoolMember _newInstance2(com.vmware.vapi.data.StructValue structValue)

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