com.vmware.nsx_global_policy.model

Class ALBPoolGroup.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBPoolGroup.Builder

Enclosing class:

ALBPoolGroup

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

Builder class for ALBPoolGroup.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBPoolGroup	build()
ALBPoolGroup.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBPoolGroup.Builder	setCloudConfigCksum(java.lang.String cloudConfigCksum) Checksum of cloud configuration for PoolGroup.
ALBPoolGroup.Builder	setCloudName(java.lang.String cloudName) It is a reference to an object of type Cloud.
ALBPoolGroup.Builder	setCreatedBy(java.lang.String createdBy) Name of the user who created the object.
ALBPoolGroup.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.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setDeactivatePrimaryPoolOnDown(java.lang.Boolean deactivatePrimaryPoolOnDown) Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command.
ALBPoolGroup.Builder	setDeploymentPolicyPath(java.lang.String deploymentPolicyPath) When setup autoscale manager will automatically promote new pools into production when deployment goals are met.
ALBPoolGroup.Builder	setDescription(java.lang.String description) Description of this resource
ALBPoolGroup.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBPoolGroup.Builder	setEnableHttp2(java.lang.Boolean enableHttp2) Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup.
ALBPoolGroup.Builder	setFailAction(ALBFailAction failAction)
ALBPoolGroup.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBPoolGroup.Builder	setImplicitPriorityLabels(java.lang.Boolean implicitPriorityLabels) Whether an implicit set of priority labels is generated.
ALBPoolGroup.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.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBPoolGroup.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBPoolGroup.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBPoolGroup.Builder	setMembers(java.util.List<ALBPoolGroupMember> members) List of pool group members object of type PoolGroupMember.
ALBPoolGroup.Builder	setMinServers(java.lang.Long minServers) The minimum number of servers to distribute traffic to.
ALBPoolGroup.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBPoolGroup.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBPoolGroup.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBPoolGroup.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.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setPriorityLabelsPath(java.lang.String priorityLabelsPath) path of the priority labels.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBPoolGroup.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.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBPoolGroup.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setSelf(SelfResourceLink self)
ALBPoolGroup.Builder	setServiceMetadata(java.lang.String serviceMetadata) Metadata pertaining to the service provided by this PoolGroup.
ALBPoolGroup.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.
ALBPoolGroup.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBPoolGroup.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 ALBPoolGroup.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setCloudConfigCksum

public ALBPoolGroup.Builder setCloudConfigCksum(java.lang.String cloudConfigCksum)

Checksum of cloud configuration for PoolGroup. Internally set by cloud connector.

Parameters:

cloudConfigCksum - New value for the property.

setCloudName

public ALBPoolGroup.Builder setCloudName(java.lang.String cloudName)

It is a reference to an object of type Cloud.

Parameters:

cloudName - New value for the property.

setCreatedBy

public ALBPoolGroup.Builder setCreatedBy(java.lang.String createdBy)

Name of the user who created the object.

Parameters:

createdBy - New value for the property.

setDeactivatePrimaryPoolOnDown

public ALBPoolGroup.Builder setDeactivatePrimaryPoolOnDown(java.lang.Boolean deactivatePrimaryPoolOnDown)

Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

deactivatePrimaryPoolOnDown - New value for the property.

setDeploymentPolicyPath

public ALBPoolGroup.Builder setDeploymentPolicyPath(java.lang.String deploymentPolicyPath)

When setup autoscale manager will automatically promote new pools into production when deployment goals are met. It is a reference to an object of type PoolGroupDeploymentPolicy.

Parameters:

deploymentPolicyPath - New value for the property.

setEnableHttp2

public ALBPoolGroup.Builder setEnableHttp2(java.lang.Boolean enableHttp2)

Enable HTTP/2 for traffic from VirtualService to all the backend servers in all the pools configured under this PoolGroup. Allowed in Basic(Allowed values- false) edition, Essentials(Allowed values- false) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

enableHttp2 - New value for the property.

setFailAction

public ALBPoolGroup.Builder setFailAction(ALBFailAction failAction)

Parameters:

failAction - New value for the property.

setImplicitPriorityLabels

public ALBPoolGroup.Builder setImplicitPriorityLabels(java.lang.Boolean implicitPriorityLabels)

Whether an implicit set of priority labels is generated. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

implicitPriorityLabels - New value for the property.

setMarkers

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

setMembers

public ALBPoolGroup.Builder setMembers(java.util.List<ALBPoolGroupMember> members)

List of pool group members object of type PoolGroupMember.

Parameters:

members - New value for the property.

setMinServers

public ALBPoolGroup.Builder setMinServers(java.lang.Long minServers)

The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - 'Disable'. Allowed in Basic(Allowed values- 0) edition, Essentials(Allowed values- 0) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

minServers - New value for the property.

setPriorityLabelsPath

public ALBPoolGroup.Builder setPriorityLabelsPath(java.lang.String priorityLabelsPath)

path of the priority labels. If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority. It is a reference to an object of type PriorityLabels.

Parameters:

priorityLabelsPath - New value for the property.

setServiceMetadata

public ALBPoolGroup.Builder setServiceMetadata(java.lang.String serviceMetadata)

Metadata pertaining to the service provided by this PoolGroup. In Openshift/Kubernetes environments, app metadata info is stored. Any user input to this field will be overwritten by Avi Vantage.

Parameters:

serviceMetadata - New value for the property.

build

public ALBPoolGroup build()