com.vmware.nsx_policy.model

Class PolicyTransportZone.Builder

java.lang.Object

com.vmware.nsx_policy.model.PolicyTransportZone.Builder

Enclosing class:

PolicyTransportZone

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

Builder class for PolicyTransportZone.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
PolicyTransportZone	build()
PolicyTransportZone.Builder	setAuthorizedVlans(java.util.List<java.lang.String> authorizedVlans) This field lists vlan ids allowed on logical network entities, eg.
PolicyTransportZone.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
PolicyTransportZone.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.
PolicyTransportZone.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.
PolicyTransportZone.Builder	setDescription(java.lang.String description) Description of this resource
PolicyTransportZone.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
PolicyTransportZone.Builder	setForwardingMode(java.lang.String forwardingMode) Possible values are: PolicyTransportZone.FORWARDING_MODE_IPV4_ONLY PolicyTransportZone.FORWARDING_MODE_IPV6_ONLY PolicyTransportZone.FORWARDING_MODE_IPV4_AND_IPV6 Transport Zone Forwarding Mode, must be one of either IPV4_ONLY or IPV6_ONLY or IPV4_AND_IPV6.
PolicyTransportZone.Builder	setId(java.lang.String id) Unique identifier of this resource
PolicyTransportZone.Builder	setIsDefault(java.lang.Boolean isDefault) Flag to indicate if the transport zone is the default one.
PolicyTransportZone.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.
PolicyTransportZone.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.
PolicyTransportZone.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
PolicyTransportZone.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
PolicyTransportZone.Builder	setNestedNsx(java.lang.Boolean nestedNsx) This flag should be set to true in nested NSX environment.
PolicyTransportZone.Builder	setNsxId(java.lang.String nsxId) UUID of transport zone on NSX-T enforcement point.
PolicyTransportZone.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).
PolicyTransportZone.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
PolicyTransportZone.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
PolicyTransportZone.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
PolicyTransportZone.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.
PolicyTransportZone.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.
PolicyTransportZone.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.
PolicyTransportZone.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
PolicyTransportZone.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.
PolicyTransportZone.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the NSX+ service, and path of the object on NSX+ service when queried from the local managers.
PolicyTransportZone.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
PolicyTransportZone.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
PolicyTransportZone.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.
PolicyTransportZone.Builder	setSelf(SelfResourceLink self)
PolicyTransportZone.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.
PolicyTransportZone.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
PolicyTransportZone.Builder	setTransportZoneProfilePaths(java.util.List<java.lang.String> transportZoneProfilePaths) Policy Transport Zone Profile paths
PolicyTransportZone.Builder	setTzType(java.lang.String tzType) Possible values are: PolicyTransportZone.TZ_TYPE_OVERLAY_STANDARD PolicyTransportZone.TZ_TYPE_OVERLAY_ENS PolicyTransportZone.TZ_TYPE_VLAN_BACKED PolicyTransportZone.TZ_TYPE_OVERLAY_BACKED PolicyTransportZone.TZ_TYPE_UNKNOWN Transport Zone Traffic type, must be one of either VLAN_BACKED or OVERLAY_BACKED.
PolicyTransportZone.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
PolicyTransportZone.Builder	setUplinkTeamingPolicyNames(java.util.List<java.lang.String> uplinkTeamingPolicyNames) The names of switching uplink teaming policies that all transport nodes in this transport zone 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 PolicyTransportZone.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public PolicyTransportZone.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 NSX+. 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 PolicyTransportZone.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing who owns this object. This is used in NSX+. 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 PolicyTransportZone.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 PolicyTransportZone.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 PolicyTransportZone.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 their 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 PolicyTransportZone.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 PolicyTransportZone.Builder setRemotePath(java.lang.String remotePath)

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

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

setAuthorizedVlans

public PolicyTransportZone.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 PolicyTransportZone.Builder setForwardingMode(java.lang.String forwardingMode)

Possible values are:

• PolicyTransportZone.FORWARDING_MODE_IPV4_ONLY
• PolicyTransportZone.FORWARDING_MODE_IPV6_ONLY
• PolicyTransportZone.FORWARDING_MODE_IPV4_AND_IPV6

Transport Zone Forwarding Mode, must be one of either IPV4_ONLY or IPV6_ONLY or IPV4_AND_IPV6. Default is IPV4_ONLY.

Parameters:

forwardingMode - New value for the property.

setIsDefault

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

Flag to indicate if the transport zone is the default one. Only one transport zone can be the default one for a given transport zone type.

Parameters:

isDefault - New value for the property.

setNestedNsx

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

setNsxId

public PolicyTransportZone.Builder setNsxId(java.lang.String nsxId)

UUID of transport zone on NSX-T enforcement point. 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:

nsxId - New value for the property.

setOriginId

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

setTransportZoneProfilePaths

public PolicyTransportZone.Builder setTransportZoneProfilePaths(java.util.List<java.lang.String> transportZoneProfilePaths)

Policy Transport Zone Profile paths

Parameters:

transportZoneProfilePaths - New value for the property.

setTzType

public PolicyTransportZone.Builder setTzType(java.lang.String tzType)

Possible values are:

• PolicyTransportZone.TZ_TYPE_OVERLAY_STANDARD
• PolicyTransportZone.TZ_TYPE_OVERLAY_ENS
• PolicyTransportZone.TZ_TYPE_VLAN_BACKED
• PolicyTransportZone.TZ_TYPE_OVERLAY_BACKED
• PolicyTransportZone.TZ_TYPE_UNKNOWN

Transport Zone Traffic type, must be one of either VLAN_BACKED or OVERLAY_BACKED. OVERLAY_STANDARD, OVERLAY_ENS and UNKNOWN are DEPRECATED. STANDARD, ENS and ENS_INTERRUPT are hostSwitch modes and same need to be given in HostTransportNode.HostSwitchSpec.

Parameters:

tzType - New value for the property.

setUplinkTeamingPolicyNames

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

The names of switching uplink teaming policies that all transport nodes in this transport zone support. Uplinkin teaming policies are only valid for VLAN backed transport zones.

Parameters:

uplinkTeamingPolicyNames - New value for the property.

build

public PolicyTransportZone build()