com.vmware.nsx.model

Class LogicalSwitch.Builder

java.lang.Object

com.vmware.nsx.model.LogicalSwitch.Builder

Enclosing class:

LogicalSwitch

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

Builder class for LogicalSwitch.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LogicalSwitch	build()
LogicalSwitch.Builder	setAdminState(java.lang.String adminState) Possible values are: LogicalSwitch.ADMIN_STATE_UP LogicalSwitch.ADMIN_STATE_DOWN Represents Desired state of the Logical Switch
LogicalSwitch.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.
LogicalSwitch.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.
LogicalSwitch.Builder	setDescription(java.lang.String description) Description of this resource
LogicalSwitch.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LogicalSwitch.Builder	setExtraConfigs(java.util.List<ExtraConfig> extraConfigs) This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by logical ports in the logical switch.
LogicalSwitch.Builder	setGlobalVni(java.lang.Long globalVni) The VNI is used for intersite traffic and the global logical switch ID.
LogicalSwitch.Builder	setHybrid(java.lang.Boolean hybrid) If this flag is set to true, then all the logical switch ports attached to this logical switch will behave in a hybrid fashion.
LogicalSwitch.Builder	setId(java.lang.String id) Unique identifier of this resource
LogicalSwitch.Builder	setIpPoolId(java.lang.String ipPoolId) IP pool id that associated with a LogicalSwitch.
LogicalSwitch.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.
LogicalSwitch.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.
LogicalSwitch.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LogicalSwitch.Builder	setMacPoolId(java.lang.String macPoolId) Mac pool id that associated with a LogicalSwitch.
LogicalSwitch.Builder	setNodeLocalSwitch(java.lang.Boolean nodeLocalSwitch) A flag to prevent BUM (broadcast, unknown-unicast and multicast) traffic from reaching the other spanned edges.
LogicalSwitch.Builder	setOriginId(java.lang.String originId) ID populated by NSX when NSX on DVPG is used to indicate the source DVPG.
LogicalSwitch.Builder	setOriginType(java.lang.String originType) Possible values are: LogicalSwitch.ORIGIN_TYPE_VCENTER The type of source from which the DVPG is discovered This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
LogicalSwitch.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.
LogicalSwitch.Builder	setReplicationMode(java.lang.String replicationMode) Possible values are: LogicalSwitch.REPLICATION_MODE_MTEP LogicalSwitch.REPLICATION_MODE_SOURCE Replication mode of the Logical Switch
LogicalSwitch.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LogicalSwitch.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LogicalSwitch.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.
LogicalSwitch.Builder	setSelf(SelfResourceLink self)
LogicalSwitch.Builder	setSpan(java.util.List<java.lang.String> span) Each manager ID represents the NSX Local Manager the logical switch connects.
LogicalSwitch.Builder	setSwitchingProfileIds(java.util.List<SwitchingProfileTypeIdEntry> switchingProfileIds)
LogicalSwitch.Builder	setSwitchType(java.lang.String switchType) Possible values are: LogicalSwitch.SWITCH_TYPE_DEFAULT LogicalSwitch.SWITCH_TYPE_SERVICE_PLANE LogicalSwitch.SWITCH_TYPE_DHCP_RELAY LogicalSwitch.SWITCH_TYPE_GLOBAL LogicalSwitch.SWITCH_TYPE_INTER_ROUTER LogicalSwitch.SWITCH_TYPE_EVPN LogicalSwitch.SWITCH_TYPE_DVPG This field indicates purpose of a LogicalSwitch.
LogicalSwitch.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.
LogicalSwitch.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LogicalSwitch.Builder	setTransportZoneId(java.lang.String transportZoneId) Id of the TransportZone to which this LogicalSwitch is associated
LogicalSwitch.Builder	setUplinkTeamingPolicyName(java.lang.String uplinkTeamingPolicyName) This name has to be one of the switching uplink teaming policy names listed inside the logical switch's TransportZone.
LogicalSwitch.Builder	setVlan(java.lang.Long vlan) This property is dedicated to VLAN based network, to set VLAN of logical network.
LogicalSwitch.Builder	setVlanTrunkSpec(VlanTrunkSpec vlanTrunkSpec)
LogicalSwitch.Builder	setVni(java.lang.Long vni) Only for OVERLAY network.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAdminState

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

Possible values are:

• LogicalSwitch.ADMIN_STATE_UP
• LogicalSwitch.ADMIN_STATE_DOWN

Represents Desired state of the Logical Switch

Parameters:

adminState - New value for the property.

setExtraConfigs

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

This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by logical ports in the logical switch.

Parameters:

extraConfigs - New value for the property.

setGlobalVni

public LogicalSwitch.Builder setGlobalVni(java.lang.Long globalVni)

The VNI is used for intersite traffic and the global logical switch ID. The global VNI pool is agnostic of the local VNI pool, and there is no need to have an exclusive VNI range. For example, VNI x can be the global VNI for logical switch B and the local VNI for logical switch A. format: int32

Parameters:

globalVni - New value for the property.

setHybrid

public LogicalSwitch.Builder setHybrid(java.lang.Boolean hybrid)

