Package com.vmware.nsx_policy.model
Class PolicyServiceChain.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.PolicyServiceChain.Builder
-
- Enclosing class:
- PolicyServiceChain
public static final class PolicyServiceChain.Builder extends java.lang.Object
Builder class forPolicyServiceChain
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofPolicyServiceChain
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description PolicyServiceChain
build()
PolicyServiceChain.Builder
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.PolicyServiceChain.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.PolicyServiceChain.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.PolicyServiceChain.Builder
setDescription(java.lang.String description)
Description of this resourcePolicyServiceChain.Builder
setDisplayName(java.lang.String displayName)
Defaults to ID if not setPolicyServiceChain.Builder
setFailurePolicy(java.lang.String failurePolicy)
Possible values are:PolicyServiceChain.FAILURE_POLICY_ALLOW
PolicyServiceChain.FAILURE_POLICY_BLOCK
Failure policy for the service defines the action to be taken i.e to allow or to block the traffic during failure scenarios.PolicyServiceChain.Builder
setForwardPathServiceProfiles(java.util.List<java.lang.String> forwardPathServiceProfiles)
Forward path service profiles are applied to ingress traffic.PolicyServiceChain.Builder
setId(java.lang.String id)
Unique identifier of this resourcePolicyServiceChain.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.PolicyServiceChain.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.PolicyServiceChain.Builder
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.PolicyServiceChain.Builder
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.PolicyServiceChain.Builder
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.PolicyServiceChain.Builder
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.PolicyServiceChain.Builder
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.PolicyServiceChain.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.PolicyServiceChain.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.PolicyServiceChain.Builder
setPathSelectionPolicy(java.lang.String pathSelectionPolicy)
Possible values are:PolicyServiceChain.PATH_SELECTION_POLICY_ANY
PolicyServiceChain.PATH_SELECTION_POLICY_LOCAL
PolicyServiceChain.PATH_SELECTION_POLICY_REMOTE
PolicyServiceChain.PATH_SELECTION_POLICY_ROUND_ROBIN
Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning.PolicyServiceChain.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.PolicyServiceChain.Builder
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.PolicyServiceChain.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.PolicyServiceChain.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.PolicyServiceChain.Builder
setResourceType(java.lang.String resourceType)
The type of this resource.PolicyServiceChain.Builder
setReversePathServiceProfiles(java.util.List<java.lang.String> reversePathServiceProfiles)
Reverse path service profiles are applied to egress traffic and is optional.PolicyServiceChain.Builder
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.PolicyServiceChain.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.PolicyServiceChain.Builder
setSelf(SelfResourceLink self)
PolicyServiceChain.Builder
setServiceSegmentPath(java.util.List<java.lang.String> serviceSegmentPath)
Path to service segment using which the traffic needs to be redirected.PolicyServiceChain.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.PolicyServiceChain.Builder
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API userPolicyServiceChain.Builder
setUniqueId(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 ofPolicyServiceChain
.
-
-
Method Detail
-
setLinks
public PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.Builder setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
setRevision
public PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
setDisplayName
public PolicyServiceChain.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
setId
public PolicyServiceChain.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
setResourceType
public PolicyServiceChain.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType
- New value for the property.
-
setTags
public PolicyServiceChain.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
setOriginSiteId
public PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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 PolicyServiceChain.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.
-
setFailurePolicy
public PolicyServiceChain.Builder setFailurePolicy(java.lang.String failurePolicy)
Possible values are: Failure policy for the service defines the action to be taken i.e to allow or to block the traffic during failure scenarios.- Parameters:
failurePolicy
- New value for the property.
-
setForwardPathServiceProfiles
public PolicyServiceChain.Builder setForwardPathServiceProfiles(java.util.List<java.lang.String> forwardPathServiceProfiles)
Forward path service profiles are applied to ingress traffic.- Parameters:
forwardPathServiceProfiles
- New value for the property.
-
setPathSelectionPolicy
public PolicyServiceChain.Builder setPathSelectionPolicy(java.lang.String pathSelectionPolicy)
Possible values are: Path selection policy can be - ANY - Service Insertion is free to redirect to any service path regardless of any load balancing considerations or flow pinning. LOCAL - Preference to be given to local service insances. REMOTE - Preference to be given to the SVM co-located on the same host. ROUND_ROBIN - All active service paths are hit with equal probability.- Parameters:
pathSelectionPolicy
- New value for the property.
-
setReversePathServiceProfiles
public PolicyServiceChain.Builder setReversePathServiceProfiles(java.util.List<java.lang.String> reversePathServiceProfiles)
Reverse path service profiles are applied to egress traffic and is optional. 2 different set of profiles can be defined for forward and reverse path. If not defined, the reverse of the forward path service profile is applied.- Parameters:
reversePathServiceProfiles
- New value for the property.
-
setServiceSegmentPath
public PolicyServiceChain.Builder setServiceSegmentPath(java.util.List<java.lang.String> serviceSegmentPath)
Path to service segment using which the traffic needs to be redirected.- Parameters:
serviceSegmentPath
- New value for the property.
-
build
public PolicyServiceChain build()
-
-