com.vmware.nsx.model

Class MetadataProxy.Builder

java.lang.Object

com.vmware.nsx.model.MetadataProxy.Builder

Enclosing class:

MetadataProxy

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

Builder class for MetadataProxy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
MetadataProxy	build()
MetadataProxy.Builder	setAttachedLogicalPortId(java.lang.String attachedLogicalPortId) id of attached logical port This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
MetadataProxy.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.
MetadataProxy.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.
MetadataProxy.Builder	setCryptoProtocols(java.util.List<java.lang.String> cryptoProtocols) Possible values are: MetadataProxy.CRYPTO_PROTOCOLS_V1 MetadataProxy.CRYPTO_PROTOCOLS_V1_1 MetadataProxy.CRYPTO_PROTOCOLS_V1_2 The cryptographic protocols listed here are supported by the metadata proxy.
MetadataProxy.Builder	setDescription(java.lang.String description) Description of this resource
MetadataProxy.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
MetadataProxy.Builder	setEdgeClusterId(java.lang.String edgeClusterId) edge cluster uuid
MetadataProxy.Builder	setEdgeClusterMemberIndexes(java.util.List<java.lang.Long> edgeClusterMemberIndexes) If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster.
MetadataProxy.Builder	setEnableStandbyRelocation(java.lang.Boolean enableStandbyRelocation) Flag to enable the auto-relocation of standby Metadata Proxy in case of edge node failure.
MetadataProxy.Builder	setId(java.lang.String id) Unique identifier of this resource
MetadataProxy.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.
MetadataProxy.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.
MetadataProxy.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
MetadataProxy.Builder	setMetadataServerCaIds(java.util.List<java.lang.String> metadataServerCaIds) The CAs referenced here must be uploaded to the truststore using the API POST /api/v1/trust-management/certificates?action=import.
MetadataProxy.Builder	setMetadataServerUrl(java.lang.String metadataServerUrl) The URL in format scheme://host:port/path.
MetadataProxy.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.
MetadataProxy.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
MetadataProxy.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
MetadataProxy.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.
MetadataProxy.Builder	setSecret(java.lang.String secret) secret to access metadata server
MetadataProxy.Builder	setSelf(SelfResourceLink self)
MetadataProxy.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.
MetadataProxy.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAttachedLogicalPortId

public MetadataProxy.Builder setAttachedLogicalPortId(java.lang.String attachedLogicalPortId)

id of attached logical port 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:

attachedLogicalPortId - New value for the property.

setCryptoProtocols

public MetadataProxy.Builder setCryptoProtocols(java.util.List<java.lang.String> cryptoProtocols)

Possible values are:

• MetadataProxy.CRYPTO_PROTOCOLS_V1
• MetadataProxy.CRYPTO_PROTOCOLS_V1_1
• MetadataProxy.CRYPTO_PROTOCOLS_V1_2

The cryptographic protocols listed here are supported by the metadata proxy. The TLSv1.1 and TLSv1.2 are supported by default.

Parameters:

cryptoProtocols - New value for the property.

setEdgeClusterId

public MetadataProxy.Builder setEdgeClusterId(java.lang.String edgeClusterId)

edge cluster uuid

Parameters:

edgeClusterId - New value for the property.

setEdgeClusterMemberIndexes

public MetadataProxy.Builder setEdgeClusterMemberIndexes(java.util.List<java.lang.Long> edgeClusterMemberIndexes)

If none is provided, the NSX will auto-select two edge-nodes from the given edge cluster. If user provides only one edge node, there will be no HA support. format: int64

Parameters:

edgeClusterMemberIndexes - New value for the property.

setEnableStandbyRelocation

public MetadataProxy.Builder setEnableStandbyRelocation(java.lang.Boolean enableStandbyRelocation)

Flag to enable the auto-relocation of standby Metadata Proxy in case of edge node failure. Only tier 1 and auto placed Metadata Proxy are considered for the relocation.

Parameters:

enableStandbyRelocation - New value for the property.

setMetadataServerCaIds

public MetadataProxy.Builder setMetadataServerCaIds(java.util.List<java.lang.String> metadataServerCaIds)

The CAs referenced here must be uploaded to the truststore using the API POST /api/v1/trust-management/certificates?action=import. User needs to ensure a correct CA for this metedata server is used. The REST API can not detect a wrong CA which was used to verify a different server. If the Metadata Proxy reports an ERROR or NO_BACKUP status, user can check the metadata proxy log at transport node for a possible CA issue.

Parameters:

metadataServerCaIds - New value for the property.

setMetadataServerUrl

public MetadataProxy.Builder setMetadataServerUrl(java.lang.String metadataServerUrl)

The URL in format scheme://host:port/path. Please note, the scheme supports only http and https as of now, port supports range 3000 - 9000, inclusive.

Parameters:

metadataServerUrl - New value for the property.

setSecret

public MetadataProxy.Builder setSecret(java.lang.String secret)

secret to access metadata server

Parameters:

secret - New value for the property.

build

public MetadataProxy build()