com.vmware.nsx_global_policy.model

Class CommunicationEntry.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.CommunicationEntry.Builder

Enclosing class:

CommunicationEntry

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

Builder class for CommunicationEntry.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CommunicationEntry	build()
CommunicationEntry.Builder	setAction(java.lang.String action) Possible values are: CommunicationEntry.ACTION_ALLOW CommunicationEntry.ACTION_DROP CommunicationEntry.ACTION_REJECT The action to be applied to all the services.
CommunicationEntry.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
CommunicationEntry.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.
CommunicationEntry.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.
CommunicationEntry.Builder	setDescription(java.lang.String description) Description of this resource
CommunicationEntry.Builder	setDestinationGroups(java.util.List<java.lang.String> destinationGroups) We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant \"ANY\".
CommunicationEntry.Builder	setDirection(java.lang.String direction) Possible values are: CommunicationEntry.DIRECTION_IN CommunicationEntry.DIRECTION_OUT CommunicationEntry.DIRECTION_IN_OUT Define direction of traffic.
CommunicationEntry.Builder	setDisabled(java.lang.Boolean disabled) Flag to disable the rule.
CommunicationEntry.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
CommunicationEntry.Builder	setId(java.lang.String id) Unique identifier of this resource
CommunicationEntry.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.
CommunicationEntry.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.
CommunicationEntry.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
CommunicationEntry.Builder	setLogged(java.lang.Boolean logged) Flag to enable packet logging.
CommunicationEntry.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
CommunicationEntry.Builder	setNotes(java.lang.String notes) Text for additional notes on changes.
CommunicationEntry.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
CommunicationEntry.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
CommunicationEntry.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
CommunicationEntry.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.
CommunicationEntry.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.
CommunicationEntry.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.
CommunicationEntry.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
CommunicationEntry.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.
CommunicationEntry.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
CommunicationEntry.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
CommunicationEntry.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
CommunicationEntry.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.
CommunicationEntry.Builder	setScope(java.util.List<java.lang.String> scope) The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc.
CommunicationEntry.Builder	setSelf(SelfResourceLink self)
CommunicationEntry.Builder	setSequenceNumber(java.lang.Long sequenceNumber) This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default.
CommunicationEntry.Builder	setServices(java.util.List<java.lang.String> services) In order to specify all services, use the constant \"ANY\".
CommunicationEntry.Builder	setSourceGroups(java.util.List<java.lang.String> sourceGroups) We need paths as duplicate names may exist for groups under different domains.
CommunicationEntry.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.
CommunicationEntry.Builder	setTag(java.lang.String tag) User level field which will be printed in CLI and packet logs.
CommunicationEntry.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
CommunicationEntry.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites 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 CommunicationEntry.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public CommunicationEntry.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 Pmaas 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 CommunicationEntry.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas 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 CommunicationEntry.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 CommunicationEntry.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 CommunicationEntry.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 thier 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 CommunicationEntry.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 CommunicationEntry.Builder setRemotePath(java.lang.String remotePath)

This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS 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 CommunicationEntry.Builder setUniqueId(java.lang.String uniqueId)

This is a UUID generated by the GM/LM to uniquely identify entites 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 CommunicationEntry.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 CommunicationEntry.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 CommunicationEntry.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.

setAction

public CommunicationEntry.Builder setAction(java.lang.String action)

Possible values are:

• CommunicationEntry.ACTION_ALLOW
• CommunicationEntry.ACTION_DROP
• CommunicationEntry.ACTION_REJECT

The action to be applied to all the services.

Parameters:

action - New value for the property.

setDestinationGroups

public CommunicationEntry.Builder setDestinationGroups(java.util.List<java.lang.String> destinationGroups)

We need paths as duplicate names may exist for groups under different domains.In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.

Parameters:

destinationGroups - New value for the property.

setDirection

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

Possible values are:

• CommunicationEntry.DIRECTION_IN
• CommunicationEntry.DIRECTION_OUT
• CommunicationEntry.DIRECTION_IN_OUT

Define direction of traffic.

Parameters:

direction - New value for the property.

setDisabled

public CommunicationEntry.Builder setDisabled(java.lang.Boolean disabled)

Flag to disable the rule. Default is enabled.

Parameters:

disabled - New value for the property.

setLogged

public CommunicationEntry.Builder setLogged(java.lang.Boolean logged)

Flag to enable packet logging. Default is disabled.

Parameters:

logged - New value for the property.

setNotes

public CommunicationEntry.Builder setNotes(java.lang.String notes)

Text for additional notes on changes.

Parameters:

notes - New value for the property.

setScope

public CommunicationEntry.Builder setScope(java.util.List<java.lang.String> scope)

The list of policy paths where the communication entry is applied Edge/LR/T0/T1/LRP/CGW/MGW/etc. Note that a given rule can be applied on multiple LRs/LRPs.

Parameters:

scope - New value for the property.

setSequenceNumber

public CommunicationEntry.Builder setSequenceNumber(java.lang.Long sequenceNumber)

This field is used to resolve conflicts between multiple CommunicationEntries under CommunicationMap for a Domain If no sequence number is specified in the payload, a value of 0 is assigned by default. If there are multiple communication entries with the same sequence number then their order is not deterministic. If a specific order of communication entry is desired, then one has to specify unique sequence numbers or use the POST request on the communication entry entity with a query parameter action=revise to let the framework assign a sequence number format: int32

Parameters:

sequenceNumber - New value for the property.

setServices

public CommunicationEntry.Builder setServices(java.util.List<java.lang.String> services)

In order to specify all services, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the services array. Error will be thrown if ANY is used in conjunction with other values.

Parameters:

services - New value for the property.

setSourceGroups

public CommunicationEntry.Builder setSourceGroups(java.util.List<java.lang.String> sourceGroups)

We need paths as duplicate names may exist for groups under different domains. In order to specify all groups, use the constant \"ANY\". This is case insensitive. If \"ANY\" is used, it should be the ONLY element in the group array. Error will be thrown if ANY is used in conjunction with other values.

Parameters:

sourceGroups - New value for the property.

setTag

public CommunicationEntry.Builder setTag(java.lang.String tag)

User level field which will be printed in CLI and packet logs.

Parameters:

tag - New value for the property.

build

public CommunicationEntry build()