If this flag is set to true, then all the logical switch ports attached to this logical switch will behave in a hybrid fashion. The hybrid logical switch port indicates to NSX that the VM intends to operate in underlay mode, but retains the ability to forward egress traffic to the NSX overlay network. This flag can be enabled only for the logical switches in the overlay type transport zone which has host switch mode as LEGACY and also has either CrossCloud or CloudScope tag scopes. Only the NSX public cloud gateway (PCG) uses this flag, other host agents like ESX, KVM and Edge will ignore it. This property cannot be modified once the logical switch is created.

Parameters:

hybrid - New value for the property.

setIpPoolId

public LogicalSwitch.Builder setIpPoolId(java.lang.String ipPoolId)

IP pool id that associated with a LogicalSwitch.

Parameters:

ipPoolId - New value for the property.

setMacPoolId

public LogicalSwitch.Builder setMacPoolId(java.lang.String macPoolId)

Mac pool id that associated with a LogicalSwitch.

Parameters:

macPoolId - New value for the property.

setNodeLocalSwitch

public LogicalSwitch.Builder setNodeLocalSwitch(java.lang.Boolean nodeLocalSwitch)

A flag to prevent BUM (broadcast, unknown-unicast and multicast) traffic from reaching the other spanned edges.

Parameters:

nodeLocalSwitch - New value for the property.

setOriginId

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

ID populated by NSX when NSX on DVPG is used to indicate the source 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.

setOriginType

public LogicalSwitch.Builder setOriginType(java.lang.String originType)

Possible values are:

• LogicalSwitch.ORIGIN_TYPE_VCENTER

The type of source from which the DVPG is discovered 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:

originType - New value for the property.

setReplicationMode

public LogicalSwitch.Builder setReplicationMode(java.lang.String replicationMode)

Possible values are:

• LogicalSwitch.REPLICATION_MODE_MTEP
• LogicalSwitch.REPLICATION_MODE_SOURCE

Replication mode of the Logical Switch

Parameters:

replicationMode - New value for the property.

setSpan

public LogicalSwitch.Builder setSpan(java.util.List<java.lang.String> span)

Each manager ID represents the NSX Local Manager the logical switch connects. This will be populated by the manager.

Parameters:

span - New value for the property.

setSwitchType

public LogicalSwitch.Builder setSwitchType(java.lang.String switchType)

Possible values are:

• LogicalSwitch.SWITCH_TYPE_DEFAULT
• LogicalSwitch.SWITCH_TYPE_SERVICE_PLANE
• LogicalSwitch.SWITCH_TYPE_DHCP_RELAY
• LogicalSwitch.SWITCH_TYPE_GLOBAL
• LogicalSwitch.SWITCH_TYPE_INTER_ROUTER
• LogicalSwitch.SWITCH_TYPE_EVPN
• LogicalSwitch.SWITCH_TYPE_DVPG

This field indicates purpose of a LogicalSwitch. It is set by manager internally or user can provide this field. If not set, DEFAULT type is assigned. NSX components can use this field to create LogicalSwitch that provides component specific functionality. DEFAULT type LogicalSwitches are created for basic L2 connectivity by API users. SERVICE_PLANE type LogicalSwitches are system created service plane LogicalSwitches for Service Insertion service. User can not create SERVICE_PLANE type of LogicalSwitch. DHCP_RELAY type LogicalSwitches are created by external user like Policy with special permissions or by system and will be treated as internal LogicalSwitches. Such LogicalSwitch will not be exposed to vSphere user. GLOBAL type LogicalSwitches are created to span multiple NSX domains to connect multiple remote sites. INTER_ROUTER type LogicalSwitches are policy-created LogicalSwitches which provide inter-router connectivity. DVPG type LogicalSwitches are NSX-created based on DVPGs found in VC which are used as shadow objects in NSX on DVPG.

Parameters:

switchType - New value for the property.

setSwitchingProfileIds

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

Parameters:

switchingProfileIds - New value for the property.

setTransportZoneId

public LogicalSwitch.Builder setTransportZoneId(java.lang.String transportZoneId)

Id of the TransportZone to which this LogicalSwitch is associated

Parameters:

transportZoneId - New value for the property.

setUplinkTeamingPolicyName

public LogicalSwitch.Builder setUplinkTeamingPolicyName(java.lang.String uplinkTeamingPolicyName)

This name has to be one of the switching uplink teaming policy names listed inside the logical switch's TransportZone. If this field is not specified, the logical switch will not have a teaming policy associated with it and the host switch's default teaming policy will be used.

Parameters:

uplinkTeamingPolicyName - New value for the property.

setVlan

public LogicalSwitch.Builder setVlan(java.lang.Long vlan)

This property is dedicated to VLAN based network, to set VLAN of logical network. It is mutually exclusive with 'vlan_trunk_spec'. format: int64

Parameters:

vlan - New value for the property.

setVlanTrunkSpec

public LogicalSwitch.Builder setVlanTrunkSpec(VlanTrunkSpec vlanTrunkSpec)

Parameters:

vlanTrunkSpec - New value for the property.

setVni

public LogicalSwitch.Builder setVni(java.lang.Long vni)

Only for OVERLAY network. A VNI will be auto-allocated from the default VNI pool if not given; otherwise the given VNI has to be inside the default pool and not used by any other LogicalSwitch. format: int32

Parameters:

vni - New value for the property.

build

public LogicalSwitch build()