com.vmware.nsx_global_policy.model

Class ALBPKIProfile.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.ALBPKIProfile.Builder

Enclosing class:

ALBPKIProfile

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

Builder class for ALBPKIProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
ALBPKIProfile	build()
ALBPKIProfile.Builder	setCaCerts(java.util.List<ALBSSLCertificate> caCerts) List of Certificate Authorities (Root and Intermediate) trusted that is used for certificate validation.
ALBPKIProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
ALBPKIProfile.Builder	setCreatedBy(java.lang.String createdBy) Creator name.
ALBPKIProfile.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.
ALBPKIProfile.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.
ALBPKIProfile.Builder	setCrlCheck(java.lang.Boolean crlCheck) When enabled, Avi will verify via CRL checks that certificates in the trust chain have not been revoked.
ALBPKIProfile.Builder	setCrls(java.util.List<ALBCRL> crls) Certificate Revocation Lists.
ALBPKIProfile.Builder	setDescription(java.lang.String description) Description of this resource
ALBPKIProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
ALBPKIProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
ALBPKIProfile.Builder	setIgnorePeerChain(java.lang.Boolean ignorePeerChain) When enabled, Avi will not trust Intermediate and Root certs presented by a client.
ALBPKIProfile.Builder	setIsFederated(java.lang.Boolean isFederated) This field describes the object's replication scope.
ALBPKIProfile.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.
ALBPKIProfile.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.
ALBPKIProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
ALBPKIProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
ALBPKIProfile.Builder	setMarkers(java.util.List<ALBRoleFilterMatchLabel> markers) List of labels to be used for granular RBAC.
ALBPKIProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
ALBPKIProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
ALBPKIProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
ALBPKIProfile.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.
ALBPKIProfile.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.
ALBPKIProfile.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.
ALBPKIProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
ALBPKIProfile.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.
ALBPKIProfile.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.
ALBPKIProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
ALBPKIProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
ALBPKIProfile.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.
ALBPKIProfile.Builder	setSelf(SelfResourceLink self)
ALBPKIProfile.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.
ALBPKIProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
ALBPKIProfile.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
ALBPKIProfile.Builder	setValidateOnlyLeafCrl(java.lang.Boolean validateOnlyLeafCrl) When enabled, Avi will only validate the revocation status of the leaf certificate using CRL.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.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 ALBPKIProfile.Builder setCaCerts(java.util.List<ALBSSLCertificate> caCerts)

List of Certificate Authorities (Root and Intermediate) trusted that is used for certificate validation.

Parameters:

caCerts - New value for the property.

setCreatedBy

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

Creator name.

Parameters:

createdBy - New value for the property.

setCrlCheck

public ALBPKIProfile.Builder setCrlCheck(java.lang.Boolean crlCheck)

When enabled, Avi will verify via CRL checks that certificates in the trust chain have not been revoked. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

crlCheck - New value for the property.

setCrls

public ALBPKIProfile.Builder setCrls(java.util.List<ALBCRL> crls)

Certificate Revocation Lists.

Parameters:

crls - New value for the property.

setIgnorePeerChain

public ALBPKIProfile.Builder setIgnorePeerChain(java.lang.Boolean ignorePeerChain)

When enabled, Avi will not trust Intermediate and Root certs presented by a client. Instead, only the chain certs configured in the Certificate Authority section will be used to verify trust of the client's cert. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Special default for Basic edition is true, Essentials edition is true, Enterprise is False. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

ignorePeerChain - New value for the property.

setIsFederated

public ALBPKIProfile.Builder setIsFederated(java.lang.Boolean isFederated)

This field describes the object's replication scope. If the field is set to false, then the object is visible within the controller-cluster and its associated service-engines. If the field is set to true, then the object is replicated across the federation. Default value when not specified in API or module is interpreted by ALB Controller as false.

Parameters:

isFederated - New value for the property.

setMarkers

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

setValidateOnlyLeafCrl

public ALBPKIProfile.Builder setValidateOnlyLeafCrl(java.lang.Boolean validateOnlyLeafCrl)

When enabled, Avi will only validate the revocation status of the leaf certificate using CRL. To enable validation for the entire chain, disable this option and provide all the relevant CRLs. Allowed in Basic(Allowed values- true) edition, Essentials(Allowed values- true) edition, Enterprise edition. Default value when not specified in API or module is interpreted by ALB Controller as true.

Parameters:

validateOnlyLeafCrl - New value for the property.

build

public ALBPKIProfile build()