ALBServer (Java SDK for NSX Global Policy API 4.1.0.2.0)

java.lang.Object
- com.vmware.nsx_global_policy.model.ALBServer

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ALBServer
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Advanced load balancer Server object

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ALBServer.Builder
Builder class for ALBServer.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ALBServer.Builder` Builder class for `ALBServer`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

ALBServer()
Default constructor.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 ALBServer`	`_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 ALBServer`	`_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`	`getAutoscalingGroupName()` Name of autoscaling group this server belongs to.
`java.lang.String`	`getAvailabilityZone()` Availability-zone of the server VM.
`java.lang.String`	`getDescription()` A description of the Server.
`java.util.List<ALBDiscoveredNetwork>`	`getDiscoveredNetworks()` (internal-use) Discovered networks providing reachability for server IP.
`java.lang.Boolean`	`getEnabled()` Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
`java.lang.String`	`getExternalOrchestrationId()` UID of server in external orchestration systems.
`java.lang.String`	`getExternalUuid()` UUID identifying VM in OpenStack and other external compute.
`java.lang.String`	`getHostname()` DNS resolvable name of the server.
`ALBIpAddr`	`getIp()`
`java.lang.Boolean`	`getIsStatic()` If statically learned.
`ALBGeoLocation`	`getLocation()`
`java.lang.String`	`getMacAddress()` MAC address of server.
`java.lang.Long`	`getPort()` Optionally specify the servers port number.
`java.lang.String`	`getPrstHdrVal()` Header value for custom header persistence.
`java.lang.Long`	`getRatio()` Ratio of selecting eligible servers in the pool.
`java.lang.Boolean`	`getResolveServerByDns()` Auto resolve server's IP using DNS name.
`java.lang.Boolean`	`getRewriteHostHeader()` Rewrite incoming Host Header to server name.
`java.lang.String`	`getServerNode()` Hostname of the node where the server VM or container resides.
`java.lang.Boolean`	`getVerifyNetwork()` Verify server belongs to a discovered network or reachable via a discovered network.
`int`	`hashCode()`
`void`	`setAutoscalingGroupName(java.lang.String autoscalingGroupName)` Name of autoscaling group this server belongs to.
`void`	`setAvailabilityZone(java.lang.String availabilityZone)` Availability-zone of the server VM.
`void`	`setDescription(java.lang.String description)` A description of the Server.
`void`	`setDiscoveredNetworks(java.util.List<ALBDiscoveredNetwork> discoveredNetworks)` (internal-use) Discovered networks providing reachability for server IP.
`void`	`setEnabled(java.lang.Boolean enabled)` Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed.
`void`	`setExternalOrchestrationId(java.lang.String externalOrchestrationId)` UID of server in external orchestration systems.
`void`	`setExternalUuid(java.lang.String externalUuid)` UUID identifying VM in OpenStack and other external compute.
`void`	`setHostname(java.lang.String hostname)` DNS resolvable name of the server.
`void`	`setIp(ALBIpAddr ip)`
`void`	`setIsStatic(java.lang.Boolean isStatic)` If statically learned.
`void`	`setLocation(ALBGeoLocation location)`
`void`	`setMacAddress(java.lang.String macAddress)` MAC address of server.
`void`	`setPort(java.lang.Long port)` Optionally specify the servers port number.
`void`	`setPrstHdrVal(java.lang.String prstHdrVal)` Header value for custom header persistence.
`void`	`setRatio(java.lang.Long ratio)` Ratio of selecting eligible servers in the pool.
`void`	`setResolveServerByDns(java.lang.Boolean resolveServerByDns)` Auto resolve server's IP using DNS name.
`void`	`setRewriteHostHeader(java.lang.Boolean rewriteHostHeader)` Rewrite incoming Host Header to server name.
`void`	`setServerNode(java.lang.String serverNode)` Hostname of the node where the server VM or container resides.
`void`	`setVerifyNetwork(java.lang.Boolean verifyNetwork)` Verify server belongs to a discovered network or reachable via a discovered network.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ALBServer
```
public ALBServer()
```
    Default constructor.
  - ALBServer
