com.vmware.nsx_policy.model

Class VMTagReplicationPolicy.Builder

java.lang.Object

com.vmware.nsx_policy.model.VMTagReplicationPolicy.Builder

Enclosing class:

VMTagReplicationPolicy

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

Builder class for VMTagReplicationPolicy.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
VMTagReplicationPolicy	build()
VMTagReplicationPolicy.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setDescription(java.lang.String description) Description of this resource
VMTagReplicationPolicy.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
VMTagReplicationPolicy.Builder	setGroups(java.util.List<java.lang.String> groups) Paths of groups (VM tag-based, VM name-based, etc.) that translates into VMs to be replicated from protected site to recovery sites.
VMTagReplicationPolicy.Builder	setId(java.lang.String id) Unique identifier of this resource
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
VMTagReplicationPolicy.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
VMTagReplicationPolicy.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
VMTagReplicationPolicy.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
VMTagReplicationPolicy.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setProtectedSite(java.lang.String protectedSite) A path of protected site, from where tags of selected VMs will be replicated to recovery sites.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
VMTagReplicationPolicy.Builder	setRecoverySites(java.util.List<java.lang.String> recoverySites) Paths of recovery sites, where tags of selected VMs will be replicated to, from protected site.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setReplicationType(java.lang.String replicationType) Possible values are: VMTagReplicationPolicy.REPLICATION_TYPE_VSPHERE_REPLICATION VMTagReplicationPolicy.REPLICATION_TYPE_STORAGE_ARRAY_REPLICATION VMTagReplicationPolicy.REPLICATION_TYPE_OTHER Specifies type of replication used in DR (Disaster Recovery) failover.
VMTagReplicationPolicy.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
VMTagReplicationPolicy.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setSelf(SelfResourceLink self)
VMTagReplicationPolicy.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.
VMTagReplicationPolicy.Builder	setTagDelayDeleteTime(java.lang.Long tagDelayDeleteTime) This specifies delay in minutes which is used for deletion of tags of virtual machines on recovery site.
VMTagReplicationPolicy.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
VMTagReplicationPolicy.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
VMTagReplicationPolicy.Builder	setVmMatchCriteria(java.lang.String vmMatchCriteria) Possible values are: VMTagReplicationPolicy.VM_MATCH_CRITERIA_NSX_ATTACHMENT_ID VMTagReplicationPolicy.VM_MATCH_CRITERIA_BIOS_UUID_NAME Matching criteria used for associating VMs from protected site to VMs on recovery sites.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setGroups

public VMTagReplicationPolicy.Builder setGroups(java.util.List<java.lang.String> groups)

Paths of groups (VM tag-based, VM name-based, etc.) that translates into VMs to be replicated from protected site to recovery sites. If no group is specified, none of the VM tag will be replicated from protected site to recovery sites.

Parameters:

groups - New value for the property.

setProtectedSite

public VMTagReplicationPolicy.Builder setProtectedSite(java.lang.String protectedSite)

A path of protected site, from where tags of selected VMs will be replicated to recovery sites.

Parameters:

protectedSite - New value for the property.

setRecoverySites

public VMTagReplicationPolicy.Builder setRecoverySites(java.util.List<java.lang.String> recoverySites)

Paths of recovery sites, where tags of selected VMs will be replicated to, from protected site.

Parameters:

recoverySites - New value for the property.

setReplicationType

public VMTagReplicationPolicy.Builder setReplicationType(java.lang.String replicationType)

Possible values are:

• VMTagReplicationPolicy.REPLICATION_TYPE_VSPHERE_REPLICATION
• VMTagReplicationPolicy.REPLICATION_TYPE_STORAGE_ARRAY_REPLICATION
• VMTagReplicationPolicy.REPLICATION_TYPE_OTHER

Specifies type of replication used in DR (Disaster Recovery) failover.

Parameters:

replicationType - New value for the property.

setTagDelayDeleteTime

public VMTagReplicationPolicy.Builder setTagDelayDeleteTime(java.lang.Long tagDelayDeleteTime)

This specifies delay in minutes which is used for deletion of tags of virtual machines on recovery site. If a VM is deleted on protected site and has not appeared on recovery site (e.g. this can happen primarily when array based storage replication is used with SRM and DR failover is run while protected site is reachable), the tags will be retained for this much amount of time on recovery site. VM appears within this much time on recovery site, then tags will get applied on recovery site. If replication type is VSPHERE_REPLICATION or OTHER, then its default value is 0 minutes. If replication type is STORAGE_ARRAY_REPLICATION, then its default value is 30 minutes. If this value is not specified, then default value according to replication type will be applicable. The time for virtual machines to appear on recovery site after those are deleted from primary site in case of storage replication depends on count of virtual machines configured to failover, storage array performance and ESXi host. format: int64

Parameters:

tagDelayDeleteTime - New value for the property.

setVmMatchCriteria

public VMTagReplicationPolicy.Builder setVmMatchCriteria(java.lang.String vmMatchCriteria)

Possible values are:

• VMTagReplicationPolicy.VM_MATCH_CRITERIA_NSX_ATTACHMENT_ID
• VMTagReplicationPolicy.VM_MATCH_CRITERIA_BIOS_UUID_NAME

Matching criteria used for associating VMs from protected site to VMs on recovery sites. - MATCH_NSX_ATTACHMENT_ID : Associate VMs from the protected site and recovery sites based on NSX attachment ID. - MATCH_BIOS_UUID_NAME : Associate VMs from the protected site and recovery sites based on (VM BIOS UUID + VM Name).

Parameters:

vmMatchCriteria - New value for the property.

build

public VMTagReplicationPolicy build()