LBClientSslProfile.Builder (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.LBClientSslProfile.Builder

Enclosing class:: LBClientSslProfile

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

Builder class for LBClientSslProfile.

Constructor Summary

Constructors
Constructor and Description

Builder()
Constructor with parameters for the required properties of LBClientSslProfile.

Constructors
Constructor and Description
`Builder()` Constructor with parameters for the required properties of `LBClientSslProfile`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`LBClientSslProfile`	`build()`
`LBClientSslProfile.Builder`	`setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)` Subtree for this type within policy tree containing nested elements.
`LBClientSslProfile.Builder`	`setCipherGroupLabel(java.lang.String cipherGroupLabel)` Possible values are: `LBClientSslProfile.CIPHER_GROUP_LABEL_BALANCED` `LBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_SECURITY` `LBClientSslProfile.CIPHER_GROUP_LABEL_HIGH_COMPATIBILITY` `LBClientSslProfile.CIPHER_GROUP_LABEL_CUSTOM` It is a label of cipher group which is mostly consumed by GUI.
`LBClientSslProfile.Builder`	`setCiphers(java.util.List<java.lang.String> ciphers)` Possible values are: `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_GCM_SHA256` `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_GCM_SHA384` `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA` `LBClientSslProfile.CIPHERS_RSA_WITH_3DES_EDE_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_128_CBC_SHA256` `LBClientSslProfile.CIPHERS_ECDHE_RSA_WITH_AES_256_CBC_SHA384` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_CBC_SHA256` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_128_GCM_SHA256` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_CBC_SHA256` `LBClientSslProfile.CIPHERS_RSA_WITH_AES_256_GCM_SHA384` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384` `LBClientSslProfile.CIPHERS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384` `LBClientSslProfile.CIPHERS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_CBC_SHA256` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_128_GCM_SHA256` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_CBC_SHA384` `LBClientSslProfile.CIPHERS_ECDH_RSA_WITH_AES_256_GCM_SHA384` Supported SSL cipher list to client side.
`LBClientSslProfile.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.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setDescription(java.lang.String description)` Description of this resource
`LBClientSslProfile.Builder`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`LBClientSslProfile.Builder`	`setId(java.lang.String id)` Unique identifier of this resource
`LBClientSslProfile.Builder`	`setIsFips(java.lang.Boolean isFips)` This flag is set to true when all the ciphers and protocols are FIPS compliant.
`LBClientSslProfile.Builder`	`setIsSecure(java.lang.Boolean isSecure)` This flag is set to true when all the ciphers and protocols are secure.
`LBClientSslProfile.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.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`LBClientSslProfile.Builder`	`setMarkedForDelete(java.lang.Boolean markedForDelete)` Intent objects are not directly deleted from the system when a delete is invoked on them.
`LBClientSslProfile.Builder`	`setOriginSiteId(java.lang.String originSiteId)` This is a UUID generated by the system for knowing which site owns an object.
`LBClientSslProfile.Builder`	`setOverridden(java.lang.Boolean overridden)` Global intent objects cannot be modified by the user.
`LBClientSslProfile.Builder`	`setOwnerId(java.lang.String ownerId)` This is a UUID generated by the system for knowing who owns this object.
`LBClientSslProfile.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.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setPreferServerCiphers(java.lang.Boolean preferServerCiphers)` During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setProtocols(java.util.List<java.lang.String> protocols)` Possible values are: `LBClientSslProfile.PROTOCOLS_SSL_V2` `LBClientSslProfile.PROTOCOLS_SSL_V3` `LBClientSslProfile.PROTOCOLS_TLS_V1` `LBClientSslProfile.PROTOCOLS_TLS_V1_1` `LBClientSslProfile.PROTOCOLS_TLS_V1_2` SSL versions TLS1.1 and TLS1.2 are supported and activated by default.
`LBClientSslProfile.Builder`	`setRealizationId(java.lang.String realizationId)` This is a UUID generated by the system for realizing the entity object.
`LBClientSslProfile.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.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`LBClientSslProfile.Builder`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setSelf(SelfResourceLink self)`
`LBClientSslProfile.Builder`	`setSessionCacheEnabled(java.lang.Boolean sessionCacheEnabled)` SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.
`LBClientSslProfile.Builder`	`setSessionCacheTimeout(java.lang.Long sessionCacheTimeout)` Session cache timeout specifies how long the SSL session parameters are held on to and can be reused.
`LBClientSslProfile.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.
`LBClientSslProfile.Builder`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`LBClientSslProfile.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 LBClientSslProfile.
- Method Detail
  - setLinks
```
public LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.Builder setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - setRevision
```
public LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.Builder setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - setDisplayName
```
public LBClientSslProfile.Builder setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - setId
```
public LBClientSslProfile.Builder setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - setResourceType
```
public LBClientSslProfile.Builder setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - setTags
```
public LBClientSslProfile.Builder setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - setOriginSiteId
```
public LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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 LBClientSslProfile.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.
  - setCipherGroupLabel
```
public LBClientSslProfile.Builder setCipherGroupLabel(java.lang.String cipherGroupLabel)
```
    Possible values are:
    It is a label of cipher group which is mostly consumed by GUI.
    Parameters:
    
    cipherGroupLabel - New value for the property.
  - setCiphers
```
public LBClientSslProfile.Builder setCiphers(java.util.List<java.lang.String> ciphers)
```
    Possible values are:
    Supported SSL cipher list to client side.
    Parameters:
    
    ciphers - New value for the property.
  - setIsFips
```
public LBClientSslProfile.Builder setIsFips(java.lang.Boolean isFips)
```
    This flag is set to true when all the ciphers and protocols are FIPS compliant. It is set to false when one of the ciphers or protocols are not FIPS compliant.. 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:
    
    isFips - New value for the property.
  - setIsSecure
```
public LBClientSslProfile.Builder setIsSecure(java.lang.Boolean isSecure)
```
    This flag is set to true when all the ciphers and protocols are secure. It is set to false when one of the ciphers or protocols is insecure. 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:
    
    isSecure - New value for the property.
  - setPreferServerCiphers
```
public LBClientSslProfile.Builder setPreferServerCiphers(java.lang.Boolean preferServerCiphers)
```
    During SSL handshake as part of the SSL client Hello client sends an ordered list of ciphers that it can support (or prefers) and typically server selects the first one from the top of that list it can also support. For Perfect Forward Secrecy(PFS), server could override the client's preference.
    
    Parameters:
    
    preferServerCiphers - New value for the property.
  - setProtocols
```
public LBClientSslProfile.Builder setProtocols(java.util.List<java.lang.String> protocols)
```
    Possible values are:
    SSL versions TLS1.1 and TLS1.2 are supported and activated by default. SSLv2, SSLv3, and TLS1.0 are supported, but deactivated by default.
    Parameters:
    
    protocols - New value for the property.
  - setSessionCacheEnabled
```
public LBClientSslProfile.Builder setSessionCacheEnabled(java.lang.Boolean sessionCacheEnabled)
```
    SSL session caching allows SSL client and server to reuse previously negotiated security parameters avoiding the expensive public key operation during handshake.
    
    Parameters:
    
    sessionCacheEnabled - New value for the property.
  - setSessionCacheTimeout
```
public LBClientSslProfile.Builder setSessionCacheTimeout(java.lang.Long sessionCacheTimeout)
```
    Session cache timeout specifies how long the SSL session parameters are held on to and can be reused. format: int64
    
    Parameters:
    
    sessionCacheTimeout - New value for the property.
  - build
```
public LBClientSslProfile build()
```

Class LBClientSslProfile.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setLinks

setSchema

setSelf

setRevision

setCreateTime

setCreateUser

setLastModifiedTime

setLastModifiedUser

setProtection

setSystemOwned

setDescription

setDisplayName

setId

setResourceType

setTags

setOriginSiteId

setOwnerId

setParentPath

setPath

setRealizationId

setRelativePath

setRemotePath

setUniqueId

setChildren

setMarkedForDelete

setOverridden

setCipherGroupLabel

setCiphers

setIsFips

setIsSecure

setPreferServerCiphers

setProtocols

setSessionCacheEnabled

setSessionCacheTimeout

build