com.vmware.nsx.model

Class PoolMemberGroup

java.lang.Object

com.vmware.nsx.model.PoolMemberGroup

All Implemented Interfaces:

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

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vmware.vapi.data.StructValue	__dynamicStructureFields
static java.lang.String	IP_REVISION_FILTER_IPV4
static java.lang.String	IP_REVISION_FILTER_IPV4_IPV6
static java.lang.String	IP_REVISION_FILTER_IPV6

Constructor Summary

Constructors

Modifier	Constructor and Description
	PoolMemberGroup() Default constructor.
protected	PoolMemberGroup(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 PoolMemberGroup	_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 PoolMemberGroup	_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<PoolMemberSetting>	getCustomizedMembers() The list is used to show the customized pool member settings.
ResourceReference	getGroupingObject()
java.lang.String	getIpRevisionFilter() Possible values are: IP_REVISION_FILTER_IPV4 IP_REVISION_FILTER_IPV6 IP_REVISION_FILTER_IPV4_IPV6 Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object.
java.lang.Long	getMaxIpListSize() The size is used to define the maximum number of grouping object IP address list.
java.lang.Long	getPort() If port is specified, all connections will be sent to this port.
int	hashCode()
void	setCustomizedMembers(java.util.List<PoolMemberSetting> customizedMembers) The list is used to show the customized pool member settings.
void	setGroupingObject(ResourceReference groupingObject)
void	setIpRevisionFilter(java.lang.String ipRevisionFilter) Possible values are: IP_REVISION_FILTER_IPV4 IP_REVISION_FILTER_IPV6 IP_REVISION_FILTER_IPV4_IPV6 Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object.
void	setMaxIpListSize(java.lang.Long maxIpListSize) The size is used to define the maximum number of grouping object IP address list.
void	setPort(java.lang.Long port) If port is specified, all connections will be sent to this port.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

IP_REVISION_FILTER_IPV4

public static final java.lang.String IP_REVISION_FILTER_IPV4

See Also:

Constant Field Values

IP_REVISION_FILTER_IPV6

public static final java.lang.String IP_REVISION_FILTER_IPV6

See Also:

Constant Field Values

IP_REVISION_FILTER_IPV4_IPV6

public static final java.lang.String IP_REVISION_FILTER_IPV4_IPV6

See Also:

Constant Field Values

__dynamicStructureFields

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Constructor Detail

PoolMemberGroup

public PoolMemberGroup()

Default constructor.

PoolMemberGroup

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

Method Detail

getCustomizedMembers

public java.util.List<PoolMemberSetting> getCustomizedMembers()

The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address.

Returns:

The current value of the property.

setCustomizedMembers

public void setCustomizedMembers(java.util.List<PoolMemberSetting> customizedMembers)

The list is used to show the customized pool member settings. User can only user pool member action API to update the admin state for a specific IP address.

Parameters:

customizedMembers - New value for the property.

getGroupingObject

public ResourceReference getGroupingObject()

Returns:

The current value of the property.

setGroupingObject

public void setGroupingObject(ResourceReference groupingObject)

Parameters:

groupingObject - New value for the property.

getIpRevisionFilter

public java.lang.String getIpRevisionFilter()

Possible values are:

• IP_REVISION_FILTER_IPV4
• IP_REVISION_FILTER_IPV6
• IP_REVISION_FILTER_IPV4_IPV6

Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.

Returns:

The current value of the property.

setIpRevisionFilter

public void setIpRevisionFilter(java.lang.String ipRevisionFilter)

Possible values are:

• IP_REVISION_FILTER_IPV4
• IP_REVISION_FILTER_IPV6
• IP_REVISION_FILTER_IPV4_IPV6

Ip revision filter is used to filter IPv4 or IPv6 addresses from the grouping object. If the filter is not specified, both IPv4 and IPv6 addresses would be used as server IPs. The link local and loopback addresses would be always filtered out.

Parameters:

ipRevisionFilter - New value for the property.

getMaxIpListSize

public java.lang.Long getMaxIpListSize()

The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime. format: int64

Returns:

The current value of the property.

setMaxIpListSize

public void setMaxIpListSize(java.lang.Long maxIpListSize)

The size is used to define the maximum number of grouping object IP address list. These IP addresses would be used as pool members. If the grouping object includes more than certain number of IP addresses, the redundant parts would be ignored and those IP addresses would not be treated as pool members. If the size is not specified, one member is budgeted for this dynamic pool so that the pool has at least one member even if some other dynamic pools grow beyond the capacity of load balancer service. Other members are picked according to available dynamic capacity. The unused members would be set to DISABLED so that the load balancer system itself is not overloaded during runtime. format: int64

Parameters:

maxIpListSize - New value for the property.

getPort

public java.lang.Long getPort()

If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case. format: int32

Returns:

The current value of the property.

setPort

public void setPort(java.lang.Long port)

If port is specified, all connections will be sent to this port. If unset, the same port the client connected to will be used, it could be overridden by default_pool_member_ports setting in virtual server. The port should not specified for multiple ports case. format: int32

Parameters:

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

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