com.vmware.nsx_global_policy.model

Class ALBApplicationProfile.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBApplicationProfile.Builder

Enclosing class:

ALBApplicationProfile

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

Builder class for ALBApplicationProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBApplicationProfile	build()
ALBApplicationProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBApplicationProfile.Builder	setCloudConfigCksum(java.lang.String cloudConfigCksum) Checksum of application profiles.
ALBApplicationProfile.Builder	setCreatedBy(java.lang.String createdBy) Name of the application profile creator.
ALBApplicationProfile.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.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setDescription(java.lang.String description) Description of this resource
ALBApplicationProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBApplicationProfile.Builder	setDnsServiceProfile(ALBDnsServiceApplicationProfile dnsServiceProfile)
ALBApplicationProfile.Builder	setDosRlProfile(ALBDosRateLimitProfile dosRlProfile)
ALBApplicationProfile.Builder	setHttpProfile(ALBHTTPApplicationProfile httpProfile)
ALBApplicationProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBApplicationProfile.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.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBApplicationProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBApplicationProfile.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBApplicationProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBApplicationProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBApplicationProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBApplicationProfile.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.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setPreserveClientIp(java.lang.Boolean preserveClientIp) Specifies if client IP needs to be preserved for backend connection.
ALBApplicationProfile.Builder	setPreserveClientPort(java.lang.Boolean preserveClientPort) Specifies if we need to preserve client port while preserving client IP for backend connections.
ALBApplicationProfile.Builder	setPreserveDestIpPort(java.lang.Boolean preserveDestIpPort) Specifies if destination IP and port needs to be preserved for backend connection.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBApplicationProfile.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.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBApplicationProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setSelf(SelfResourceLink self)
ALBApplicationProfile.Builder	setSipServiceProfile(ALBSipServiceApplicationProfile sipServiceProfile)
ALBApplicationProfile.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.
ALBApplicationProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBApplicationProfile.Builder	setTcpAppProfile(ALBTCPApplicationProfile tcpAppProfile)
ALBApplicationProfile.Builder	setType(java.lang.String type) Possible values are: ALBApplicationProfile.TYPE_L4 ALBApplicationProfile.TYPE_HTTP ALBApplicationProfile.TYPE_SYSLOG ALBApplicationProfile.TYPE_DNS ALBApplicationProfile.TYPE_SSL ALBApplicationProfile.TYPE_SIP Specifies which application layer proxy is enabled for the virtual service.
ALBApplicationProfile.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 ALBApplicationProfile.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.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 ALBApplicationProfile.Builder setCloudConfigCksum(java.lang.String cloudConfigCksum)

Checksum of application profiles. Internally set by cloud connector.

Parameters:

cloudConfigCksum - New value for the property.

setCreatedBy

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

Name of the application profile creator.

Parameters:

createdBy - New value for the property.

setDnsServiceProfile

public ALBApplicationProfile.Builder setDnsServiceProfile(ALBDnsServiceApplicationProfile dnsServiceProfile)

Parameters:

dnsServiceProfile - New value for the property.

setDosRlProfile

public ALBApplicationProfile.Builder setDosRlProfile(ALBDosRateLimitProfile dosRlProfile)

Parameters:

dosRlProfile - New value for the property.

setHttpProfile

public ALBApplicationProfile.Builder setHttpProfile(ALBHTTPApplicationProfile httpProfile)

Parameters:

httpProfile - New value for the property.

setMarkers

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

setPreserveClientIp

public ALBApplicationProfile.Builder setPreserveClientIp(java.lang.Boolean preserveClientIp)

Specifies if client IP needs to be preserved for backend connection. Not compatible with Connection Multiplexing. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

preserveClientIp - New value for the property.

setPreserveClientPort

public ALBApplicationProfile.Builder setPreserveClientPort(java.lang.Boolean preserveClientPort)

Specifies if we need to preserve client port while preserving client IP for backend connections. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

preserveClientPort - New value for the property.

setPreserveDestIpPort

public ALBApplicationProfile.Builder setPreserveDestIpPort(java.lang.Boolean preserveDestIpPort)

Specifies if destination IP and port needs to be preserved for backend connection. 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:

preserveDestIpPort - New value for the property.

setSipServiceProfile

public ALBApplicationProfile.Builder setSipServiceProfile(ALBSipServiceApplicationProfile sipServiceProfile)

Parameters:

sipServiceProfile - New value for the property.

setTcpAppProfile

public ALBApplicationProfile.Builder setTcpAppProfile(ALBTCPApplicationProfile tcpAppProfile)

Parameters:

tcpAppProfile - New value for the property.

setType

public ALBApplicationProfile.Builder setType(java.lang.String type)

Possible values are:

• ALBApplicationProfile.TYPE_L4
• ALBApplicationProfile.TYPE_HTTP
• ALBApplicationProfile.TYPE_SYSLOG
• ALBApplicationProfile.TYPE_DNS
• ALBApplicationProfile.TYPE_SSL
• ALBApplicationProfile.TYPE_SIP

Specifies which application layer proxy is enabled for the virtual service. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Allowed in Basic(Allowed values- APPLICATION_PROFILE_TYPE_L4,APPLICATION_PROFILE_TYPE_HTTP) edition, Essentials(Allowed values- APPLICATION_PROFILE_TYPE_L4) edition, Enterprise edition.

Parameters:

type - New value for the property.

build

public ALBApplicationProfile build()