com.vmware.nsx_global_policy.model

Class ALBServerAutoScalePolicy.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBServerAutoScalePolicy.Builder

Enclosing class:

ALBServerAutoScalePolicy

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

Builder class for ALBServerAutoScalePolicy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBServerAutoScalePolicy	build()
ALBServerAutoScalePolicy.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setDelayForServerGarbageCollection(java.lang.Long delayForServerGarbageCollection) Delay in minutes after which a down server will be removed from Pool.
ALBServerAutoScalePolicy.Builder	setDescription(java.lang.String description) Description of this resource
ALBServerAutoScalePolicy.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBServerAutoScalePolicy.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBServerAutoScalePolicy.Builder	setIntelligentAutoscale(java.lang.Boolean intelligentAutoscale) Use Avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers.
ALBServerAutoScalePolicy.Builder	setIntelligentScaleinMargin(java.lang.Long intelligentScaleinMargin) Maximum extra capacity as percentage of load used by the intelligent scheme.
ALBServerAutoScalePolicy.Builder	setIntelligentScaleoutMargin(java.lang.Long intelligentScaleoutMargin) Minimum extra capacity as percentage of load used by the intelligent scheme.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBServerAutoScalePolicy.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBServerAutoScalePolicy.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBServerAutoScalePolicy.Builder	setMaxScaleinAdjustmentStep(java.lang.Long maxScaleinAdjustmentStep) Maximum number of servers to scalein simultaneously.
ALBServerAutoScalePolicy.Builder	setMaxScaleoutAdjustmentStep(java.lang.Long maxScaleoutAdjustmentStep) Maximum number of servers to scaleout simultaneously.
ALBServerAutoScalePolicy.Builder	setMaxSize(java.lang.Long maxSize) Maximum number of servers after scaleout.
ALBServerAutoScalePolicy.Builder	setMinSize(java.lang.Long minSize) No scale-in happens once number of operationally up servers reach min_servers.
ALBServerAutoScalePolicy.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBServerAutoScalePolicy.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBServerAutoScalePolicy.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBServerAutoScalePolicy.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBServerAutoScalePolicy.Builder	setScaleinCooldown(java.lang.Long scaleinCooldown) Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete.
ALBServerAutoScalePolicy.Builder	setScaleoutCooldown(java.lang.Long scaleoutCooldown) Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete.
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setSelf(SelfResourceLink self)
ALBServerAutoScalePolicy.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.
ALBServerAutoScalePolicy.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBServerAutoScalePolicy.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
ALBServerAutoScalePolicy.Builder	setUsePredictedLoad(java.lang.Boolean usePredictedLoad) Use predicted load rather than current load.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setDelayForServerGarbageCollection

public ALBServerAutoScalePolicy.Builder setDelayForServerGarbageCollection(java.lang.Long delayForServerGarbageCollection)

Delay in minutes after which a down server will be removed from Pool. Value 0 disables this functionality. Default value when not specified in API or module is interpreted by ALB Controller as 0. format: int64

Parameters:

delayForServerGarbageCollection - New value for the property.

setIntelligentAutoscale

public ALBServerAutoScalePolicy.Builder setIntelligentAutoscale(java.lang.Boolean intelligentAutoscale)

Use Avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

intelligentAutoscale - New value for the property.

setIntelligentScaleinMargin

public ALBServerAutoScalePolicy.Builder setIntelligentScaleinMargin(java.lang.Long intelligentScaleinMargin)

Maximum extra capacity as percentage of load used by the intelligent scheme. Scalein is triggered when available capacity is more than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by ALB Controller as 40. format: int64

Parameters:

intelligentScaleinMargin - New value for the property.

setIntelligentScaleoutMargin

public ALBServerAutoScalePolicy.Builder setIntelligentScaleoutMargin(java.lang.Long intelligentScaleoutMargin)

Minimum extra capacity as percentage of load used by the intelligent scheme. Scaleout is triggered when available capacity is less than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by ALB Controller as 20. format: int64

Parameters:

intelligentScaleoutMargin - New value for the property.

setMarkers

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

setMaxScaleinAdjustmentStep

public ALBServerAutoScalePolicy.Builder setMaxScaleinAdjustmentStep(java.lang.Long maxScaleinAdjustmentStep)

Maximum number of servers to scalein simultaneously. The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64

Parameters:

maxScaleinAdjustmentStep - New value for the property.

setMaxScaleoutAdjustmentStep

public ALBServerAutoScalePolicy.Builder setMaxScaleoutAdjustmentStep(java.lang.Long maxScaleoutAdjustmentStep)

Maximum number of servers to scaleout simultaneously. The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size. Default value when not specified in API or module is interpreted by ALB Controller as 1. format: int64

Parameters:

maxScaleoutAdjustmentStep - New value for the property.

setMaxSize

public ALBServerAutoScalePolicy.Builder setMaxSize(java.lang.Long maxSize)

Maximum number of servers after scaleout. Allowed values are 0-400. format: int64

Parameters:

maxSize - New value for the property.

setMinSize

public ALBServerAutoScalePolicy.Builder setMinSize(java.lang.Long minSize)

No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400. format: int64

Parameters:

minSize - New value for the property.

setScaleinCooldown

public ALBServerAutoScalePolicy.Builder setScaleinCooldown(java.lang.Long scaleinCooldown)

Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300. format: int64

Parameters:

scaleinCooldown - New value for the property.

setScaleoutCooldown

public ALBServerAutoScalePolicy.Builder setScaleoutCooldown(java.lang.Long scaleoutCooldown)

Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete. Unit is SEC. Default value when not specified in API or module is interpreted by ALB Controller as 300. format: int64

Parameters:

scaleoutCooldown - New value for the property.

setUsePredictedLoad

public ALBServerAutoScalePolicy.Builder setUsePredictedLoad(java.lang.Boolean usePredictedLoad)

Use predicted load rather than current load. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

usePredictedLoad - New value for the property.

build

public ALBServerAutoScalePolicy build()