com.vmware.nsx_policy.model

Class Constraint.Builder

java.lang.Object

com.vmware.nsx_policy.model.Constraint.Builder

Enclosing class:

Constraint

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

Builder class for Constraint.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Constraint	build()
Constraint.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
Constraint.Builder	setConstraintExpression(com.vmware.vapi.bindings.Structure constraintExpression)
Constraint.Builder	setConstraintExpressions(java.util.List<com.vmware.vapi.bindings.Structure> constraintExpressions) Expressions to constrain the target attribute value.
Constraint.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.
Constraint.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.
Constraint.Builder	setDescription(java.lang.String description) Description of this resource
Constraint.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
Constraint.Builder	setId(java.lang.String id) Unique identifier of this resource
Constraint.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.
Constraint.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.
Constraint.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
Constraint.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
Constraint.Builder	setMessage(java.lang.String message) User friendly message to be shown to users upon violation.
Constraint.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
Constraint.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
Constraint.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
Constraint.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.
Constraint.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.
Constraint.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.
Constraint.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
Constraint.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.
Constraint.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.
Constraint.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
Constraint.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
Constraint.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.
Constraint.Builder	setSelf(SelfResourceLink self)
Constraint.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.
Constraint.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
Constraint.Builder	setTarget(ConstraintTarget target)
Constraint.Builder	setTargetOwnerType(java.lang.String targetOwnerType) Possible values are: Constraint.TARGET_OWNER_TYPE_GM Constraint.TARGET_OWNER_TYPE_LM Constraint.TARGET_OWNER_TYPE_ALL Constraint target's owner type
Constraint.Builder	setTargets(java.util.List<ConstraintTarget> targets) Collection of target resources attribute details.
Constraint.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setConstraintExpression

public Constraint.Builder setConstraintExpression(com.vmware.vapi.bindings.Structure constraintExpression)

Parameters:

constraintExpression - 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 ConstraintExpression. When methods return a value of this class as a return value, the property will contain all the properties defined in ConstraintExpression.

setConstraintExpressions

public Constraint.Builder setConstraintExpressions(java.util.List<com.vmware.vapi.bindings.Structure> constraintExpressions)

Expressions to constrain the target attribute value.

Parameters:

constraintExpressions - 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 ConstraintExpression. When methods return a value of this class as a return value, the property will contain all the properties defined in ConstraintExpression.

setMessage

public Constraint.Builder setMessage(java.lang.String message)

User friendly message to be shown to users upon violation.

Parameters:

message - New value for the property.

setTarget

public Constraint.Builder setTarget(ConstraintTarget target)

Parameters:

target - New value for the property.

setTargetOwnerType

public Constraint.Builder setTargetOwnerType(java.lang.String targetOwnerType)

Possible values are:

• Constraint.TARGET_OWNER_TYPE_GM
• Constraint.TARGET_OWNER_TYPE_LM
• Constraint.TARGET_OWNER_TYPE_ALL

Constraint target's owner type

Parameters:

targetOwnerType - New value for the property.

setTargets

public Constraint.Builder setTargets(java.util.List<ConstraintTarget> targets)

Collection of target resources attribute details.

Parameters:

targets - New value for the property.

build

public Constraint build()