com.vmware.nsx_global_policy.model

Class ALBApplicationPersistenceProfile.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBApplicationPersistenceProfile.Builder

Enclosing class:

ALBApplicationPersistenceProfile

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

Builder class for ALBApplicationPersistenceProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBApplicationPersistenceProfile	build()
ALBApplicationPersistenceProfile.Builder	setAppCookiePersistenceProfile(ALBAppCookiePersistenceProfile appCookiePersistenceProfile)
ALBApplicationPersistenceProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setDescription(java.lang.String description) Description of this resource
ALBApplicationPersistenceProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBApplicationPersistenceProfile.Builder	setHdrPersistenceProfile(ALBHdrPersistenceProfile hdrPersistenceProfile)
ALBApplicationPersistenceProfile.Builder	setHttpCookiePersistenceProfile(ALBHttpCookiePersistenceProfile httpCookiePersistenceProfile)
ALBApplicationPersistenceProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBApplicationPersistenceProfile.Builder	setIpPersistenceProfile(ALBIPPersistenceProfile ipPersistenceProfile)
ALBApplicationPersistenceProfile.Builder	setIsFederated(java.lang.Boolean isFederated) This field describes the object's replication scope.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBApplicationPersistenceProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBApplicationPersistenceProfile.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBApplicationPersistenceProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBApplicationPersistenceProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBApplicationPersistenceProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setPersistenceType(java.lang.String persistenceType) Possible values are: ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CLIENT_IP_ADDRESS ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_HTTP_COOKIE ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_TLS ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_APP_COOKIE ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_GSLB_SITE Method used to persist clients to the same server for a duration of time or a session.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
ALBApplicationPersistenceProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBApplicationPersistenceProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setSelf(SelfResourceLink self)
ALBApplicationPersistenceProfile.Builder	setServerHmDownRecovery(java.lang.String serverHmDownRecovery) Possible values are: ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_PICK_NEW_SERVER ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_ABORT_CONNECTION ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_CONTINUE_PERSISTENT_SERVER Specifies behavior when a persistent server has been marked down by a health monitor.
ALBApplicationPersistenceProfile.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.
ALBApplicationPersistenceProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBApplicationPersistenceProfile.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.

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 ALBApplicationPersistenceProfile.

Method Detail

setLinks

public ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.Builder setSelf(SelfResourceLink self)

Parameters:

self - New value for the property.

setRevision

public ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.Builder setDescription(java.lang.String description)

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

public ALBApplicationPersistenceProfile.Builder setResourceType(java.lang.String resourceType)

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBApplicationPersistenceProfile.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 Pmaas 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 ALBApplicationPersistenceProfile.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas 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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 thier 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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS 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 ALBApplicationPersistenceProfile.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entites 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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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 ALBApplicationPersistenceProfile.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.

setAppCookiePersistenceProfile

public ALBApplicationPersistenceProfile.Builder setAppCookiePersistenceProfile(ALBAppCookiePersistenceProfile appCookiePersistenceProfile)

Parameters:

appCookiePersistenceProfile - New value for the property.

setHdrPersistenceProfile

public ALBApplicationPersistenceProfile.Builder setHdrPersistenceProfile(ALBHdrPersistenceProfile hdrPersistenceProfile)

Parameters:

hdrPersistenceProfile - New value for the property.

setHttpCookiePersistenceProfile

public ALBApplicationPersistenceProfile.Builder setHttpCookiePersistenceProfile(ALBHttpCookiePersistenceProfile httpCookiePersistenceProfile)

Parameters:

httpCookiePersistenceProfile - New value for the property.

setIpPersistenceProfile

public ALBApplicationPersistenceProfile.Builder setIpPersistenceProfile(ALBIPPersistenceProfile ipPersistenceProfile)

Parameters:

ipPersistenceProfile - New value for the property.

setIsFederated

public ALBApplicationPersistenceProfile.Builder setIsFederated(java.lang.Boolean isFederated)

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

isFederated - New value for the property.

setMarkers

public ALBApplicationPersistenceProfile.Builder setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers)

List of labels to be used for granular RBAC. Allowed in Basic edition, Essentials edition, Enterprise edition.

Parameters:

markers - New value for the property.

setPersistenceType

public ALBApplicationPersistenceProfile.Builder setPersistenceType(java.lang.String persistenceType)

Possible values are:

• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CLIENT_IP_ADDRESS
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_HTTP_COOKIE
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_TLS
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_APP_COOKIE
• ALBApplicationPersistenceProfile.PERSISTENCE_TYPE_GSLB_SITE

Method used to persist clients to the same server for a duration of time or a session. Enum options - PERSISTENCE_TYPE_CLIENT_IP_ADDRESS, PERSISTENCE_TYPE_HTTP_COOKIE, PERSISTENCE_TYPE_TLS, PERSISTENCE_TYPE_CLIENT_IPV6_ADDRESS, PERSISTENCE_TYPE_CUSTOM_HTTP_HEADER, PERSISTENCE_TYPE_APP_COOKIE, PERSISTENCE_TYPE_GSLB_SITE. Allowed in Basic(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Essentials(Allowed values- PERSISTENCE_TYPE_CLIENT_IP_ADDRESS,PERSISTENCE_TYPE_HTTP_COOKIE) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as PERSISTENCE_TYPE_CLIENT_IP_ADDRESS.

Parameters:

persistenceType - New value for the property.

setServerHmDownRecovery

public ALBApplicationPersistenceProfile.Builder setServerHmDownRecovery(java.lang.String serverHmDownRecovery)

Possible values are:

• ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_PICK_NEW_SERVER
• ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_ABORT_CONNECTION
• ALBApplicationPersistenceProfile.SERVER_HM_DOWN_RECOVERY_CONTINUE_PERSISTENT_SERVER

Specifies behavior when a persistent server has been marked down by a health monitor. Enum options - HM_DOWN_PICK_NEW_SERVER, HM_DOWN_ABORT_CONNECTION, HM_DOWN_CONTINUE_PERSISTENT_SERVER. Allowed in Basic(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Essentials(Allowed values- HM_DOWN_PICK_NEW_SERVER) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as HM_DOWN_PICK_NEW_SERVER.

Parameters:

serverHmDownRecovery - New value for the property.

build

public ALBApplicationPersistenceProfile build()