com.vmware.nsx_global_policy.model

Class ALBSSLKeyAndCertificate.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBSSLKeyAndCertificate.Builder

Enclosing class:

ALBSSLKeyAndCertificate

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

Builder class for ALBSSLKeyAndCertificate.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBSSLKeyAndCertificate	build()
ALBSSLKeyAndCertificate.Builder	setCaCerts(java.util.List<ALBCertificateAuthority> caCerts) CA certificates in certificate chain.
ALBSSLKeyAndCertificate.Builder	setCertificate(ALBSSLCertificate certificate)
ALBSSLKeyAndCertificate.Builder	setCertificateBase64(java.lang.Boolean certificateBase64) States if the certificate is base64 encoded.
ALBSSLKeyAndCertificate.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBSSLKeyAndCertificate.Builder	setCreatedBy(java.lang.String createdBy) Creator name.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setDescription(java.lang.String description) Description of this resource
ALBSSLKeyAndCertificate.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBSSLKeyAndCertificate.Builder	setDynamicParams(java.util.List<ALBCustomParams> dynamicParams) Dynamic parameters needed for certificate management profile.
ALBSSLKeyAndCertificate.Builder	setEnableOcspStapling(java.lang.Boolean enableOcspStapling) Enables OCSP Stapling.
ALBSSLKeyAndCertificate.Builder	setEnckeyBase64(java.lang.String enckeyBase64) Encrypted private key corresponding to the private key (e.g.
ALBSSLKeyAndCertificate.Builder	setEnckeyName(java.lang.String enckeyName) Name of the encrypted private key (e.g.
ALBSSLKeyAndCertificate.Builder	setFormat(java.lang.String format) Possible values are: ALBSSLKeyAndCertificate.FORMAT_PEM ALBSSLKeyAndCertificate.FORMAT_PKCS12 Format of the Key/Certificate file.
ALBSSLKeyAndCertificate.Builder	setHardwaresecuritymodulegroupPath(java.lang.String hardwaresecuritymodulegroupPath) It is a reference to an object of type HardwareSecurityModuleGroup.
ALBSSLKeyAndCertificate.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBSSLKeyAndCertificate.Builder	setKey(java.lang.String key) Private key.
ALBSSLKeyAndCertificate.Builder	setKeyBase64(java.lang.Boolean keyBase64) States if the private key is base64 encoded.
ALBSSLKeyAndCertificate.Builder	setKeyParams(ALBSSLKeyParams keyParams)
ALBSSLKeyAndCertificate.Builder	setKeyPassphrase(java.lang.String keyPassphrase) Passphrase used to encrypt the private key.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBSSLKeyAndCertificate.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBSSLKeyAndCertificate.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBSSLKeyAndCertificate.Builder	setOcspConfig(ALBOCSPConfig ocspConfig)
ALBSSLKeyAndCertificate.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBSSLKeyAndCertificate.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBSSLKeyAndCertificate.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBSSLKeyAndCertificate.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setSelf(SelfResourceLink self)
ALBSSLKeyAndCertificate.Builder	setStatus(java.lang.String status) Possible values are: ALBSSLKeyAndCertificate.STATUS_FINISHED ALBSSLKeyAndCertificate.STATUS_PENDING Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING.
ALBSSLKeyAndCertificate.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.
ALBSSLKeyAndCertificate.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBSSLKeyAndCertificate.Builder	setType(java.lang.String type) Possible values are: ALBSSLKeyAndCertificate.TYPE_VIRTUALSERVICE ALBSSLKeyAndCertificate.TYPE_SYSTEM ALBSSLKeyAndCertificate.TYPE_CA Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA.
ALBSSLKeyAndCertificate.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 ALBSSLKeyAndCertificate.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setCaCerts

public ALBSSLKeyAndCertificate.Builder setCaCerts(java.util.List<ALBCertificateAuthority> caCerts)

CA certificates in certificate chain.

Parameters:

caCerts - New value for the property.

setCertificate

public ALBSSLKeyAndCertificate.Builder setCertificate(ALBSSLCertificate certificate)

Parameters:

certificate - New value for the property.

setCertificateBase64

public ALBSSLKeyAndCertificate.Builder setCertificateBase64(java.lang.Boolean certificateBase64)

States if the certificate is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

certificateBase64 - New value for the property.

setCreatedBy

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

Creator name.

Parameters:

createdBy - New value for the property.

setDynamicParams

public ALBSSLKeyAndCertificate.Builder setDynamicParams(java.util.List<ALBCustomParams> dynamicParams)

Dynamic parameters needed for certificate management profile.

Parameters:

dynamicParams - New value for the property.

setEnableOcspStapling

public ALBSSLKeyAndCertificate.Builder setEnableOcspStapling(java.lang.Boolean enableOcspStapling)

Enables OCSP Stapling. 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:

enableOcspStapling - New value for the property.

setEnckeyBase64

public ALBSSLKeyAndCertificate.Builder setEnckeyBase64(java.lang.String enckeyBase64)

Encrypted private key corresponding to the private key (e.g. those generated by an HSM such as Thales nShield).

Parameters:

enckeyBase64 - New value for the property.

setEnckeyName

public ALBSSLKeyAndCertificate.Builder setEnckeyName(java.lang.String enckeyName)

Name of the encrypted private key (e.g. those generated by an HSM such as Thales nShield).

Parameters:

enckeyName - New value for the property.

setFormat

public ALBSSLKeyAndCertificate.Builder setFormat(java.lang.String format)

Possible values are:

• ALBSSLKeyAndCertificate.FORMAT_PEM
• ALBSSLKeyAndCertificate.FORMAT_PKCS12

Format of the Key/Certificate file. Enum options - SSL_PEM, SSL_PKCS12. Default value when not specified in API or module is interpreted by ALB Controller as SSL_PEM.

Parameters:

format - New value for the property.

setHardwaresecuritymodulegroupPath

public ALBSSLKeyAndCertificate.Builder setHardwaresecuritymodulegroupPath(java.lang.String hardwaresecuritymodulegroupPath)

It is a reference to an object of type HardwareSecurityModuleGroup.

Parameters:

hardwaresecuritymodulegroupPath - New value for the property.

setKey

public ALBSSLKeyAndCertificate.Builder setKey(java.lang.String key)

Private key.

Parameters:

key - New value for the property.

setKeyBase64

public ALBSSLKeyAndCertificate.Builder setKeyBase64(java.lang.Boolean keyBase64)

States if the private key is base64 encoded. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

keyBase64 - New value for the property.

setKeyParams

public ALBSSLKeyAndCertificate.Builder setKeyParams(ALBSSLKeyParams keyParams)

Parameters:

keyParams - New value for the property.

setKeyPassphrase

public ALBSSLKeyAndCertificate.Builder setKeyPassphrase(java.lang.String keyPassphrase)

Passphrase used to encrypt the private key.

Parameters:

keyPassphrase - New value for the property.

setMarkers

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

setOcspConfig

public ALBSSLKeyAndCertificate.Builder setOcspConfig(ALBOCSPConfig ocspConfig)

Parameters:

ocspConfig - New value for the property.

setStatus

public ALBSSLKeyAndCertificate.Builder setStatus(java.lang.String status)

Possible values are:

• ALBSSLKeyAndCertificate.STATUS_FINISHED
• ALBSSLKeyAndCertificate.STATUS_PENDING

Enum options - SSL_CERTIFICATE_FINISHED, SSL_CERTIFICATE_PENDING. Default value when not specified in API or module is interpreted by ALB Controller as SSL_CERTIFICATE_FINISHED.

Parameters:

status - New value for the property.

setType

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

Possible values are:

• ALBSSLKeyAndCertificate.TYPE_VIRTUALSERVICE
• ALBSSLKeyAndCertificate.TYPE_SYSTEM
• ALBSSLKeyAndCertificate.TYPE_CA

Enum options - SSL_CERTIFICATE_TYPE_VIRTUALSERVICE, SSL_CERTIFICATE_TYPE_SYSTEM, SSL_CERTIFICATE_TYPE_CA.

Parameters:

type - New value for the property.

build

public ALBSSLKeyAndCertificate build()