com.vmware.nsx_policy.model

Class LBService.Builder

java.lang.Object

com.vmware.nsx_policy.model.LBService.Builder

Enclosing class:

LBService

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

Builder class for LBService.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LBService	build()
LBService.Builder	setAccessLogEnabled(java.lang.Boolean accessLogEnabled) Flag to enable access log
LBService.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
LBService.Builder	setConnectivityPath(java.lang.String connectivityPath) LBS could be instantiated (or created) on the Tier-1, etc.
LBService.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.
LBService.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.
LBService.Builder	setDescription(java.lang.String description) Description of this resource
LBService.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LBService.Builder	setEnabled(java.lang.Boolean enabled) Flag to enable the load balancer service.
LBService.Builder	setErrorLogLevel(java.lang.String errorLogLevel) Possible values are: LBService.ERROR_LOG_LEVEL_DEBUG LBService.ERROR_LOG_LEVEL_INFO LBService.ERROR_LOG_LEVEL_WARNING LBService.ERROR_LOG_LEVEL_ERROR LBService.ERROR_LOG_LEVEL_CRITICAL LBService.ERROR_LOG_LEVEL_ALERT LBService.ERROR_LOG_LEVEL_EMERGENCY Load balancer engine writes information about encountered issues of different severity levels to the error log.
LBService.Builder	setId(java.lang.String id) Unique identifier of this resource
LBService.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.
LBService.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.
LBService.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LBService.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LBService.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LBService.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LBService.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
LBService.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.
LBService.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.
LBService.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.
LBService.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LBService.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.
LBService.Builder	setRelaxScaleValidation(java.lang.Boolean relaxScaleValidation) If relax_scale_validation is true, the scale validations for virtual servers/pools/pool members/rules are relaxed for load balancer service.
LBService.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.
LBService.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LBService.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LBService.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.
LBService.Builder	setSelf(SelfResourceLink self)
LBService.Builder	setSize(java.lang.String size) Possible values are: LBService.SIZE_SMALL LBService.SIZE_MEDIUM LBService.SIZE_LARGE LBService.SIZE_XLARGE LBService.SIZE_DLB Load balancer service size.
LBService.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.
LBService.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LBService.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 LBService.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setAccessLogEnabled

public LBService.Builder setAccessLogEnabled(java.lang.Boolean accessLogEnabled)

Flag to enable access log

Parameters:

accessLogEnabled - New value for the property.

setConnectivityPath

public LBService.Builder setConnectivityPath(java.lang.String connectivityPath)

LBS could be instantiated (or created) on the Tier-1, etc. For now, only the Tier-1 object is supported.

Parameters:

connectivityPath - New value for the property.

setEnabled

public LBService.Builder setEnabled(java.lang.Boolean enabled)

Flag to enable the load balancer service.

Parameters:

enabled - New value for the property.

setErrorLogLevel

public LBService.Builder setErrorLogLevel(java.lang.String errorLogLevel)

Possible values are:

• LBService.ERROR_LOG_LEVEL_DEBUG
• LBService.ERROR_LOG_LEVEL_INFO
• LBService.ERROR_LOG_LEVEL_WARNING
• LBService.ERROR_LOG_LEVEL_ERROR
• LBService.ERROR_LOG_LEVEL_CRITICAL
• LBService.ERROR_LOG_LEVEL_ALERT
• LBService.ERROR_LOG_LEVEL_EMERGENCY

Load balancer engine writes information about encountered issues of different severity levels to the error log. This setting is used to define the severity level of the error log.

Parameters:

errorLogLevel - New value for the property.

setRelaxScaleValidation

public LBService.Builder setRelaxScaleValidation(java.lang.Boolean relaxScaleValidation)

If relax_scale_validation is true, the scale validations for virtual servers/pools/pool members/rules are relaxed for load balancer service. When load balancer service is deployed on edge nodes, the scale of virtual servers/pools/pool members for the load balancer service should not exceed the scale number of the largest load balancer size which could be configured on a certain edge form factor. For example, the largest load balancer size supported on a MEDIUM edge node is MEDIUM. So one SMALL load balancer deployed on MEDIUM edge nodes can support the scale number of MEDIUM load balancer. It is not recommended to enable active monitors if relax_scale_validation is true due to performance consideration. If relax_scale_validation is false, scale numbers should be validated for load balancer service. The property is deprecated as NSX-T Load Balancer is deprecated.

Parameters:

relaxScaleValidation - New value for the property.

setSize

public LBService.Builder setSize(java.lang.String size)

Possible values are:

• LBService.SIZE_SMALL
• LBService.SIZE_MEDIUM
• LBService.SIZE_LARGE
• LBService.SIZE_XLARGE
• LBService.SIZE_DLB

Load balancer service size. The load balancer service sizes, SMALL, MEDIUM, LARGE and XLARGE are all deprecated. Customers who are using this set of features are advised to migrate to NSX Advanced Load Balancer (Avi) which provides a superset of the NSX-T load balancing functionality.

Parameters:

size - New value for the property.

build

public LBService build()