Package com.vmware.nsx_policy.model
Class TraceflowConfig.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.TraceflowConfig.Builder
-
- Enclosing class:
- TraceflowConfig
public static final class TraceflowConfig.Builder extends java.lang.Object
Builder class forTraceflowConfig
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofTraceflowConfig
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TraceflowConfig
build()
TraceflowConfig.Builder
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.TraceflowConfig.Builder
setConnectedParentPathAsSource(java.lang.String connectedParentPathAsSource)
Policy path of child segment connected to container port.TraceflowConfig.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.TraceflowConfig.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.TraceflowConfig.Builder
setDescription(java.lang.String description)
Description of this resourceTraceflowConfig.Builder
setDisplayName(java.lang.String displayName)
Defaults to ID if not setTraceflowConfig.Builder
setId(java.lang.String id)
Unique identifier of this resourceTraceflowConfig.Builder
setIsTransient(java.lang.Boolean isTransient)
This field indicates if intent is transient and will be cleaned up by the system if set to trueTraceflowConfig.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.TraceflowConfig.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.TraceflowConfig.Builder
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.TraceflowConfig.Builder
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.TraceflowConfig.Builder
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.TraceflowConfig.Builder
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.TraceflowConfig.Builder
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.TraceflowConfig.Builder
setPacket(com.vmware.vapi.bindings.Structure packet)
TraceflowConfig.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.TraceflowConfig.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.TraceflowConfig.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.TraceflowConfig.Builder
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.TraceflowConfig.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.TraceflowConfig.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.TraceflowConfig.Builder
setResourceType(java.lang.String resourceType)
The type of this resource.TraceflowConfig.Builder
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.TraceflowConfig.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.TraceflowConfig.Builder
setSegmentPortPath(java.lang.String segmentPortPath)
Policy path or UUID of segment port to start traceflow from.TraceflowConfig.Builder
setSelf(SelfResourceLink self)
TraceflowConfig.Builder
setSourceId(java.lang.String sourceId)
Policy path or UUID (validated for syntax only) of segment port to start traceflow from.TraceflowConfig.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.TraceflowConfig.Builder
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API userTraceflowConfig.Builder
setTimeout(java.lang.Long timeout)
Maximum time in seconds the management plane will wait for observation result to be generated.TraceflowConfig.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 ofTraceflowConfig
.
-
-
Method Detail
-
setLinks
public TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.Builder setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
setRevision
public TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
setDisplayName
public TraceflowConfig.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
setId
public TraceflowConfig.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
setResourceType
public TraceflowConfig.Builder setResourceType(java.lang.String resourceType)
The type of this resource.- Parameters:
resourceType
- New value for the property.
-
setTags
public TraceflowConfig.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
setOriginSiteId
public TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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 TraceflowConfig.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.
-
setConnectedParentPathAsSource
public TraceflowConfig.Builder setConnectedParentPathAsSource(java.lang.String connectedParentPathAsSource)
Policy path of child segment connected to container port. Child segment connection is configured through SegmentConnectionBindingMapDto. This field should be provided only when source_id/segment_port_path is a VIF attached port on the parent segment.- Parameters:
connectedParentPathAsSource
- New value for the property.
-
setIsTransient
public TraceflowConfig.Builder setIsTransient(java.lang.Boolean isTransient)
This field indicates if intent is transient and will be cleaned up by the system if set to true- Parameters:
isTransient
- New value for the property.
-
setPacket
public TraceflowConfig.Builder setPacket(com.vmware.vapi.bindings.Structure packet)
- Parameters:
packet
- New value for the property. When clients pass a value of this class as a parameter, the property must contain all the properties defined inPacketData
. When methods return a value of this class as a return value, the property will contain all the properties defined inPacketData
.
-
setSegmentPortPath
public TraceflowConfig.Builder setSegmentPortPath(java.lang.String segmentPortPath)
Policy path or UUID of segment port to start traceflow from. Auto-plumbed ports don't have corresponding policy path. Ports auto-created by policy as part of connecting segment to Tier-0 or Tier-1 or DHCP server cannot be used. UUID is validated for syntax only. This configuration will be cleaned up by the system after two hours of inactivity.- Parameters:
segmentPortPath
- New value for the property.
-
setSourceId
public TraceflowConfig.Builder setSourceId(java.lang.String sourceId)
Policy path or UUID (validated for syntax only) of segment port to start traceflow from. Auto-plumbed ports don't have corresponding policy path. Both overlay backed port and VLAN backed port are supported.- Parameters:
sourceId
- New value for the property.
-
setTimeout
public TraceflowConfig.Builder setTimeout(java.lang.Long timeout)
Maximum time in seconds the management plane will wait for observation result to be generated. The default, minimum and maximum timeout values, in seconds, for: Single site environment - minimum 5, default 10, maximum 15. Federated enviroment - minimum 15, default 30, maximum 60. These values are validated by the system based on type of environment. format: int64- Parameters:
timeout
- New value for the property.
-
build
public TraceflowConfig build()
-
-