com.vmware.nsx_global_policy.model

Class ALBPoolGroupDeploymentPolicy.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBPoolGroupDeploymentPolicy.Builder

Enclosing class:

ALBPoolGroupDeploymentPolicy

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

Builder class for ALBPoolGroupDeploymentPolicy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBPoolGroupDeploymentPolicy	build()
ALBPoolGroupDeploymentPolicy.Builder	setAutoDisableOldProdPools(java.lang.Boolean autoDisableOldProdPools) It will automatically disable old production pools once there is a new production candidate.
ALBPoolGroupDeploymentPolicy.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setDescription(java.lang.String description) Description of this resource
ALBPoolGroupDeploymentPolicy.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBPoolGroupDeploymentPolicy.Builder	setEvaluationDuration(java.lang.Long evaluationDuration) Duration of evaluation period for automatic deployment.
ALBPoolGroupDeploymentPolicy.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBPoolGroupDeploymentPolicy.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBPoolGroupDeploymentPolicy.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBPoolGroupDeploymentPolicy.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBPoolGroupDeploymentPolicy.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBPoolGroupDeploymentPolicy.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBPoolGroupDeploymentPolicy.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBPoolGroupDeploymentPolicy.Builder	setRules(java.util.List<ALBPGDeploymentRule> rules) Placeholder for description of property rules of obj type PoolGroupDeploymentPolicy field type str type array.
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setScheme(java.lang.String scheme) Possible values are: ALBPoolGroupDeploymentPolicy.SCHEME_BLUE_GREEN ALBPoolGroupDeploymentPolicy.SCHEME_CANARY deployment scheme.
ALBPoolGroupDeploymentPolicy.Builder	setSelf(SelfResourceLink self)
ALBPoolGroupDeploymentPolicy.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.
ALBPoolGroupDeploymentPolicy.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBPoolGroupDeploymentPolicy.Builder	setTargetTestTrafficRatio(java.lang.Long targetTestTrafficRatio) Target traffic ratio before pool is made production.
ALBPoolGroupDeploymentPolicy.Builder	setTestTrafficRatioRampup(java.lang.Long testTrafficRatioRampup) Ratio of the traffic that is sent to the pool under test.
ALBPoolGroupDeploymentPolicy.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
ALBPoolGroupDeploymentPolicy.Builder	setWebhookPath(java.lang.String webhookPath) Webhook configured with URL that Avi controller will pass back information about pool group, old and new pool information and current deployment rule results.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setAutoDisableOldProdPools

public ALBPoolGroupDeploymentPolicy.Builder setAutoDisableOldProdPools(java.lang.Boolean autoDisableOldProdPools)

It will automatically disable old production pools once there is a new production candidate. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

autoDisableOldProdPools - New value for the property.

setEvaluationDuration

public ALBPoolGroupDeploymentPolicy.Builder setEvaluationDuration(java.lang.Long evaluationDuration)

Duration of evaluation period for automatic deployment. Allowed values are 60-86400. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300. format: int64

Parameters:

evaluationDuration - New value for the property.

setMarkers

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

setRules

public ALBPoolGroupDeploymentPolicy.Builder setRules(java.util.List<ALBPGDeploymentRule> rules)

Placeholder for description of property rules of obj type PoolGroupDeploymentPolicy field type str type array.

Parameters:

rules - New value for the property.

setScheme

public ALBPoolGroupDeploymentPolicy.Builder setScheme(java.lang.String scheme)

Possible values are:

• ALBPoolGroupDeploymentPolicy.SCHEME_BLUE_GREEN
• ALBPoolGroupDeploymentPolicy.SCHEME_CANARY

deployment scheme. Enum options - BLUE_GREEN, CANARY. Default value when not specified in API or module is interpreted by ALB Controller as BLUE_GREEN.

Parameters:

scheme - New value for the property.

setTargetTestTrafficRatio

public ALBPoolGroupDeploymentPolicy.Builder setTargetTestTrafficRatio(java.lang.Long targetTestTrafficRatio)

Target traffic ratio before pool is made production. Allowed values are 1-100. Unit is RATIO. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64

Parameters:

targetTestTrafficRatio - New value for the property.

setTestTrafficRatioRampup

public ALBPoolGroupDeploymentPolicy.Builder setTestTrafficRatioRampup(java.lang.Long testTrafficRatioRampup)

Ratio of the traffic that is sent to the pool under test. test ratio of 100 means blue green. Allowed values are 1-100. Default value when not specified in API or module is interpreted by ALB Controller as 100. format: int64

Parameters:

testTrafficRatioRampup - New value for the property.

setWebhookPath

public ALBPoolGroupDeploymentPolicy.Builder setWebhookPath(java.lang.String webhookPath)

Webhook configured with URL that Avi controller will pass back information about pool group, old and new pool information and current deployment rule results. It is a reference to an object of type Webhook.

Parameters:

webhookPath - New value for the property.

build

public ALBPoolGroupDeploymentPolicy build()