```
protected ALBServer(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAutoscalingGroupName
```
public java.lang.String getAutoscalingGroupName()
```
    Name of autoscaling group this server belongs to. Allowed in Essentials edition, Enterprise edition.
    
    Returns:
    
    The current value of the property.
  - setAutoscalingGroupName
```
public void setAutoscalingGroupName(java.lang.String autoscalingGroupName)
```
    Name of autoscaling group this server belongs to. Allowed in Essentials edition, Enterprise edition.
    
    Parameters:
    
    autoscalingGroupName - New value for the property.
  - getAvailabilityZone
```
public java.lang.String getAvailabilityZone()
```
    Availability-zone of the server VM.
    
    Returns:
    
    The current value of the property.
  - setAvailabilityZone
```
public void setAvailabilityZone(java.lang.String availabilityZone)
```
    Availability-zone of the server VM.
    
    Parameters:
    
    availabilityZone - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    A description of the Server.
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    A description of the Server.
    
    Parameters:
    
    description - New value for the property.
  - getDiscoveredNetworks
```
public java.util.List<ALBDiscoveredNetwork> getDiscoveredNetworks()
```
    (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.
    
    Returns:
    
    The current value of the property.
  - setDiscoveredNetworks
```
public void setDiscoveredNetworks(java.util.List<ALBDiscoveredNetwork> discoveredNetworks)
```
    (internal-use) Discovered networks providing reachability for server IP. This field is used internally by Avi, not editable by the user.
    
    Parameters:
    
    discoveredNetworks - New value for the property.
  - getEnabled
```
public java.lang.Boolean getEnabled()
```
    Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Returns:
    
    The current value of the property.
  - setEnabled
```
public void setEnabled(java.lang.Boolean enabled)
```
    Enable, Disable or Graceful Disable determine if new or existing connections to the server are allowed. Default value when not specified in API or module is interpreted by ALB Controller as true.
    
    Parameters:
    
    enabled - New value for the property.
  - getExternalOrchestrationId
```
public java.lang.String getExternalOrchestrationId()
```
    UID of server in external orchestration systems.
    
    Returns:
    
    The current value of the property.
  - setExternalOrchestrationId
```
public void setExternalOrchestrationId(java.lang.String externalOrchestrationId)
```
    UID of server in external orchestration systems.
    
    Parameters:
    
    externalOrchestrationId - New value for the property.
  - getExternalUuid
```
public java.lang.String getExternalUuid()
```
    UUID identifying VM in OpenStack and other external compute.
    
    Returns:
    
    The current value of the property.
  - setExternalUuid
```
public void setExternalUuid(java.lang.String externalUuid)
```
    UUID identifying VM in OpenStack and other external compute.
    
    Parameters:
    
    externalUuid - New value for the property.
  - getHostname
```
public java.lang.String getHostname()
```
    DNS resolvable name of the server. May be used in place of the IP address.
    
    Returns:
    
    The current value of the property.
  - setHostname
```
public void setHostname(java.lang.String hostname)
```
    DNS resolvable name of the server. May be used in place of the IP address.
    
    Parameters:
    
    hostname - New value for the property.
  - getIp
```
public ALBIpAddr getIp()
```
    Returns:
    
    The current value of the property.
  - setIp
```
public void setIp(ALBIpAddr ip)
```
    Parameters:
    
    ip - New value for the property.
  - getIsStatic
```
public java.lang.Boolean getIsStatic()
```
    If statically learned. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setIsStatic
```
public void setIsStatic(java.lang.Boolean isStatic)
```
    If statically learned. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    isStatic - New value for the property.
  - getLocation
```
public ALBGeoLocation getLocation()
```
    Returns:
    
    The current value of the property.
  - setLocation
```
public void setLocation(ALBGeoLocation location)
```
    Parameters:
    
    location - New value for the property.
  - getMacAddress
```
public java.lang.String getMacAddress()
```
    MAC address of server.
    
    Returns:
    
    The current value of the property.
  - setMacAddress
```
public void setMacAddress(java.lang.String macAddress)
```
    MAC address of server.
    
    Parameters:
    
    macAddress - New value for the property.
  - getPort
```
public java.lang.Long getPort()
```
    Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'. format: int64
    
    Returns:
    
    The current value of the property.
  - setPort
```
public void setPort(java.lang.Long port)
```
    Optionally specify the servers port number. This will override the pool's default server port attribute. Allowed values are 1-65535. Special values are 0- 'use backend port in pool'. format: int64
    
    Parameters:
    
    port - New value for the property.
  - getPrstHdrVal
```
public java.lang.String getPrstHdrVal()
```
    Header value for custom header persistence.
    
    Returns:
    
    The current value of the property.
  - setPrstHdrVal
```
public void setPrstHdrVal(java.lang.String prstHdrVal)
```
    Header value for custom header persistence.
    
    Parameters:
    
    prstHdrVal - New value for the property.
  - getRatio
```
public java.lang.Long getRatio()
```
    Ratio of selecting eligible servers in the pool. Allowed values are 1-20. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64
    
    Returns:
    
    The current value of the property.
  - setRatio
```
public void setRatio(java.lang.Long ratio)
```
    Ratio of selecting eligible servers in the pool. Allowed values are 1-20. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64
    
    Parameters:
    
    ratio - New value for the property.
  - getResolveServerByDns
```
public java.lang.Boolean getResolveServerByDns()
```
    Auto resolve server's IP using DNS name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setResolveServerByDns
```
public void setResolveServerByDns(java.lang.Boolean resolveServerByDns)
```
    Auto resolve server's IP using DNS name. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    resolveServerByDns - New value for the property.
  - getRewriteHostHeader
```
public java.lang.Boolean getRewriteHostHeader()
```
    Rewrite incoming Host Header to server name. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setRewriteHostHeader
```
public void setRewriteHostHeader(java.lang.Boolean rewriteHostHeader)
```
    Rewrite incoming Host Header to server name. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    rewriteHostHeader - New value for the property.
  - getServerNode
```
public java.lang.String getServerNode()
```
    Hostname of the node where the server VM or container resides.
    
    Returns:
    
    The current value of the property.
  - setServerNode
```
public void setServerNode(java.lang.String serverNode)
```
    Hostname of the node where the server VM or container resides.
    
    Parameters:
    
    serverNode - New value for the property.
  - getVerifyNetwork
```
public java.lang.Boolean getVerifyNetwork()
```
    Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Returns:
    
    The current value of the property.
  - setVerifyNetwork
```
public void setVerifyNetwork(java.lang.Boolean verifyNetwork)
```
    Verify server belongs to a discovered network or reachable via a discovered network. Verify reachable network isn't the OpenStack management network. Default value when not specified in API or module is interpreted by ALB Controller as false.
    
    Parameters:
    
    verifyNetwork - 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 ALBServer _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 ALBServer _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ALBServer

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

ALBServer

ALBServer

Method Detail

getAutoscalingGroupName

setAutoscalingGroupName

getAvailabilityZone

setAvailabilityZone

getDescription

setDescription

getDiscoveredNetworks

setDiscoveredNetworks

getEnabled

setEnabled

getExternalOrchestrationId

setExternalOrchestrationId

getExternalUuid

setExternalUuid

getHostname

setHostname

getIp

setIp

getIsStatic

setIsStatic

getLocation

setLocation

getMacAddress

setMacAddress

getPort

setPort

getPrstHdrVal

setPrstHdrVal

getRatio

setRatio

getResolveServerByDns

setResolveServerByDns

getRewriteHostHeader

setRewriteHostHeader

getServerNode

setServerNode

getVerifyNetwork

setVerifyNetwork

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2