com.vmware.nsx_global_policy.model

Class SegmentPort.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.SegmentPort.Builder

Enclosing class:

SegmentPort

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

Builder class for SegmentPort.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SegmentPort	build()
SegmentPort.Builder	setAddressBindings(java.util.List<PortAddressBindingEntry> addressBindings) Static address binding used for the port.
SegmentPort.Builder	setAdminState(java.lang.String adminState) Possible values are: SegmentPort.ADMIN_STATE_UP SegmentPort.ADMIN_STATE_DOWN Represents desired state of the segment port
SegmentPort.Builder	setAttachment(PortAttachment attachment)
SegmentPort.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
SegmentPort.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.
SegmentPort.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.
SegmentPort.Builder	setDescription(java.lang.String description) Description of this resource
SegmentPort.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
SegmentPort.Builder	setExtraConfigs(java.util.List<SegmentExtraConfig> extraConfigs) This property could be used for vendor specific configuration in key value string pairs.
SegmentPort.Builder	setId(java.lang.String id) Unique identifier of this resource
SegmentPort.Builder	setIgnoredAddressBindings(java.util.List<PortAddressBindingEntry> ignoredAddressBindings) IP Discovery module uses various mechanisms to discover address bindings being used on each segment port.
SegmentPort.Builder	setInitState(java.lang.String initState) Possible values are: SegmentPort.INIT_STATE_UNBLOCKED_VLAN SegmentPort.INIT_STATE_RESTORE_VIF Set initial state when a new logical port is created.
SegmentPort.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.
SegmentPort.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.
SegmentPort.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
SegmentPort.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
SegmentPort.Builder	setOriginId(java.lang.String originId) ID populated by NSX when NSX on DVPG is used to indicate the source Distributed Virtual Port and the corresponding Distributed Virtual Switch.
SegmentPort.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
SegmentPort.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
SegmentPort.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
SegmentPort.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.
SegmentPort.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.
SegmentPort.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.
SegmentPort.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
SegmentPort.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.
SegmentPort.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.
SegmentPort.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
SegmentPort.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
SegmentPort.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.
SegmentPort.Builder	setSelf(SelfResourceLink self)
SegmentPort.Builder	setSourceSiteId(java.lang.String sourceSiteId) This field will refer to the source site on which the segment port is discovered.
SegmentPort.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.
SegmentPort.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
SegmentPort.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 SegmentPort.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setAddressBindings

public SegmentPort.Builder setAddressBindings(java.util.List<PortAddressBindingEntry> addressBindings)

Static address binding used for the port.

Parameters:

addressBindings - New value for the property.

setAdminState

public SegmentPort.Builder setAdminState(java.lang.String adminState)

Possible values are:

• SegmentPort.ADMIN_STATE_UP
• SegmentPort.ADMIN_STATE_DOWN

Represents desired state of the segment port

Parameters:

adminState - New value for the property.

setAttachment

public SegmentPort.Builder setAttachment(PortAttachment attachment)

Parameters:

attachment - New value for the property.

setExtraConfigs

public SegmentPort.Builder setExtraConfigs(java.util.List<SegmentExtraConfig> extraConfigs)

This property could be used for vendor specific configuration in key value string pairs. Segment port setting will override segment setting if the same key was set on both segment and segment port.

Parameters:

extraConfigs - New value for the property.

setIgnoredAddressBindings

public SegmentPort.Builder setIgnoredAddressBindings(java.util.List<PortAddressBindingEntry> ignoredAddressBindings)

IP Discovery module uses various mechanisms to discover address bindings being used on each segment port. If a user would like to ignore any specific discovered address bindings or prevent the discovery of a particular set of discovered bindings, then those address bindings can be provided here. Currently IP range in CIDR format is not supported.

Parameters:

ignoredAddressBindings - New value for the property.

setInitState

public SegmentPort.Builder setInitState(java.lang.String initState)

Possible values are:

• SegmentPort.INIT_STATE_UNBLOCKED_VLAN
• SegmentPort.INIT_STATE_RESTORE_VIF

Set initial state when a new logical port is created. 'UNBLOCKED_VLAN' means new port will be unblocked on traffic in creation, also VLAN will be set with corresponding logical switch setting. This port setting can only be configured at port creation, and cannot be modified. 'RESTORE_VIF' fetches and restores VIF attachment from ESX host.

Parameters:

initState - New value for the property.

setOriginId

public SegmentPort.Builder setOriginId(java.lang.String originId)

ID populated by NSX when NSX on DVPG is used to indicate the source Distributed Virtual Port and the corresponding Distributed Virtual Switch. This ID is populated only for ports attached to discovered segments. 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:

originId - New value for the property.

setSourceSiteId

public SegmentPort.Builder setSourceSiteId(java.lang.String sourceSiteId)

This field will refer to the source site on which the segment port is discovered. This field is populated by GM, when it receives corresponding notification from LM. 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:

sourceSiteId - New value for the property.

build

public SegmentPort build()