Package com.vmware.nsx_policy.model
Class PolicyCustomAttributes.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.PolicyCustomAttributes.Builder
-
- Enclosing class:
- PolicyCustomAttributes
public static final class PolicyCustomAttributes.Builder extends java.lang.ObjectBuilder class forPolicyCustomAttributes.
-
-
Constructor Summary
Constructors Constructor Description Builder()Constructor with parameters for the required properties ofPolicyCustomAttributes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PolicyCustomAttributesbuild()PolicyCustomAttributes.BuildersetAttributeSource(java.lang.String attributeSource)Possible values are:PolicyCustomAttributes.ATTRIBUTE_SOURCE_CUSTOMPolicyCustomAttributes.ATTRIBUTE_SOURCE_SYSTEMSource of attribute value i.e whether system defined or custom valuePolicyCustomAttributes.BuildersetChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)Subtree for this type within policy tree containing nested elements.PolicyCustomAttributes.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.PolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetDatatype(java.lang.String datatype)Possible values are:PolicyCustomAttributes.DATATYPE_STRINGDatatype for attributePolicyCustomAttributes.BuildersetDescription(java.lang.String description)Description for attribute valuePolicyCustomAttributes.BuildersetDisplayName(java.lang.String displayName)Defaults to ID if not setPolicyCustomAttributes.BuildersetId(java.lang.String id)Unique identifier of this resourcePolicyCustomAttributes.BuildersetKey(java.lang.String key)Possible values are:PolicyCustomAttributes.KEY_DOMAIN_NAMEPolicyCustomAttributes.KEY_CUSTOM_URLPolicy Custom Attribute KeyPolicyCustomAttributes.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.PolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetLinks(java.util.List<ResourceLink> links)The server will populate this field when returing the resource.PolicyCustomAttributes.BuildersetMarkedForDelete(java.lang.Boolean markedForDelete)Intent objects are not directly deleted from the system when a delete is invoked on them.PolicyCustomAttributes.BuildersetMetadata(java.util.List<ContextProfileAttributesMetadata> metadata)This is optional part that can hold additional data about the attribute key/values.PolicyCustomAttributes.BuildersetOriginSiteId(java.lang.String originSiteId)This is a UUID generated by the system for knowing which site owns an object.PolicyCustomAttributes.BuildersetOverridden(java.lang.Boolean overridden)Global intent objects cannot be modified by the user.PolicyCustomAttributes.BuildersetOwnerId(java.lang.String ownerId)This is a UUID generated by the system for knowing who owns this object.PolicyCustomAttributes.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.PolicyCustomAttributes.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.PolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetRealizationId(java.lang.String realizationId)This is a UUID generated by the system for realizing the entity object.PolicyCustomAttributes.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.PolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetResourceType(java.lang.String resourceType)The type of this resource.PolicyCustomAttributes.BuildersetRevision(java.lang.Long revision)The _revision property describes the current revision of the resource.PolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetSelf(SelfResourceLink self)PolicyCustomAttributes.BuildersetSubAttributes(java.util.List<PolicySubAttributes> subAttributes)Reference to sub attributes for the attributePolicyCustomAttributes.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.PolicyCustomAttributes.BuildersetTags(java.util.List<Tag> tags)Opaque identifiers meaningful to the API userPolicyCustomAttributes.BuildersetUniqueId(java.lang.String uniqueId)This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.PolicyCustomAttributes.BuildersetValue(java.util.List<java.lang.String> value)Multiple attribute values can be specified as elements of array.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofPolicyCustomAttributes.
-
-
Method Detail
-
setLinks
public PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.Builder setSelf(SelfResourceLink self)
- Parameters:
self- New value for the property.
-
setRevision
public PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.Builder setDescription(java.lang.String description)
Description for attribute value- Parameters:
description- New value for the property.
-
setDisplayName
public PolicyCustomAttributes.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName- New value for the property.
-
setId
public PolicyCustomAttributes.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id- New value for the property.
-
setResourceType
public PolicyCustomAttributes.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType- New value for the property.
-
setTags
public PolicyCustomAttributes.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags- New value for the property.
-
setOriginSiteId
public PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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 PolicyCustomAttributes.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.
-
setAttributeSource
public PolicyCustomAttributes.Builder setAttributeSource(java.lang.String attributeSource)
Possible values are: Source of attribute value i.e whether system defined or custom value- Parameters:
attributeSource- New value for the property.
-
setDatatype
public PolicyCustomAttributes.Builder setDatatype(java.lang.String datatype)
Possible values are: Datatype for attribute- Parameters:
datatype- New value for the property.
-
setKey
public PolicyCustomAttributes.Builder setKey(java.lang.String key)
Possible values are: Policy Custom Attribute Key- Parameters:
key- New value for the property.
-
setMetadata
public PolicyCustomAttributes.Builder setMetadata(java.util.List<ContextProfileAttributesMetadata> metadata)
This is optional part that can hold additional data about the attribute key/values. Example - For Custom URL key , it specified url type for url value. This is generic array and can hold multiple meta information about key/values in future- Parameters:
metadata- New value for the property.
-
setSubAttributes
public PolicyCustomAttributes.Builder setSubAttributes(java.util.List<PolicySubAttributes> subAttributes)
Reference to sub attributes for the attribute- Parameters:
subAttributes- New value for the property.
-
setValue
public PolicyCustomAttributes.Builder setValue(java.util.List<java.lang.String> value)
Multiple attribute values can be specified as elements of array.- Parameters:
value- New value for the property.
-
build
public PolicyCustomAttributes build()
-
-