com.vmware.nsx_policy.model

Class PolicyDraft.Builder

java.lang.Object

com.vmware.nsx_policy.model.PolicyDraft.Builder

Enclosing class:

PolicyDraft

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

Builder class for PolicyDraft.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PolicyDraft	build()
PolicyDraft.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
PolicyDraft.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.
PolicyDraft.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.
PolicyDraft.Builder	setDescription(java.lang.String description) Description of this resource
PolicyDraft.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
PolicyDraft.Builder	setId(java.lang.String id) Unique identifier of this resource
PolicyDraft.Builder	setIsAutoDraft(java.lang.Boolean isAutoDraft) Flag to indicate whether draft is auto created.
PolicyDraft.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.
PolicyDraft.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.
PolicyDraft.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
PolicyDraft.Builder	setLockComments(java.lang.String lockComments) Comments for a policy draft lock/unlock.
PolicyDraft.Builder	setLocked(java.lang.Boolean locked) Indicates whether a draft should be locked.
PolicyDraft.Builder	setLockModifiedBy(java.lang.String lockModifiedBy) ID of the user who last modified the lock for a policy draft.
PolicyDraft.Builder	setLockModifiedTime(java.lang.Long lockModifiedTime) Policy draft locked/unlocked time in epoch milliseconds.
PolicyDraft.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
PolicyDraft.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
PolicyDraft.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
PolicyDraft.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
PolicyDraft.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.
PolicyDraft.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.
PolicyDraft.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.
PolicyDraft.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
PolicyDraft.Builder	setRefDraftPath(java.lang.String refDraftPath) When specified, a manual draft will be created w.r.t.
PolicyDraft.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.
PolicyDraft.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.
PolicyDraft.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
PolicyDraft.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
PolicyDraft.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.
PolicyDraft.Builder	setSelf(SelfResourceLink self)
PolicyDraft.Builder	setSystemArea(Infra systemArea)
PolicyDraft.Builder	setSystemAreaStoreId(java.lang.String systemAreaStoreId) In case of a large draft, wherein the size of system_area is so big that it can not be stored into one draft object, the data is then gets stored into multiple chunks in a draft data store.
PolicyDraft.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.
PolicyDraft.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
PolicyDraft.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
PolicyDraft.Builder	setUserArea(Infra userArea)
PolicyDraft.Builder	setUserAreaStoreId(java.lang.String userAreaStoreId) In case of a large draft, wherein the size of user_area is so big that it can not be stored into one draft object, the data is then gets stored into multiple chunks in a draft data store.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setIsAutoDraft

public PolicyDraft.Builder setIsAutoDraft(java.lang.Boolean isAutoDraft)

Flag to indicate whether draft is auto created. True indicates that the draft is an auto draft. False indicates that the draft is a manual draft. 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:

isAutoDraft - New value for the property.

setLockComments

public PolicyDraft.Builder setLockComments(java.lang.String lockComments)

Comments for a policy draft lock/unlock.

Parameters:

lockComments - New value for the property.

setLockModifiedBy

public PolicyDraft.Builder setLockModifiedBy(java.lang.String lockModifiedBy)

ID of the user who last modified the lock for a policy draft. 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:

lockModifiedBy - New value for the property.

setLockModifiedTime

public PolicyDraft.Builder setLockModifiedTime(java.lang.Long lockModifiedTime)

Policy draft locked/unlocked time in epoch milliseconds. 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:

lockModifiedTime - New value for the property.

setLocked

public PolicyDraft.Builder setLocked(java.lang.Boolean locked)

Indicates whether a draft should be locked. If the draft is locked by an user, then no other user would be able to modify or publish this draft. Once the user releases the lock, other users can then modify or publish this draft.

Parameters:

locked - New value for the property.

setRefDraftPath

public PolicyDraft.Builder setRefDraftPath(java.lang.String refDraftPath)

When specified, a manual draft will be created w.r.t. the specified draft. If not specified, manual draft will be created w.r.t. the current published configuration. For an auto draft, this will always be null.

Parameters:

refDraftPath - New value for the property.

setSystemArea

public PolicyDraft.Builder setSystemArea(Infra systemArea)

Parameters:

systemArea - New value for the property.

setSystemAreaStoreId

public PolicyDraft.Builder setSystemAreaStoreId(java.lang.String systemAreaStoreId)

In case of a large draft, wherein the size of system_area is so big that it can not be stored into one draft object, the data is then gets stored into multiple chunks in a draft data store. This value represents the ID of that data store. 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:

systemAreaStoreId - New value for the property.

setUserArea

public PolicyDraft.Builder setUserArea(Infra userArea)

Parameters:

userArea - New value for the property.

setUserAreaStoreId

public PolicyDraft.Builder setUserAreaStoreId(java.lang.String userAreaStoreId)

In case of a large draft, wherein the size of user_area is so big that it can not be stored into one draft object, the data is then gets stored into multiple chunks in a draft data store. This value represents the ID of that data store. 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:

userAreaStoreId - New value for the property.

build

public PolicyDraft build()