Package com.vmware.nsx.model
Class LbTcpMonitor
- java.lang.Object
-
- com.vmware.nsx.model.LbTcpMonitor
-
- All Implemented Interfaces:
com.vmware.vapi.bindings.StaticStructure,com.vmware.vapi.bindings.Structure,java.io.Serializable
public final class LbTcpMonitor 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 Description static classLbTcpMonitor.BuilderBuilder class forLbTcpMonitor.
-
Field Summary
Fields Modifier and Type Field Description protected com.vmware.vapi.data.StructValue__dynamicStructureFields
-
Constructor Summary
Constructors Modifier Constructor Description LbTcpMonitor()Default constructor.protectedLbTcpMonitor(com.vmware.vapi.data.StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete 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 LbTcpMonitor_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 LbTcpMonitor_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()booleanequals(java.lang.Object obj)java.lang.LonggetCreateTime()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.StringgetCreateUser()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.lang.StringgetDescription()Description of this resourcejava.lang.StringgetDisplayName()Defaults to ID if not setjava.lang.LonggetFallCount()num of consecutive checks must fail before marking it down format: int64java.lang.StringgetId()Unique identifier of this resourcejava.lang.LonggetInterval()the frequency at which the system issues the monitor check (in second) format: int64java.lang.LonggetLastModifiedTime()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.StringgetLastModifiedUser()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.util.List<ResourceLink>getLinks()The server will populate this field when returing the resource.java.lang.StringgetMonitorPort()If the monitor port is specified, it would override pool member port setting for healthcheck.java.lang.StringgetProtection()Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.java.lang.StringgetReceive()Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.java.lang.StringgetResourceType()Possible values are:LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITORLoad balancers monitor the health of backend servers to ensure traffic is not black holed.java.lang.LonggetRevision()The _revision property describes the current revision of the resource.java.lang.LonggetRiseCount()num of consecutive checks must pass before marking it up format: int64java.lang.StringgetSchema()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.SelfResourceLinkgetSelf()java.lang.StringgetSend()If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.java.lang.BooleangetSystemOwned()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.LonggetTimeout()the number of seconds the target has in which to respond to the monitor request format: int64inthashCode()voidsetCreateTime(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.voidsetCreateUser(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.voidsetDescription(java.lang.String description)Description of this resourcevoidsetDisplayName(java.lang.String displayName)Defaults to ID if not setvoidsetFallCount(java.lang.Long fallCount)num of consecutive checks must fail before marking it down format: int64voidsetId(java.lang.String id)Unique identifier of this resourcevoidsetInterval(java.lang.Long interval)the frequency at which the system issues the monitor check (in second) format: int64voidsetLastModifiedTime(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.voidsetLastModifiedUser(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.voidsetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.voidsetMonitorPort(java.lang.String monitorPort)If the monitor port is specified, it would override pool member port setting for healthcheck.voidsetProtection(java.lang.String protection)Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.voidsetReceive(java.lang.String receive)Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.voidsetResourceType(java.lang.String resourceType)Possible values are:LbMonitor.RESOURCE_TYPE_LBHTTPMONITORLbMonitor.RESOURCE_TYPE_LBHTTPSMONITORLbMonitor.RESOURCE_TYPE_LBICMPMONITORLbMonitor.RESOURCE_TYPE_LBTCPMONITORLbMonitor.RESOURCE_TYPE_LBUDPMONITORLbMonitor.RESOURCE_TYPE_LBPASSIVEMONITORLoad balancers monitor the health of backend servers to ensure traffic is not black holed.voidsetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.voidsetRiseCount(java.lang.Long riseCount)num of consecutive checks must pass before marking it up format: int64voidsetSchema(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.voidsetSelf(SelfResourceLink self)voidsetSend(java.lang.String send)If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.voidsetSystemOwned(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.voidsetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API uservoidsetTimeout(java.lang.Long timeout)the number of seconds the target has in which to respond to the monitor request format: int64java.lang.StringtoString()
-
-
-
Method Detail
-
getReceive
public java.lang.String getReceive()
Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.- Returns:
- The current value of the property.
-
setReceive
public void setReceive(java.lang.String receive)
Expected data, if specified, can be anywhere in the response and it has to be a string, regular expressions are not supported.- Parameters:
receive- New value for the property.
-
getSend
public java.lang.String getSend()
If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.- Returns:
- The current value of the property.
-
setSend
public void setSend(java.lang.String send)
If both send and receive are not specified, then just a TCP connection is established (3-way handshake) to validate server is healthy, no data is sent.- Parameters:
send- New value for the property.
-
getFallCount
public java.lang.Long getFallCount()
num of consecutive checks must fail before marking it down format: int64- Returns:
- The current value of the property.
-
setFallCount
public void setFallCount(java.lang.Long fallCount)
num of consecutive checks must fail before marking it down format: int64- Parameters:
fallCount- New value for the property.
-
getInterval
public java.lang.Long getInterval()
the frequency at which the system issues the monitor check (in second) format: int64- Returns:
- The current value of the property.
-
setInterval
public void setInterval(java.lang.Long interval)
the frequency at which the system issues the monitor check (in second) format: int64- Parameters:
interval- New value for the property.
-
getMonitorPort
public java.lang.String getMonitorPort()
If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. For ICMP monitor, monitor_port is not required. format: port-or-range- Returns:
- The current value of the property.
-
setMonitorPort
public void setMonitorPort(java.lang.String monitorPort)
If the monitor port is specified, it would override pool member port setting for healthcheck. A port range is not supported. For ICMP monitor, monitor_port is not required. format: port-or-range- Parameters:
monitorPort- New value for the property.
-
getRiseCount
public java.lang.Long getRiseCount()
num of consecutive checks must pass before marking it up format: int64- Returns:
- The current value of the property.
-
setRiseCount
public void setRiseCount(java.lang.Long riseCount)
num of consecutive checks must pass before marking it up format: int64- Parameters:
riseCount- New value for the property.
-
getTimeout
public java.lang.Long getTimeout()
the number of seconds the target has in which to respond to the monitor request format: int64- Returns:
- The current value of the property.
-
setTimeout
public void setTimeout(java.lang.Long timeout)
the number of seconds the target has in which to respond to the monitor request format: int64- Parameters:
timeout- New value for the property.
-
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()
Possible values are: Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.- Returns:
- The current value of the property.
-
setResourceType
public void setResourceType(java.lang.String resourceType)
Possible values are: Load balancers monitor the health of backend servers to ensure traffic is not black holed. There are two types of healthchecks: active and passive. Passive healthchecks depend on failures in actual client traffic (e.g. RST from server in response to a client connection) to detect that the server or the application is down. In case of active healthchecks, load balancer itself initiates new connections (or sends ICMP ping) to the servers periodically to check their health, completely independent of any data traffic. Currently, active health monitors are supported for HTTP, HTTPS, TCP, UDP and ICMP protocols.- 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.
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
- Specified by:
_getTypein interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDataValue
public com.vmware.vapi.data.StructValue _getDataValue()
- Specified by:
_getDataValuein interfacecom.vmware.vapi.bindings.Structure
-
_updateDataValue
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
-
_validate
public void _validate()
- Specified by:
_validatein interfacecom.vmware.vapi.bindings.StaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equalsin classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
- Specified by:
toStringin interfacecom.vmware.vapi.bindings.StaticStructure- Overrides:
toStringin classjava.lang.Object
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
- Specified by:
_hasTypeNameOfin interfacecom.vmware.vapi.bindings.Structure
-
_convertTo
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
- Specified by:
_convertToin interfacecom.vmware.vapi.bindings.Structure
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)- Specified by:
_setDynamicFieldin interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicField
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
- Specified by:
_getDynamicFieldin interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
- Specified by:
_getDynamicFieldNamesin 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:
StructTypeinstance representing the static bindings type for thisStructure.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
- Specified by:
_getCanonicalNamein 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 LbTcpMonitor _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 LbTcpMonitor _newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-