Package com.vmware.nsx_policy.model
Class LBVirtualServer
- java.lang.Object
-
- com.vmware.nsx_policy.model.LBVirtualServer
-
- All Implemented Interfaces:
com.vmware.vapi.bindings.StaticStructure
,com.vmware.vapi.bindings.Structure
,java.io.Serializable
public final class LBVirtualServer extends java.lang.Object implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
All the types of LBVirtualServer extend from this abstract class. This is present for extensibility.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
LBVirtualServer.Builder
Builder class forLBVirtualServer
.
-
Field Summary
Fields Modifier and Type Field Description protected com.vmware.vapi.data.StructValue
__dynamicStructureFields
-
Constructor Summary
Constructors Modifier Constructor Description LBVirtualServer()
Default constructor.protected
LBVirtualServer(com.vmware.vapi.data.StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method 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 LBVirtualServer
_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 LBVirtualServer
_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)
LBAccessListControl
getAccessListControl()
java.lang.Boolean
getAccessLogEnabled()
If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file.java.lang.String
getApplicationProfilePath()
The application profile defines the application protocol characteristics.java.util.List<com.vmware.vapi.bindings.Structure>
getChildren()
Subtree for this type within policy tree containing nested elements.LBClientSslProfileBinding
getClientSslProfileBinding()
java.lang.Long
getCreateTime()
Timestamp of resource creation 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.java.lang.String
getCreateUser()
ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.util.List<java.lang.String>
getDefaultPoolMemberPorts()
Default pool member ports when member port is not defined.java.lang.String
getDescription()
Description of this resourcejava.lang.String
getDisplayName()
Defaults to ID if not setjava.lang.Boolean
getEnabled()
Flag to enable the load balancer virtual server.java.lang.String
getId()
Unique identifier of this resourcejava.lang.String
getIpAddress()
Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.java.lang.Long
getLastModifiedTime()
Timestamp of last modification 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.java.lang.String
getLastModifiedUser()
ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.lang.String
getLbPersistenceProfilePath()
Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server.java.lang.String
getLbServicePath()
virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.java.util.List<ResourceLink>
getLinks()
The server will populate this field when returing the resource.java.lang.Boolean
getLogSignificantEventOnly()
The property log_significant_event_only can take effect only when access_log_enabled is true.java.lang.Boolean
getMarkedForDelete()
Intent objects are not directly deleted from the system when a delete is invoked on them.java.lang.Long
getMaxConcurrentConnections()
Deprecated.java.lang.Long
getMaxNewConnectionRate()
Deprecated.java.lang.String
getOriginSiteId()
This is a UUID generated by the system for knowing which site owns an object.java.lang.Boolean
getOverridden()
Global intent objects cannot be modified by the user.java.lang.String
getOwnerId()
This is a UUID generated by the system for knowing who owns this object.java.lang.String
getParentPath()
Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.lang.String
getPath()
Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.lang.String
getPoolPath()
The server pool(LBPool) contains backend servers.java.util.List<java.lang.String>
getPorts()
Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\".java.lang.String
getProtection()
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.java.lang.String
getRealizationId()
This is a UUID generated by the system for realizing the entity object.java.lang.String
getRelativePath()
Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.lang.String
getRemotePath()
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.java.lang.String
getResourceType()
The type of this resource.java.lang.Long
getRevision()
The _revision property describes the current revision of the resource.java.util.List<LBRule>
getRules()
Deprecated.java.lang.String
getSchema()
Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.SelfResourceLink
getSelf()
LBServerSslProfileBinding
getServerSslProfileBinding()
java.lang.String
getSorryPoolPath()
Deprecated.java.lang.Boolean
getSystemOwned()
Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.java.util.List<Tag>
getTags()
Opaque identifiers meaningful to the API userjava.lang.String
getUniqueId()
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.int
hashCode()
void
setAccessListControl(LBAccessListControl accessListControl)
void
setAccessLogEnabled(java.lang.Boolean accessLogEnabled)
If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file.void
setApplicationProfilePath(java.lang.String applicationProfilePath)
The application profile defines the application protocol characteristics.void
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.void
setClientSslProfileBinding(LBClientSslProfileBinding clientSslProfileBinding)
void
setCreateTime(java.lang.Long createTime)
Timestamp of resource creation 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.void
setCreateUser(java.lang.String createUser)
ID of the user who created this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setDefaultPoolMemberPorts(java.util.List<java.lang.String> defaultPoolMemberPorts)
Default pool member ports when member port is not defined.void
setDescription(java.lang.String description)
Description of this resourcevoid
setDisplayName(java.lang.String displayName)
Defaults to ID if not setvoid
setEnabled(java.lang.Boolean enabled)
Flag to enable the load balancer virtual server.void
setId(java.lang.String id)
Unique identifier of this resourcevoid
setIpAddress(java.lang.String ipAddress)
Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers.void
setLastModifiedTime(java.lang.Long lastModifiedTime)
Timestamp of last modification 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.void
setLastModifiedUser(java.lang.String lastModifiedUser)
ID of the user who last modified this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setLbPersistenceProfilePath(java.lang.String lbPersistenceProfilePath)
Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server.void
setLbServicePath(java.lang.String lbServicePath)
virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.void
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.void
setLogSignificantEventOnly(java.lang.Boolean logSignificantEventOnly)
The property log_significant_event_only can take effect only when access_log_enabled is true.void
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.void
setMaxConcurrentConnections(java.lang.Long maxConcurrentConnections)
Deprecated.void
setMaxNewConnectionRate(java.lang.Long maxNewConnectionRate)
Deprecated.void
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.void
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.void
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.void
setParentPath(java.lang.String parentPath)
Path of its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setPath(java.lang.String path)
Absolute path of this object This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setPoolPath(java.lang.String poolPath)
The server pool(LBPool) contains backend servers.void
setPorts(java.util.List<java.lang.String> ports)
Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\".void
setProtection(java.lang.String protection)
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.void
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.void
setRelativePath(java.lang.String relativePath)
Path relative from its parent This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setRemotePath(java.lang.String remotePath)
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.void
setResourceType(java.lang.String resourceType)
The type of this resource.void
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.void
setRules(java.util.List<LBRule> rules)
Deprecated.void
setSchema(java.lang.String schema)
Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setSelf(SelfResourceLink self)
void
setServerSslProfileBinding(LBServerSslProfileBinding serverSslProfileBinding)
void
setSorryPoolPath(java.lang.String sorryPoolPath)
Deprecated.void
setSystemOwned(java.lang.Boolean systemOwned)
Indicates system owned resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.void
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API uservoid
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.java.lang.String
toString()
-
-
-
Method Detail
-
getLinks
public java.util.List<ResourceLink> getLinks()
The server will populate this field when returing the resource. Ignored on PUT and POST. 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.
-
setLinks
public void setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource. Ignored on PUT and POST. 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:
links
- New value for the property.
-
getSchema
public java.lang.String getSchema()
Schema for this resource 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.
-
setSchema
public void setSchema(java.lang.String schema)
Schema for this resource 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:
schema
- New value for the property.
-
getSelf
public SelfResourceLink getSelf()
- Returns:
- The current value of the property.
-
setSelf
public void setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
getRevision
public java.lang.Long getRevision()
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32- Returns:
- The current value of the property.
-
setRevision
public void setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. format: int32- Parameters:
revision
- New value for the property.
-
getCreateTime
public java.lang.Long getCreateTime()
Timestamp of resource creation 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.
-
setCreateTime
public void setCreateTime(java.lang.Long createTime)
Timestamp of resource creation 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:
createTime
- New value for the property.
-
getCreateUser
public java.lang.String getCreateUser()
ID of the user who created this resource 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.
-
setCreateUser
public void setCreateUser(java.lang.String createUser)
ID of the user who created this resource 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:
createUser
- New value for the property.
-
getLastModifiedTime
public java.lang.Long getLastModifiedTime()
Timestamp of last modification 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.
-
setLastModifiedTime
public void setLastModifiedTime(java.lang.Long lastModifiedTime)
Timestamp of last modification 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:
lastModifiedTime
- New value for the property.
-
getLastModifiedUser
public java.lang.String getLastModifiedUser()
ID of the user who last modified this resource 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.
-
setLastModifiedUser
public void setLastModifiedUser(java.lang.String lastModifiedUser)
ID of the user who last modified this resource 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:
lastModifiedUser
- New value for the property.
-
getProtection
public java.lang.String getProtection()
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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.
-
setProtection
public void setProtection(java.lang.String protection)
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity. 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:
protection
- New value for the property.
-
getSystemOwned
public java.lang.Boolean getSystemOwned()
Indicates system owned resource 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.
-
setSystemOwned
public void setSystemOwned(java.lang.Boolean systemOwned)
Indicates system owned resource 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:
systemOwned
- New value for the property.
-
getDescription
public java.lang.String getDescription()
Description of this resource- Returns:
- The current value of the property.
-
setDescription
public void setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
getDisplayName
public java.lang.String getDisplayName()
Defaults to ID if not set- Returns:
- The current value of the property.
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
getId
public java.lang.String getId()
Unique identifier of this resource- Returns:
- The current value of the property.
-
setId
public void setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
getResourceType
public java.lang.String getResourceType()
The type of this resource.- Returns:
- The current value of the property.
-
setResourceType
public void setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType
- New value for the property.
-
getTags
public java.util.List<Tag> getTags()
Opaque identifiers meaningful to the API user- Returns:
- The current value of the property.
-
setTags
public void setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
getOriginSiteId
public java.lang.String getOriginSiteId()
This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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.
-
setOriginSiteId
public void setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object. This is used in NSX+. 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:
originSiteId
- New value for the property.
-
getOwnerId
public java.lang.String getOwnerId()
This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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.
-
setOwnerId
public void setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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:
ownerId
- New value for the property.
-
getParentPath
public java.lang.String getParentPath()
Path of its parent 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.
-
setParentPath
public void setParentPath(java.lang.String parentPath)
Path of its parent 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:
parentPath
- New value for the property.
-
getPath
public java.lang.String getPath()
Absolute path of this object 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.
-
setPath
public void setPath(java.lang.String path)
Absolute path of this object 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:
path
- New value for the property.
-
getRealizationId
public java.lang.String getRealizationId()
This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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.
-
setRealizationId
public void setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object. In most cases this should be same as 'unique_id' of the entity. However, in some cases this can be different because of entities have migrated their unique identifier to NSX Policy intent objects later in the timeline and did not use unique_id for realization. Realization id is helpful for users to debug data path to correlate the configuration with corresponding intent. 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:
realizationId
- New value for the property.
-
getRelativePath
public java.lang.String getRelativePath()
Path relative from its parent 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.
-
setRelativePath
public void setRelativePath(java.lang.String relativePath)
Path relative from its parent 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:
relativePath
- New value for the property.
-
getRemotePath
public java.lang.String getRemotePath()
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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.
-
setRemotePath
public void setRemotePath(java.lang.String remotePath)
This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers. 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:
remotePath
- New value for the property.
-
getUniqueId
public java.lang.String getUniqueId()
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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.
-
setUniqueId
public void setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment. For entities that are stretched across multiple sites, the same ID will be used on all the stretched sites. 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:
uniqueId
- New value for the property.
-
getChildren
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Returns:
- The current value of the property.
When clients pass a value of this class as a parameter, the property must
contain all the properties defined in
ChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
setChildren
public void setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Parameters:
children
- New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined inChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
getMarkedForDelete
public java.lang.Boolean getMarkedForDelete()
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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.
-
setMarkedForDelete
public void setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them. They are marked for deletion and only when all the realized entities for that intent object gets deleted, the intent object is deleted. Objects that are marked for deletion are not returned in GET call. One can use the search API to get these objects. 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:
markedForDelete
- New value for the property.
-
getOverridden
public java.lang.Boolean getOverridden()
Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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.
-
setOverridden
public void setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user. However, certain global intent objects can be overridden locally by use of this property. In such cases, the overridden local values take precedence over the globally defined values for the properties. 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:
overridden
- New value for the property.
-
getAccessListControl
public LBAccessListControl getAccessListControl()
- Returns:
- The current value of the property.
-
setAccessListControl
public void setAccessListControl(LBAccessListControl accessListControl)
- Parameters:
accessListControl
- New value for the property.
-
getAccessLogEnabled
public java.lang.Boolean getAccessLogEnabled()
If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file. Both successful returns information responses(1xx), successful responses(2xx), redirection messages(3xx) and unsuccessful requests, backend server returns 4xx or 5xx, are logged to access log, if enabled. All L4 virtual server connections are also logged to the access log if enabled. The non-significant events such as successful requests are not logged if log_significant_event_only is set to true.- Returns:
- The current value of the property.
-
setAccessLogEnabled
public void setAccessLogEnabled(java.lang.Boolean accessLogEnabled)
If access log is enabled, all HTTP requests sent to L7 virtual server are logged to the access log file. Both successful returns information responses(1xx), successful responses(2xx), redirection messages(3xx) and unsuccessful requests, backend server returns 4xx or 5xx, are logged to access log, if enabled. All L4 virtual server connections are also logged to the access log if enabled. The non-significant events such as successful requests are not logged if log_significant_event_only is set to true.- Parameters:
accessLogEnabled
- New value for the property.
-
getApplicationProfilePath
public java.lang.String getApplicationProfilePath()
The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.- Returns:
- The current value of the property.
-
setApplicationProfilePath
public void setApplicationProfilePath(java.lang.String applicationProfilePath)
The application profile defines the application protocol characteristics. It is used to influence how load balancing is performed. Currently, LBFastTCPProfile, LBFastUDPProfile and LBHttpProfile, etc are supported.- Parameters:
applicationProfilePath
- New value for the property.
-
getClientSslProfileBinding
public LBClientSslProfileBinding getClientSslProfileBinding()
- Returns:
- The current value of the property.
-
setClientSslProfileBinding
public void setClientSslProfileBinding(LBClientSslProfileBinding clientSslProfileBinding)
- Parameters:
clientSslProfileBinding
- New value for the property.
-
getDefaultPoolMemberPorts
public java.util.List<java.lang.String> getDefaultPoolMemberPorts()
Default pool member ports when member port is not defined. format: port-or-range- Returns:
- The current value of the property.
-
setDefaultPoolMemberPorts
public void setDefaultPoolMemberPorts(java.util.List<java.lang.String> defaultPoolMemberPorts)
Default pool member ports when member port is not defined. format: port-or-range- Parameters:
defaultPoolMemberPorts
- New value for the property.
-
getEnabled
public java.lang.Boolean getEnabled()
Flag to enable the load balancer virtual server.- Returns:
- The current value of the property.
-
setEnabled
public void setEnabled(java.lang.Boolean enabled)
Flag to enable the load balancer virtual server.- Parameters:
enabled
- New value for the property.
-
getIpAddress
public java.lang.String getIpAddress()
Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip- Returns:
- The current value of the property.
-
setIpAddress
public void setIpAddress(java.lang.String ipAddress)
Configures the IP address of the LBVirtualServer where it receives all client connections and distributes them among the backend servers. format: ip- Parameters:
ipAddress
- New value for the property.
-
getLbPersistenceProfilePath
public java.lang.String getLbPersistenceProfilePath()
Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is deactivated by default.- Returns:
- The current value of the property.
-
setLbPersistenceProfilePath
public void setLbPersistenceProfilePath(java.lang.String lbPersistenceProfilePath)
Path to optional object that enables persistence on a virtual server allowing related client connections to be sent to the same backend server. Persistence is deactivated by default.- Parameters:
lbPersistenceProfilePath
- New value for the property.
-
getLbServicePath
public java.lang.String getLbServicePath()
virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.- Returns:
- The current value of the property.
-
setLbServicePath
public void setLbServicePath(java.lang.String lbServicePath)
virtual servers can be associated to LBService(which is similar to physical/virtual load balancer), LB virtual servers, pools and other entities could be defined independently, the LBService identifier list here would be used to maintain the relationship of LBService and other LB entities.- Parameters:
lbServicePath
- New value for the property.
-
getLogSignificantEventOnly
public java.lang.Boolean getLogSignificantEventOnly()
The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).- Returns:
- The current value of the property.
-
setLogSignificantEventOnly
public void setLogSignificantEventOnly(java.lang.Boolean logSignificantEventOnly)
The property log_significant_event_only can take effect only when access_log_enabled is true. If log_significant_event_only is true, significant events are logged in access log. For L4 virtual server, significant event means unsuccessful(error or dropped) TCP/UDP connections. For L7 virtual server, significant event means unsuccessful connections or HTTP/HTTPS requests which have error response code(e.g. 4xx, 5xx).- Parameters:
logSignificantEventOnly
- New value for the property.
-
getMaxConcurrentConnections
@Deprecated public java.lang.Long getMaxConcurrentConnections()
Deprecated.To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited. The property is deprecated as NSX-T Load Balancer is deprecated. format: int64- Returns:
- The current value of the property.
-
setMaxConcurrentConnections
@Deprecated public void setMaxConcurrentConnections(java.lang.Long maxConcurrentConnections)
Deprecated.To ensure one virtual server does not over consume resources, affecting other applications hosted on the same LBS, connections to a virtual server can be capped. If it is not specified, it means that connections are unlimited. The property is deprecated as NSX-T Load Balancer is deprecated. format: int64- Parameters:
maxConcurrentConnections
- New value for the property.
-
getMaxNewConnectionRate
@Deprecated public java.lang.Long getMaxNewConnectionRate()
Deprecated.To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited. The property is deprecated as NSX-T Load Balancer is deprecated. format: int64- Returns:
- The current value of the property.
-
setMaxNewConnectionRate
@Deprecated public void setMaxNewConnectionRate(java.lang.Long maxNewConnectionRate)
Deprecated.To ensure one virtual server does not over consume resources, connections to a member can be rate limited. If it is not specified, it means that connection rate is unlimited. The property is deprecated as NSX-T Load Balancer is deprecated. format: int64- Parameters:
maxNewConnectionRate
- New value for the property.
-
getPoolPath
public java.lang.String getPoolPath()
The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.- Returns:
- The current value of the property.
-
setPoolPath
public void setPoolPath(java.lang.String poolPath)
The server pool(LBPool) contains backend servers. Server pool consists of one or more servers, also referred to as pool members, that are similarly configured and are running the same application.- Parameters:
poolPath
- New value for the property.
-
getPorts
public java.util.List<java.lang.String> getPorts()
Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range. format: port-or-range- Returns:
- The current value of the property.
-
setPorts
public void setPorts(java.util.List<java.lang.String> ports)
Ports contains a list of at least one port or port range such as \"80\", \"1234-1236\". Each port element in the list should be a single port or a single port range. format: port-or-range- Parameters:
ports
- New value for the property.
-
getRules
@Deprecated public java.util.List<LBRule> getRules()
Deprecated.Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile. The property is deprecated as NSX-T Load Balancer is deprecated.- Returns:
- The current value of the property.
-
setRules
@Deprecated public void setRules(java.util.List<LBRule> rules)
Deprecated.Load balancer rules allow customization of load balancing behavior using match/action rules. Currently, load balancer rules are supported for only layer 7 virtual servers with LBHttpProfile. The property is deprecated as NSX-T Load Balancer is deprecated.- Parameters:
rules
- New value for the property.
-
getServerSslProfileBinding
public LBServerSslProfileBinding getServerSslProfileBinding()
- Returns:
- The current value of the property.
-
setServerSslProfileBinding
public void setServerSslProfileBinding(LBServerSslProfileBinding serverSslProfileBinding)
- Parameters:
serverSslProfileBinding
- New value for the property.
-
getSorryPoolPath
@Deprecated public java.lang.String getSorryPoolPath()
Deprecated.When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool. The property is deprecated as NSX-T Load Balancer is deprecated.- Returns:
- The current value of the property.
-
setSorryPoolPath
@Deprecated public void setSorryPoolPath(java.lang.String sorryPoolPath)
Deprecated.When load balancer can not select a backend server to serve the request in default pool or pool in rules, the request would be served by sorry server pool. The property is deprecated as NSX-T Load Balancer is deprecated.- Parameters:
sorryPoolPath
- New value for the property.
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
- Specified by:
_getType
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDataValue
public com.vmware.vapi.data.StructValue _getDataValue()
- Specified by:
_getDataValue
in interfacecom.vmware.vapi.bindings.Structure
-
_updateDataValue
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
-
_validate
public void _validate()
- Specified by:
_validate
in interfacecom.vmware.vapi.bindings.StaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Specified by:
toString
in interfacecom.vmware.vapi.bindings.StaticStructure
- Overrides:
toString
in classjava.lang.Object
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
- Specified by:
_hasTypeNameOf
in interfacecom.vmware.vapi.bindings.Structure
-
_convertTo
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
- Specified by:
_convertTo
in interfacecom.vmware.vapi.bindings.Structure
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
- Specified by:
_setDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicField
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
- Specified by:
_getDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
- Specified by:
_getDynamicFieldNames
in interfacecom.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 thisStructure
.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
- Specified by:
_getCanonicalName
in interfacecom.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 LBVirtualServer _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 LBVirtualServer _newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-