com.vmware.nsx_policy.model

Class LBHttpProfile.Builder

java.lang.Object

com.vmware.nsx_policy.model.LBHttpProfile.Builder

Enclosing class:

LBHttpProfile

public static final class LBHttpProfile.Builder
extends java.lang.Object

Builder class for LBHttpProfile.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor with parameters for the required properties of LBHttpProfile.

Method Summary

Modifier and Type	Method and Description
LBHttpProfile	build()
LBHttpProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setDescription(java.lang.String description) Description of this resource
LBHttpProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LBHttpProfile.Builder	setHttpRedirectTo(java.lang.String httpRedirectTo) If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL.
LBHttpProfile.Builder	setHttpRedirectToHttps(java.lang.Boolean httpRedirectToHttps) Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL.
LBHttpProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
LBHttpProfile.Builder	setIdleTimeout(java.lang.Long idleTimeout) It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LBHttpProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LBHttpProfile.Builder	setNtlm(java.lang.Boolean ntlm) NTLM is an authentication protocol that can be used over HTTP.
LBHttpProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LBHttpProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LBHttpProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setRequestBodySize(java.lang.Long requestBodySize) If it is not specified, it means that request body size is unlimited.
LBHttpProfile.Builder	setRequestHeaderSize(java.lang.Long requestHeaderSize) A request with header equal to or below this size is guaranteed to be processed.
LBHttpProfile.Builder	setResponseBuffering(java.lang.Boolean responseBuffering) When buffering is deactivated, the response is passed to a client synchronously, immediately as it is received.
LBHttpProfile.Builder	setResponseHeaderSize(java.lang.Long responseHeaderSize) A response with header larger than response_header_size will be dropped.
LBHttpProfile.Builder	setResponseTimeout(java.lang.Long responseTimeout) If server doesn’t send any packet within this time, the connection is closed.
LBHttpProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setSelf(SelfResourceLink self)
LBHttpProfile.Builder	setServerKeepAlive(java.lang.Boolean serverKeepAlive) If server_keep_alive is true, it means the backend connection will keep alive for the client connection.
LBHttpProfile.Builder	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.
LBHttpProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LBHttpProfile.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
LBHttpProfile.Builder	setxForwardedFor(java.lang.String xForwardedFor) Possible values are: LBHttpProfile.X_FORWARDED_FOR_INSERT LBHttpProfile.X_FORWARDED_FOR_REPLACE When X-Forwareded-For is configured, X-Forwarded-Proto and X-Forwarded-Port information is added automatically.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Constructor with parameters for the required properties of LBHttpProfile.

Method Detail

setHttpRedirectTo

public LBHttpProfile.Builder setHttpRedirectTo(java.lang.String httpRedirectTo)

If a website is temporarily down or has moved, incoming requests for that virtual server can be temporarily redirected to a URL.

Parameters:

httpRedirectTo - New value for the property.

setHttpRedirectToHttps

public LBHttpProfile.Builder setHttpRedirectToHttps(java.lang.Boolean httpRedirectToHttps)

Certain secure applications may want to force communication over SSL, but instead of rejecting non-SSL connections, they may choose to redirect the client automatically to use SSL.

Parameters:

httpRedirectToHttps - New value for the property.

setIdleTimeout

public LBHttpProfile.Builder setIdleTimeout(java.lang.Long idleTimeout)

It is used to specify the HTTP application idle timeout, it means that how long the load balancer will keep the connection idle to wait for the client to send the next keep-alive request. It is not a TCP socket setting. format: int64

Parameters:

idleTimeout - New value for the property.

setNtlm

public LBHttpProfile.Builder setNtlm(java.lang.Boolean ntlm)

NTLM is an authentication protocol that can be used over HTTP. If the flag is set to true, LB will use NTLM challenge/response methodology. This property is deprecated. Please use the property server_keep_alive in order to keep the backend server connection alive for the client connection. When create a new profile, if both ntlm and server_keep_alive are set as different values, ERROR will be reported. When update an existing profile, if either ntlm or server_keep_alive value is changed, both of them are updated with the changed value.

