com.vmware.nsx.model

Class LogicalPort.Builder

java.lang.Object

com.vmware.nsx.model.LogicalPort.Builder

Enclosing class:

LogicalPort

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

Builder class for LogicalPort.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LogicalPort	build()
LogicalPort.Builder	setAddressBindings(java.util.List<PacketAddressClassifier> addressBindings) Each address binding must contain both an IPElement and MAC address.
LogicalPort.Builder	setAdminState(java.lang.String adminState) Possible values are: LogicalPort.ADMIN_STATE_UP LogicalPort.ADMIN_STATE_DOWN Represents Desired state of the logical port
LogicalPort.Builder	setAttachment(LogicalPortAttachment attachment)
LogicalPort.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.
LogicalPort.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.
LogicalPort.Builder	setDescription(java.lang.String description) Description of this resource
LogicalPort.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LogicalPort.Builder	setExtraConfigs(java.util.List<ExtraConfig> extraConfigs) This property could be used for vendor specific configuration in key value string pairs.
LogicalPort.Builder	setId(java.lang.String id) Unique identifier of this resource
LogicalPort.Builder	setIgnoreAddressBindings(java.util.List<PacketAddressClassifier> ignoreAddressBindings) IP Discovery module uses various mechanisms to discover address bindings being used on each port.
LogicalPort.Builder	setInitState(java.lang.String initState) Possible values are: LogicalPort.INIT_STATE_UNBLOCKED_VLAN LogicalPort.INIT_STATE_RESTORE_VIF Set initial state when a new logical port is created.
LogicalPort.Builder	setInternalId(java.lang.String internalId) The internal_id of the logical port may or may not be identical to it's managed resource ID.
LogicalPort.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.
LogicalPort.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.
LogicalPort.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LogicalPort.Builder	setLogicalSwitchId(java.lang.String logicalSwitchId) Id of the Logical switch that this port belongs to.
LogicalPort.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.
LogicalPort.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.
LogicalPort.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LogicalPort.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LogicalPort.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.
LogicalPort.Builder	setSelf(SelfResourceLink self)
LogicalPort.Builder	setSwitchingProfileIds(java.util.List<SwitchingProfileTypeIdEntry> switchingProfileIds)
LogicalPort.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.
LogicalPort.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

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 LogicalPort.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAddressBindings

public LogicalPort.Builder setAddressBindings(java.util.List<PacketAddressClassifier> addressBindings)

Each address binding must contain both an IPElement and MAC address. VLAN ID is optional. This binding configuration can be used by features such as spoof-guard and overrides any discovered bindings. Any non unique entries are deduplicated to generate a unique set of address bindings and then stored. For IP addresses, a subnet address cannot have host bits set. A maximum of 128 unique address bindings is allowed per port.

Parameters:

addressBindings - New value for the property.

setAdminState

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

Possible values are:

• LogicalPort.ADMIN_STATE_UP
• LogicalPort.ADMIN_STATE_DOWN

Represents Desired state of the logical port

Parameters:

adminState - New value for the property.

setAttachment

public LogicalPort.Builder setAttachment(LogicalPortAttachment attachment)

Parameters:

attachment - New value for the property.

setExtraConfigs

public LogicalPort.Builder setExtraConfigs(java.util.List<ExtraConfig> extraConfigs)

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

Parameters:

extraConfigs - New value for the property.

setIgnoreAddressBindings

public LogicalPort.Builder setIgnoreAddressBindings(java.util.List<PacketAddressClassifier> ignoreAddressBindings)

IP Discovery module uses various mechanisms to discover address bindings being used on each 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:

ignoreAddressBindings - New value for the property.

setInitState

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

Possible values are:

• LogicalPort.INIT_STATE_UNBLOCKED_VLAN
• LogicalPort.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 (POST), and cannot be modified. 'RESTORE_VIF' fetches and restores VIF attachment from ESX host.

Parameters:

initState - New value for the property.

setInternalId

public LogicalPort.Builder setInternalId(java.lang.String internalId)

The internal_id of the logical port may or may not be identical to it's managed resource ID. If a VirtualMachine connected to logical port migrates from one site to another, then on the destination site, it will be connected to different logical port managed resource. However, the internal_id field will be persisted across vmotion.

Parameters:

internalId - New value for the property.

setLogicalSwitchId

public LogicalPort.Builder setLogicalSwitchId(java.lang.String logicalSwitchId)

Id of the Logical switch that this port belongs to.

Parameters:

logicalSwitchId - New value for the property.

setOriginId

public LogicalPort.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 logical ports that belong to a logical switch of type DVPG. 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.

setSwitchingProfileIds

public LogicalPort.Builder setSwitchingProfileIds(java.util.List<SwitchingProfileTypeIdEntry> switchingProfileIds)

Parameters:

switchingProfileIds - New value for the property.

build

public LogicalPort build()