com.vmware.nsx_policy.model

Class PortMirroringProfile.Builder

java.lang.Object

com.vmware.nsx_policy.model.PortMirroringProfile.Builder

Enclosing class:

PortMirroringProfile

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

Builder class for PortMirroringProfile.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PortMirroringProfile	build()
PortMirroringProfile.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
PortMirroringProfile.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.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setDescription(java.lang.String description) Description of this resource
PortMirroringProfile.Builder	setDestinationGroup(java.lang.String destinationGroup) Data from source group will be copied to members of destination group.
PortMirroringProfile.Builder	setDirection(java.lang.String direction) Possible values are: PortMirroringProfile.DIRECTION_INGRESS PortMirroringProfile.DIRECTION_EGRESS PortMirroringProfile.DIRECTION_BIDIRECTIONAL Port mirroring profile direction
PortMirroringProfile.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
PortMirroringProfile.Builder	setEncapsulationType(java.lang.String encapsulationType) Possible values are: PortMirroringProfile.ENCAPSULATION_TYPE_GRE PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_TWO PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_THREE User can provide Mirror Destination type e.g GRE, ERSPAN_TWO or ERSPAN_THREE.If profile type is REMOTE_L3_SPAN, encapsulation type is used else ignored.
PortMirroringProfile.Builder	setErspanId(java.lang.Long erspanId) Used by physical switch for the mirror traffic forwarding.
PortMirroringProfile.Builder	setFilterAction(java.lang.String filterAction) Possible values are: PortMirroringProfile.FILTER_ACTION_INCLUDE PortMirroringProfile.FILTER_ACTION_EXCLUDE If set to INCLUDE, packets matching all filters will be mirrored.
PortMirroringProfile.Builder	setGreKey(java.lang.Long greKey) User-configurable 32-bit key only for GRE format: int32
PortMirroringProfile.Builder	setId(java.lang.String id) Unique identifier of this resource
PortMirroringProfile.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.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
PortMirroringProfile.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
PortMirroringProfile.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
PortMirroringProfile.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
PortMirroringProfile.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
PortMirroringProfile.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.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setPortMirroringFilters(java.util.List<PortMirrorFilter> portMirroringFilters) An array of 5-tuples used to filter packets for the mirror session.
PortMirroringProfile.Builder	setProfileType(java.lang.String profileType) Possible values are: PortMirroringProfile.PROFILE_TYPE_REMOTE_L3_SPAN PortMirroringProfile.PROFILE_TYPE_LOGICAL_SPAN Allows user to select type of port mirroring session.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
PortMirroringProfile.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.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
PortMirroringProfile.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setSelf(SelfResourceLink self)
PortMirroringProfile.Builder	setSnapLength(java.lang.Long snapLength) If this property is set, the packet will be truncated to the provided length.
PortMirroringProfile.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.
PortMirroringProfile.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
PortMirroringProfile.Builder	setTcpIpStack(java.lang.String tcpIpStack) Possible values are: PortMirroringProfile.TCP_IP_STACK_DEFAULT PortMirroringProfile.TCP_IP_STACK_MIRROR User can provide Mirror stack or Default stack to send mirror traffic.
PortMirroringProfile.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 PortMirroringProfile.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setDestinationGroup

public PortMirroringProfile.Builder setDestinationGroup(java.lang.String destinationGroup)

Data from source group will be copied to members of destination group. Only IPSET group and group with membership criteria VM is supported. IPSET group allows only three ip's.

Parameters:

destinationGroup - New value for the property.

setDirection

public PortMirroringProfile.Builder setDirection(java.lang.String direction)

Possible values are:

• PortMirroringProfile.DIRECTION_INGRESS
• PortMirroringProfile.DIRECTION_EGRESS
• PortMirroringProfile.DIRECTION_BIDIRECTIONAL

Port mirroring profile direction

Parameters:

direction - New value for the property.

setEncapsulationType

public PortMirroringProfile.Builder setEncapsulationType(java.lang.String encapsulationType)

Possible values are:

• PortMirroringProfile.ENCAPSULATION_TYPE_GRE
• PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_TWO
• PortMirroringProfile.ENCAPSULATION_TYPE_ERSPAN_THREE

User can provide Mirror Destination type e.g GRE, ERSPAN_TWO or ERSPAN_THREE.If profile type is REMOTE_L3_SPAN, encapsulation type is used else ignored.

Parameters:

encapsulationType - New value for the property.

setErspanId

public PortMirroringProfile.Builder setErspanId(java.lang.Long erspanId)

Used by physical switch for the mirror traffic forwarding. Must be provided and only effective when encapsulation type is ERSPAN type II or type III. format: int32

Parameters:

erspanId - New value for the property.

setFilterAction

public PortMirroringProfile.Builder setFilterAction(java.lang.String filterAction)

Possible values are:

• PortMirroringProfile.FILTER_ACTION_INCLUDE
• PortMirroringProfile.FILTER_ACTION_EXCLUDE

If set to INCLUDE, packets matching all filters will be mirrored. If set to EXCLUDE, packets NOT matching any filters will be mirrored.

Parameters:

filterAction - New value for the property.

setGreKey

public PortMirroringProfile.Builder setGreKey(java.lang.Long greKey)

User-configurable 32-bit key only for GRE format: int32

Parameters:

greKey - New value for the property.

setPortMirroringFilters

public PortMirroringProfile.Builder setPortMirroringFilters(java.util.List<PortMirrorFilter> portMirroringFilters)

An array of 5-tuples used to filter packets for the mirror session. If not provided, all the packets will be mirrored. This field is with filter_action which defines whether packets matching the filter will be included or excluded

Parameters:

portMirroringFilters - New value for the property.

setProfileType

public PortMirroringProfile.Builder setProfileType(java.lang.String profileType)

Possible values are:

• PortMirroringProfile.PROFILE_TYPE_REMOTE_L3_SPAN
• PortMirroringProfile.PROFILE_TYPE_LOGICAL_SPAN

Allows user to select type of port mirroring session.

Parameters:

profileType - New value for the property.

setSnapLength

public PortMirroringProfile.Builder setSnapLength(java.lang.Long snapLength)

If this property is set, the packet will be truncated to the provided length. If this property is unset, entire packet will be mirrored. format: int32

Parameters:

snapLength - New value for the property.

setTcpIpStack

public PortMirroringProfile.Builder setTcpIpStack(java.lang.String tcpIpStack)

Possible values are:

• PortMirroringProfile.TCP_IP_STACK_DEFAULT
• PortMirroringProfile.TCP_IP_STACK_MIRROR

User can provide Mirror stack or Default stack to send mirror traffic. If profile type is REMOTE_L3_SPAN, tcp_ip_stack type is used else ignored.

Parameters:

tcpIpStack - New value for the property.

build

public PortMirroringProfile build()