com.vmware.nsx.model

Class TransportZone.Builder

java.lang.Object

com.vmware.nsx.model.TransportZone.Builder

Enclosing class:

TransportZone

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

Builder class for TransportZone.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
TransportZone	build()
TransportZone.Builder	setAuthorizedVlans(java.util.List<java.lang.String> authorizedVlans) This field lists vlan ids allowed on logical network entities, eg.
TransportZone.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.
TransportZone.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.
TransportZone.Builder	setDescription(java.lang.String description) Description of this resource
TransportZone.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
TransportZone.Builder	setForwardingMode(java.lang.String forwardingMode) Possible values are: TransportZone.FORWARDING_MODE_IPV4_ONLY TransportZone.FORWARDING_MODE_IPV6_ONLY TransportZone.FORWARDING_MODE_IPV4_AND_IPV6 The forwarding mode of this transport zone.
TransportZone.Builder	setId(java.lang.String id) Unique identifier of this resource
TransportZone.Builder	setIsDefault(java.lang.Boolean isDefault) Only one transport zone can be the default one for a given transport zone type.
TransportZone.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.
TransportZone.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.
TransportZone.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
TransportZone.Builder	setNestedNsx(java.lang.Boolean nestedNsx) This flag should be set to true in nested NSX environment.
TransportZone.Builder	setOriginId(java.lang.String originId) This field is populated only if the transport zone was created by NSX system to support security on vSphere Distributed Switch (vDS).
TransportZone.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.
TransportZone.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
TransportZone.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
TransportZone.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.
TransportZone.Builder	setSelf(SelfResourceLink self)
TransportZone.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.
TransportZone.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
TransportZone.Builder	setTransportType(java.lang.String transportType) Possible values are: TransportZone.TRANSPORT_TYPE_OVERLAY TransportZone.TRANSPORT_TYPE_VLAN The transport type of this transport zone.
TransportZone.Builder	setTransportZoneProfileIds(java.util.List<TransportZoneProfileTypeIdEntry> transportZoneProfileIds) Identifiers of the transport zone profiles associated with this TransportZone.
TransportZone.Builder	setUplinkTeamingPolicyNames(java.util.List<java.lang.String> uplinkTeamingPolicyNames) The names of switching uplink teaming policies that all transport nodes in this transport zone must support.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setAuthorizedVlans

public TransportZone.Builder setAuthorizedVlans(java.util.List<java.lang.String> authorizedVlans)

This field lists vlan ids allowed on logical network entities, eg. Segments, bridges, etc. created under this transport zone. Can be empty, VLAN id or a range of VLAN ids specified with '-' in between. An empty list allows all vlan ids.

Parameters:

authorizedVlans - New value for the property.

setForwardingMode

public TransportZone.Builder setForwardingMode(java.lang.String forwardingMode)

Possible values are:

• TransportZone.FORWARDING_MODE_IPV4_ONLY
• TransportZone.FORWARDING_MODE_IPV6_ONLY
• TransportZone.FORWARDING_MODE_IPV4_AND_IPV6

The forwarding mode of this transport zone.

Parameters:

forwardingMode - New value for the property.

setIsDefault

public TransportZone.Builder setIsDefault(java.lang.Boolean isDefault)

Only one transport zone can be the default one for a given transport zone type. APIs that need transport zone can choose to use the default transport zone if a transport zone is not given.

Parameters:

isDefault - New value for the property.

setNestedNsx

public TransportZone.Builder setNestedNsx(java.lang.Boolean nestedNsx)

This flag should be set to true in nested NSX environment. When the \"allow_changing_vdr_mac_in_use\" property in the global config object RoutingGlobalConfig is false, this flag can not be changed if this transport zone is OVERLAY and the change will make any transport node in this transport zone to change the VDR MAC used in any host switch. When this flag is true and this transport zone is OVERLAY, all host switches in this transport zone will use the VDR MAC in the \"vdr_mac_nested\" property in the global config object RoutingGlobalConfig.

Parameters:

nestedNsx - New value for the property.

setOriginId

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

This field is populated only if the transport zone was created by NSX system to support security on vSphere Distributed Switch (vDS). The origin_id will refer to the identifier of corresponding vDS from it's parent vCenter server. 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.

setTransportType

public TransportZone.Builder setTransportType(java.lang.String transportType)

Possible values are:

• TransportZone.TRANSPORT_TYPE_OVERLAY
• TransportZone.TRANSPORT_TYPE_VLAN

The transport type of this transport zone.

Parameters:

transportType - New value for the property.

setTransportZoneProfileIds

public TransportZone.Builder setTransportZoneProfileIds(java.util.List<TransportZoneProfileTypeIdEntry> transportZoneProfileIds)

Identifiers of the transport zone profiles associated with this TransportZone.

Parameters:

transportZoneProfileIds - New value for the property.

setUplinkTeamingPolicyNames

public TransportZone.Builder setUplinkTeamingPolicyNames(java.util.List<java.lang.String> uplinkTeamingPolicyNames)

The names of switching uplink teaming policies that all transport nodes in this transport zone must support. An exception will be thrown if a transport node within the transport zone does not support a named teaming policy. The user will need to first ensure all trasnport nodes support the desired named teaming policy before assigning it to the transport zone. If the field is not specified, the host switch's default teaming policy will be used.

Parameters:

uplinkTeamingPolicyNames - New value for the property.

build

public TransportZone build()