com.vmware.nsx_policy.model

Class LBSourceIpPersistenceProfile.Builder

java.lang.Object

com.vmware.nsx_policy.model.LBSourceIpPersistenceProfile.Builder

Enclosing class:

LBSourceIpPersistenceProfile

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

Builder class for LBSourceIpPersistenceProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LBSourceIpPersistenceProfile	build()
LBSourceIpPersistenceProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setDescription(java.lang.String description) Description of this resource
LBSourceIpPersistenceProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LBSourceIpPersistenceProfile.Builder	setHaPersistenceMirroringEnabled(java.lang.Boolean haPersistenceMirroringEnabled) Persistence entries are not synchronized to the HA peer by default.
LBSourceIpPersistenceProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LBSourceIpPersistenceProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LBSourceIpPersistenceProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LBSourceIpPersistenceProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LBSourceIpPersistenceProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setPersistenceShared(java.lang.Boolean persistenceShared) Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setPurge(java.lang.String purge) Possible values are: LBSourceIpPersistenceProfile.PURGE_NO_PURGE LBSourceIpPersistenceProfile.PURGE_FULL Persistence purge setting.
LBSourceIpPersistenceProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setSelf(SelfResourceLink self)
LBSourceIpPersistenceProfile.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.
LBSourceIpPersistenceProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LBSourceIpPersistenceProfile.Builder	setTimeout(java.lang.Long timeout) When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time.
LBSourceIpPersistenceProfile.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities 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 LBSourceIpPersistenceProfile.

Method Detail

setHaPersistenceMirroringEnabled

public LBSourceIpPersistenceProfile.Builder setHaPersistenceMirroringEnabled(java.lang.Boolean haPersistenceMirroringEnabled)

Persistence entries are not synchronized to the HA peer by default. The property is deprecated as NSX-T Load Balancer is deprecated.

Parameters:

haPersistenceMirroringEnabled - New value for the property.

setPurge

public LBSourceIpPersistenceProfile.Builder setPurge(java.lang.String purge)

Possible values are:

• LBSourceIpPersistenceProfile.PURGE_NO_PURGE
• LBSourceIpPersistenceProfile.PURGE_FULL

Persistence purge setting.

Parameters:

purge - New value for the property.

setTimeout

public LBSourceIpPersistenceProfile.Builder setTimeout(java.lang.Long timeout)

When all connections complete (reference count reaches 0), persistence entry timer is started with the expiration time. format: int64

Parameters:

timeout - New value for the property.

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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 LBSourceIpPersistenceProfile.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.

setPersistenceShared

public LBSourceIpPersistenceProfile.Builder setPersistenceShared(java.lang.Boolean persistenceShared)

Persistence shared setting indicates that all LBVirtualServers that consume this LBPersistenceProfile should share the same persistence mechanism when enabled. Meaning, persistence entries of a client accessing one virtual server will also affect the same client's connections to a different virtual server. For example, say there are two virtual servers vip-ip1:80 and vip-ip1:8080 bound to the same Group g1 consisting of two servers (s11:80 and s12:80). By default, each virtual server will have its own persistence table or cookie. So, in the earlier example, there will be two tables (vip-ip1:80, p1) and (vip-ip1:8080, p1) or cookies. So, if a client connects to vip1:80 and later connects to vip1:8080, the second connection may be sent to a different server than the first. When persistence_shared is enabled, then the second connection will always connect to the same server as the original connection. For COOKIE persistence type, the same cookie will be shared by multiple virtual servers. For SOURCE_IP persistence type, the persistence table will be shared across virtual servers. For GENERIC persistence type, the persistence table will be shared across virtual servers which consume the same persistence profile in LBRule actions.

Parameters:

persistenceShared - New value for the property.

build

public LBSourceIpPersistenceProfile build()