Package com.vmware.nsx_policy.model
Class SharedResource.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.SharedResource.Builder
-
- Enclosing class:
- SharedResource
public static final class SharedResource.Builder extends java.lang.ObjectBuilder class forSharedResource.
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructor with parameters for the required properties ofSharedResource.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SharedResourcebuild()SharedResource.BuildersetChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)Subtree for this type within policy tree containing nested elements.SharedResource.BuildersetCreateTime(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.SharedResource.BuildersetCreateUser(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.SharedResource.BuildersetDescription(java.lang.String description)Description of this resourceSharedResource.BuildersetDisplayName(java.lang.String displayName)Defaults to ID if not setSharedResource.BuildersetId(java.lang.String id)Unique identifier of this resourceSharedResource.BuildersetLastModifiedTime(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.SharedResource.BuildersetLastModifiedUser(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.SharedResource.BuildersetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.SharedResource.BuildersetMarkedForDelete(java.lang.Boolean markedForDelete)Intent objects are not directly deleted from the system when a delete is invoked on them.SharedResource.BuildersetOriginSiteId(java.lang.String originSiteId)This is a UUID generated by the system for knowing which site owns an object.SharedResource.BuildersetOverridden(java.lang.Boolean overridden)Global intent objects cannot be modified by the user.SharedResource.BuildersetOwnerId(java.lang.String ownerId)This is a UUID generated by the system for knowing who owns this object.SharedResource.BuildersetParentPath(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.SharedResource.BuildersetPath(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.SharedResource.BuildersetProtection(java.lang.String protection)Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.SharedResource.BuildersetRealizationId(java.lang.String realizationId)This is a UUID generated by the system for realizing the entity object.SharedResource.BuildersetRelativePath(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.SharedResource.BuildersetRemotePath(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.SharedResource.BuildersetResourceObjects(java.util.List<ResourceObject> resourceObjects)Represents the path and other properties of the resource to be shared.SharedResource.BuildersetResourceType(java.lang.String resourceType)The type of this resource.SharedResource.BuildersetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.SharedResource.BuildersetSchema(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.SharedResource.BuildersetSelf(SelfResourceLink self)SharedResource.BuildersetShareSharedWith(java.util.List<java.lang.String> shareSharedWith)Read only field.SharedResource.BuildersetShareSharingStrategy(java.lang.String shareSharingStrategy)Read only field.SharedResource.BuildersetSystemOwned(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.SharedResource.BuildersetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API userSharedResource.BuildersetUniqueId(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 ofSharedResource.
-
-
Method Detail
-
setLinks
public SharedResource.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 SharedResource.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 SharedResource.Builder setSelf(SelfResourceLink self)
- Parameters:
self- New value for the property.
-
setRevision
public SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description- New value for the property.
-
setDisplayName
public SharedResource.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName- New value for the property.
-
setId
public SharedResource.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id- New value for the property.
-
setResourceType
public SharedResource.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType- New value for the property.
-
setTags
public SharedResource.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags- New value for the property.
-
setOriginSiteId
public SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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 SharedResource.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.
-
setResourceObjects
public SharedResource.Builder setResourceObjects(java.util.List<ResourceObject> resourceObjects)
Represents the path and other properties of the resource to be shared. The entity represented by this shared resource is shared with all the Orgs or Projects contexts that the Share container references.- Parameters:
resourceObjects- New value for the property.
-
setShareSharedWith
public SharedResource.Builder setShareSharedWith(java.util.List<java.lang.String> shareSharedWith)
Read only field. Shows subset (shared-with-me API context) of sharedWith used in Share. 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:
shareSharedWith- New value for the property.
-
setShareSharingStrategy
public SharedResource.Builder setShareSharingStrategy(java.lang.String shareSharingStrategy)
Read only field. Shows sharing strategy used in Share. 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:
shareSharingStrategy- New value for the property.
-
build
public SharedResource build()
-
-