Package com.vmware.nsx_policy.model
Class GlobalManager.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.GlobalManager.Builder
-
- Enclosing class:
- GlobalManager
public static final class GlobalManager.Builder extends java.lang.Object
Builder class forGlobalManager
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofGlobalManager
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description GlobalManager
build()
GlobalManager.Builder
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.GlobalManager.Builder
setConnectionInfo(java.util.List<SiteNodeConnectionInfo> connectionInfo)
To create a standby GM, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided.GlobalManager.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.GlobalManager.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.GlobalManager.Builder
setDescription(java.lang.String description)
Description of this resourceGlobalManager.Builder
setDisplayName(java.lang.String displayName)
Defaults to ID if not setGlobalManager.Builder
setFailIfRttExceeded(java.lang.Boolean failIfRttExceeded)
Fail onboarding if maximum RTT exceeded.GlobalManager.Builder
setFederationId(java.lang.String federationId)
Internally generated UUID to the federation of Global Manager.GlobalManager.Builder
setId(java.lang.String id)
Unique identifier of this resourceGlobalManager.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.GlobalManager.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.GlobalManager.Builder
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.GlobalManager.Builder
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.GlobalManager.Builder
setMaximumRtt(java.lang.Long maximumRtt)
If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value.GlobalManager.Builder
setMode(java.lang.String mode)
Possible values are:GlobalManager.MODE_ACTIVE
GlobalManager.MODE_STANDBY
There can be at most one ACTIVE global manager and one STANDBY global manager.GlobalManager.Builder
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.GlobalManager.Builder
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.GlobalManager.Builder
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.GlobalManager.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.GlobalManager.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.GlobalManager.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.GlobalManager.Builder
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.GlobalManager.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.GlobalManager.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.GlobalManager.Builder
setResourceType(java.lang.String resourceType)
The type of this resource.GlobalManager.Builder
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.GlobalManager.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.GlobalManager.Builder
setSelf(SelfResourceLink self)
GlobalManager.Builder
setSiteId(java.lang.String siteId)
UUID of the site where Global manager is running.GlobalManager.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.GlobalManager.Builder
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API userGlobalManager.Builder
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofGlobalManager
.
-
-
Method Detail
-
setLinks
public GlobalManager.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 GlobalManager.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 GlobalManager.Builder setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
setRevision
public GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
setDisplayName
public GlobalManager.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
setId
public GlobalManager.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
setResourceType
public GlobalManager.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType
- New value for the property.
-
setTags
public GlobalManager.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
setOriginSiteId
public GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 GlobalManager.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 inChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
setMarkedForDelete
public GlobalManager.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 GlobalManager.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.
-
setConnectionInfo
public GlobalManager.Builder setConnectionInfo(java.util.List<SiteNodeConnectionInfo> connectionInfo)
To create a standby GM, the connection information (username, password, and API thumbprint) for at least one NSX manager node in the remote site must be provided. Once the GM has been successfully onboarded, the connection_info is discarded and authentication to the standby GM occurs using an X.509 client certificate.- Parameters:
connectionInfo
- New value for the property.
-
setFailIfRttExceeded
public GlobalManager.Builder setFailIfRttExceeded(java.lang.Boolean failIfRttExceeded)
Fail onboarding if maximum RTT exceeded.- Parameters:
failIfRttExceeded
- New value for the property.
-
setFederationId
public GlobalManager.Builder setFederationId(java.lang.String federationId)
Internally generated UUID to the federation of Global Manager. 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:
federationId
- New value for the property.
-
setMaximumRtt
public GlobalManager.Builder setMaximumRtt(java.lang.Long maximumRtt)
If provided and fail_if_rtt_exceeded is true, onboarding of the site will fail if measured RTT is greater than this value. format: int64- Parameters:
maximumRtt
- New value for the property.
-
setMode
public GlobalManager.Builder setMode(java.lang.String mode)
Possible values are: There can be at most one ACTIVE global manager and one STANDBY global manager. In order to add a STANDBY manager, there must be an ACTIVE manager defined.- Parameters:
mode
- New value for the property.
-
setSiteId
public GlobalManager.Builder setSiteId(java.lang.String siteId)
UUID of the site where Global manager is running. This is the Site Manager generated UUID for every NSX deployment. 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:
siteId
- New value for the property.
-
build
public GlobalManager build()
-
-