Parameters:

ntlm - New value for the property.

setRequestBodySize

public LBHttpProfile.Builder setRequestBodySize(java.lang.Long requestBodySize)

If it is not specified, it means that request body size is unlimited. format: int64

Parameters:

requestBodySize - New value for the property.

setRequestHeaderSize

public LBHttpProfile.Builder setRequestHeaderSize(java.lang.Long requestHeaderSize)

A request with header equal to or below this size is guaranteed to be processed. A request with header larger than request_header_size will be processed up to 32K bytes on best effort basis. format: int64

Parameters:

requestHeaderSize - New value for the property.

setResponseBuffering

public LBHttpProfile.Builder setResponseBuffering(java.lang.Boolean responseBuffering)

When buffering is deactivated, the response is passed to a client synchronously, immediately as it is received. When buffering is activated, LB receives a response from the backend server as soon as possible, saving it into the buffers.

Parameters:

responseBuffering - New value for the property.

setResponseHeaderSize

public LBHttpProfile.Builder setResponseHeaderSize(java.lang.Long responseHeaderSize)

A response with header larger than response_header_size will be dropped. format: int64

Parameters:

responseHeaderSize - New value for the property.

setResponseTimeout

public LBHttpProfile.Builder setResponseTimeout(java.lang.Long responseTimeout)

If server doesn’t send any packet within this time, the connection is closed. format: int64

Parameters:

responseTimeout - New value for the property.

setServerKeepAlive

public LBHttpProfile.Builder setServerKeepAlive(java.lang.Boolean serverKeepAlive)

If server_keep_alive is true, it means the backend connection will keep alive for the client connection. Every client connection is tied 1:1 with the corresponding server-side connection. If server_keep_alive is false, it means the backend connection won't keep alive for the client connection. If server_keep_alive is not specified for API input, its value in API output will be the same with the property ntlm.

Parameters:

serverKeepAlive - New value for the property.

setxForwardedFor

public LBHttpProfile.Builder setxForwardedFor(java.lang.String xForwardedFor)

Possible values are:

• LBHttpProfile.X_FORWARDED_FOR_INSERT
• LBHttpProfile.X_FORWARDED_FOR_REPLACE

When X-Forwareded-For is configured, X-Forwarded-Proto and X-Forwarded-Port information is added automatically. The two additional header information can be also modified or deleted in load balancer rules.

Parameters:

xForwardedFor - New value for the property.

setLinks

public LBHttpProfile.Builder 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.

setSchema

public LBHttpProfile.Builder 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.

setSelf

public LBHttpProfile.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public LBHttpProfile.Builder 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.

setCreateTime

public LBHttpProfile.Builder 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.

setCreateUser

public LBHttpProfile.Builder 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.

setLastModifiedTime

public LBHttpProfile.Builder 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.

setLastModifiedUser

public LBHttpProfile.Builder 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.

setProtection

public LBHttpProfile.Builder 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.

setSystemOwned

public LBHttpProfile.Builder 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.

setDescription

public LBHttpProfile.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

public LBHttpProfile.Builder setDisplayName(java.lang.String displayName)

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

public LBHttpProfile.Builder setId(java.lang.String id)

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

public LBHttpProfile.Builder setTags(java.util.List<Tag> tags)

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public LBHttpProfile.Builder 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.

setOwnerId

public LBHttpProfile.Builder 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.

setParentPath

public LBHttpProfile.Builder 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.

setPath

public LBHttpProfile.Builder 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.

setRealizationId

public LBHttpProfile.Builder 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.

setRelativePath

public LBHttpProfile.Builder 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.

setRemotePath

public LBHttpProfile.Builder 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.

setUniqueId

public LBHttpProfile.Builder 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.

setChildren

public LBHttpProfile.Builder 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 in ChildPolicyConfigResource. When methods return a value of this class as a return value, the property will contain all the properties defined in ChildPolicyConfigResource.

setMarkedForDelete

public LBHttpProfile.Builder 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.

setOverridden

public LBHttpProfile.Builder 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.

build

public LBHttpProfile build()