Segment (NSX Policy API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx_policy.model.Segment

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Segment
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Segment configuration to attach workloads.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Segment.Builder
Builder class for Segment.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Segment.Builder` Builder class for `Segment`.

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`ADMIN_STATE_DOWN`
`static java.lang.String`	`ADMIN_STATE_UP`
`static java.lang.String`	`REPLICATION_MODE_MTEP`
`static java.lang.String`	`REPLICATION_MODE_SOURCE`
`static java.lang.String`	`TYPE_DISCONNECTED`
`static java.lang.String`	`TYPE_EXTENDED`
`static java.lang.String`	`TYPE_ROUTED`
`static java.lang.String`	`TYPE_ROUTED_AND_EXTENDED`

Constructor Summary

Constructors
Modifier Constructor and Description

Segment()
Default constructor.

protected Segment(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`Segment()` Default constructor.
`protected`	`Segment(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static Segment`	`_newInstance(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
`static Segment`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<PortAddressBindingEntry>`	`getAddressBindings()` Deprecated.
`java.lang.String`	`getAdminState()` Possible values are: `ADMIN_STATE_UP` `ADMIN_STATE_DOWN` Admin state represents desired state of segment.
`SegmentAdvancedConfig`	`getAdvancedConfig()`
`java.util.List<BridgeProfileConfig>`	`getBridgeProfiles()` Multiple distinct L2 bridge profiles can be configured.
`java.util.List<com.vmware.vapi.bindings.Structure>`	`getChildren()` Subtree for this type within policy tree containing nested elements.
`java.lang.String`	`getConnectivityPath()` Policy path to the connecting Tier-0 or Tier-1 or label of type Tier0.
`java.lang.Long`	`getCreateTime()` 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.
`java.lang.String`	`getCreateUser()` 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.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDhcpConfigPath()` Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.String`	`getDomainName()` DNS domain name
`java.lang.Boolean`	`getEvpnSegment()` Flag to indicate if the Segment is a Child-Segment of type EVPN.
`java.lang.String`	`getEvpnTenantConfigPath()` Policy path to the EvpnTenantConfig resource.
`java.util.List<SegmentExtraConfig>`	`getExtraConfigs()` This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by segment ports in the Segment.
`FederationConnectivityConfig`	`getFederationConfig()`
`java.lang.String`	`getId()` Unique identifier of this resource
`L2Extension`	`getL2Extension()`
`java.lang.Long`	`getLastModifiedTime()` 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.
`java.lang.String`	`getLastModifiedUser()` 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.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getLsId()` Deprecated.
`java.lang.String`	`getMacPoolId()` Mac pool id that associated with a Segment.
`java.lang.Boolean`	`getMarkedForDelete()` Intent objects are not directly deleted from the system when a delete is invoked on them.
`java.util.List<java.lang.String>`	`getMetadataProxyPaths()` Policy path to metadata proxy configuration.
`java.lang.String`	`getOriginSiteId()` This is a UUID generated by the system for knowing which site owns an object.
`java.lang.Long`	`getOverlayId()` Used for overlay connectivity of segments.
`java.lang.Boolean`	`getOverridden()` Global intent objects cannot be modified by the user.
`java.lang.String`	`getOwnerId()` This is a UUID generated by the system for knowing who owns this object.
`java.lang.String`	`getParentPath()` 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.
`java.lang.String`	`getPath()` 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.
`java.lang.String`	`getProtection()` Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.
`java.lang.String`	`getRealizationId()` This is a UUID generated by the system for realizing the entity object.
`java.lang.String`	`getRelativePath()` 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.
`java.lang.String`	`getRemotePath()` 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.
`java.lang.String`	`getReplicationMode()` Possible values are: `REPLICATION_MODE_MTEP` `REPLICATION_MODE_SOURCE` If this field is not set for overlay segment, then the default of MTEP will be used.
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.Long`	`getRevision()` The _revision property describes the current revision of the resource.
`java.lang.String`	`getSchema()` 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.
`SelfResourceLink`	`getSelf()`
`java.util.List<SegmentSubnet>`	`getSubnets()` Subnet configuration.
`java.lang.Boolean`	`getSystemOwned()` 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.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`java.lang.String`	`getTransportZonePath()` Policy path to the transport zone.
`java.lang.String`	`getType()` Possible values are: `TYPE_ROUTED` `TYPE_EXTENDED` `TYPE_ROUTED_AND_EXTENDED` `TYPE_DISCONNECTED` Segment type based on configuration.
`java.lang.String`	`getUniqueId()` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`java.util.List<java.lang.String>`	`getVlanIds()` VLAN ids for a VLAN backed Segment.
`int`	`hashCode()`
`void`	`setAddressBindings(java.util.List<PortAddressBindingEntry> addressBindings)` Deprecated.
`void`	`setAdminState(java.lang.String adminState)` Possible values are: `ADMIN_STATE_UP` `ADMIN_STATE_DOWN` Admin state represents desired state of segment.
`void`	`setAdvancedConfig(SegmentAdvancedConfig advancedConfig)`
`void`	`setBridgeProfiles(java.util.List<BridgeProfileConfig> bridgeProfiles)` Multiple distinct L2 bridge profiles can be configured.
`void`	`setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)` Subtree for this type within policy tree containing nested elements.
`void`	`setConnectivityPath(java.lang.String connectivityPath)` Policy path to the connecting Tier-0 or Tier-1 or label of type Tier0.
`void`	`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.
`void`	`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.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDhcpConfigPath(java.lang.String dhcpConfigPath)` Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setDomainName(java.lang.String domainName)` DNS domain name
`void`	`setEvpnSegment(java.lang.Boolean evpnSegment)` Flag to indicate if the Segment is a Child-Segment of type EVPN.
`void`	`setEvpnTenantConfigPath(java.lang.String evpnTenantConfigPath)` Policy path to the EvpnTenantConfig resource.
`void`	`setExtraConfigs(java.util.List<SegmentExtraConfig> 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 segment ports in the Segment.
`void`	`setFederationConfig(FederationConnectivityConfig federationConfig)`
`void`	`setId(java.lang.String id)` Unique identifier of this resource
`void`	`setL2Extension(L2Extension l2Extension)`
`void`	`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.
`void`	`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.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setLsId(java.lang.String lsId)` Deprecated.
`void`	`setMacPoolId(java.lang.String macPoolId)` Mac pool id that associated with a Segment.
`void`	`setMarkedForDelete(java.lang.Boolean markedForDelete)` Intent objects are not directly deleted from the system when a delete is invoked on them.
`void`	`setMetadataProxyPaths(java.util.List<java.lang.String> metadataProxyPaths)` Policy path to metadata proxy configuration.
`void`	`setOriginSiteId(java.lang.String originSiteId)` This is a UUID generated by the system for knowing which site owns an object.
`void`	`setOverlayId(java.lang.Long overlayId)` Used for overlay connectivity of segments.
`void`	`setOverridden(java.lang.Boolean overridden)` Global intent objects cannot be modified by the user.
`void`	`setOwnerId(java.lang.String ownerId)` This is a UUID generated by the system for knowing who owns this object.
`void`	`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.
`void`	`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.
`void`	`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.
`void`	`setRealizationId(java.lang.String realizationId)` This is a UUID generated by the system for realizing the entity object.
`void`	`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.
`void`	`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.
`void`	`setReplicationMode(java.lang.String replicationMode)` Possible values are: `REPLICATION_MODE_MTEP` `REPLICATION_MODE_SOURCE` If this field is not set for overlay segment, then the default of MTEP will be used.
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setRevision(java.lang.Long revision)` The _revision property describes the current revision of the resource.
`void`	`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.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSubnets(java.util.List<SegmentSubnet> subnets)` Subnet configuration.
`void`	`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.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`void`	`setTransportZonePath(java.lang.String transportZonePath)` Policy path to the transport zone.
`void`	`setType(java.lang.String type)` Possible values are: `TYPE_ROUTED` `TYPE_EXTENDED` `TYPE_ROUTED_AND_EXTENDED` `TYPE_DISCONNECTED` Segment type based on configuration.
`void`	`setUniqueId(java.lang.String uniqueId)` This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
`void`	`setVlanIds(java.util.List<java.lang.String> vlanIds)` VLAN ids for a VLAN backed Segment.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - ADMIN_STATE_UP
```
public static final java.lang.String ADMIN_STATE_UP
```
    See Also:
    
    Constant Field Values
  - ADMIN_STATE_DOWN
```
public static final java.lang.String ADMIN_STATE_DOWN
```
    See Also:
    
    Constant Field Values
  - REPLICATION_MODE_MTEP
```
public static final java.lang.String REPLICATION_MODE_MTEP
```
    See Also:
    
    Constant Field Values
  - REPLICATION_MODE_SOURCE
```
public static final java.lang.String REPLICATION_MODE_SOURCE
```
    See Also:
    
    Constant Field Values
  - TYPE_ROUTED
```
public static final java.lang.String TYPE_ROUTED
```
    See Also:
    
    Constant Field Values
  - TYPE_EXTENDED
```
public static final java.lang.String TYPE_EXTENDED
```
    See Also:
    
    Constant Field Values
  - TYPE_ROUTED_AND_EXTENDED
```
public static final java.lang.String TYPE_ROUTED_AND_EXTENDED
```
    See Also:
    
    Constant Field Values
  - TYPE_DISCONNECTED
```
public static final java.lang.String TYPE_DISCONNECTED
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - Segment
```
public Segment()
```
    Default constructor.
  - Segment
```
protected Segment(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void 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.
  - getSchema
```
public java.lang.String getSchema()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void 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.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getRevision
```
public java.lang.Long getRevision()
```
    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
    
    Returns:
    
    The current value of the property.
  - setRevision
```
public void 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.
  - getCreateTime
```
public java.lang.Long getCreateTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateTime
```
public void 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.
  - getCreateUser
```
public java.lang.String getCreateUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setCreateUser
```
public void 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.
  - getLastModifiedTime
```
public java.lang.Long getLastModifiedTime()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedTime
```
public void 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.
  - getLastModifiedUser
```
public java.lang.String getLastModifiedUser()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setLastModifiedUser
```
public void 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.
  - getProtection
```
public java.lang.String getProtection()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setProtection
```
public void 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.
  - getSystemOwned
```
public java.lang.Boolean getSystemOwned()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setSystemOwned
```
public void 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.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of this resource
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getId
```
public java.lang.String getId()
```
    Unique identifier of this resource
    
    Returns:
    
    The current value of the property.
  - setId
```
public void setId(java.lang.String id)
```
    Unique identifier of this resource
    
    Parameters:
    
    id - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getOriginSiteId
```
public java.lang.String getOriginSiteId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOriginSiteId
```
public void 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.
  - getOwnerId
```
public java.lang.String getOwnerId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOwnerId
```
public void 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.
  - getParentPath
```
public java.lang.String getParentPath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setParentPath
```
public void 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.
  - getPath
```
public java.lang.String getPath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setPath
```
public void 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.
  - getRealizationId
```
public java.lang.String getRealizationId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRealizationId
```
public void 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.
  - getRelativePath
```
public java.lang.String getRelativePath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRelativePath
```
public void 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.
  - getRemotePath
```
public java.lang.String getRemotePath()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setRemotePath
```
public void 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.
  - getUniqueId
```
public java.lang.String getUniqueId()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setUniqueId
```
public void 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.
  - getChildren
```
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
```
    Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.
    
    Returns:
    
    The current value of 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.
  - setChildren
```
public void 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.
  - getMarkedForDelete
```
public java.lang.Boolean getMarkedForDelete()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setMarkedForDelete
```
public void 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.
  - getOverridden
```
public java.lang.Boolean getOverridden()
```
    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.
    
    Returns:
    
    The current value of the property.
  - setOverridden
```
public void 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.
  - getAddressBindings
```
@Deprecated
public java.util.List<PortAddressBindingEntry> getAddressBindings()
```
    Deprecated.
    
    Static address binding used for the Segment. This field is deprecated and will be removed in a future release. Please use address_bindings in SegmentPort to configure static bindings.
    
    Returns:
    
    The current value of the property.
  - setAddressBindings
```
@Deprecated
public void setAddressBindings(java.util.List<PortAddressBindingEntry> addressBindings)
```
    Deprecated.
    
    Static address binding used for the Segment. This field is deprecated and will be removed in a future release. Please use address_bindings in SegmentPort to configure static bindings.
    
    Parameters:
    
    addressBindings - New value for the property.
  - getAdminState
```
public java.lang.String getAdminState()
```
    Possible values are:
    - ADMIN_STATE_UP
    - ADMIN_STATE_DOWN
    Admin state represents desired state of segment. It does not reflect the state of other logical entities connected/attached to the segment.
    Returns:
    
    The current value of the property.
  - setAdminState
```
public void setAdminState(java.lang.String adminState)
```
    Possible values are:
    - ADMIN_STATE_UP
    - ADMIN_STATE_DOWN
    Admin state represents desired state of segment. It does not reflect the state of other logical entities connected/attached to the segment.
    Parameters:
    
    adminState - New value for the property.
  - getAdvancedConfig
```
public SegmentAdvancedConfig getAdvancedConfig()
```
    Returns:
    
    The current value of the property.
  - setAdvancedConfig
```
public void setAdvancedConfig(SegmentAdvancedConfig advancedConfig)
```
    Parameters:
    
    advancedConfig - New value for the property.
  - getBridgeProfiles
```
public java.util.List<BridgeProfileConfig> getBridgeProfiles()
```
    Multiple distinct L2 bridge profiles can be configured.
    
    Returns:
    
    The current value of the property.
  - setBridgeProfiles
```
public void setBridgeProfiles(java.util.List<BridgeProfileConfig> bridgeProfiles)
```
    Multiple distinct L2 bridge profiles can be configured.
    
    Parameters:
    
    bridgeProfiles - New value for the property.
  - getConnectivityPath
```
public java.lang.String getConnectivityPath()
```
    Policy path to the connecting Tier-0 or Tier-1 or label of type Tier0. Valid only for segments created under Infra. This field can only be used for overlay segments. VLAN backed segments cannot have connectivity path set.
    
    Returns:
    
    The current value of the property.
  - setConnectivityPath
```
public void setConnectivityPath(java.lang.String connectivityPath)
```
    Policy path to the connecting Tier-0 or Tier-1 or label of type Tier0. Valid only for segments created under Infra. This field can only be used for overlay segments. VLAN backed segments cannot have connectivity path set.
    
    Parameters:
    
    connectivityPath - New value for the property.
  - getDhcpConfigPath
```
public java.lang.String getDhcpConfigPath()
```
    Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.
    
    Returns:
    
    The current value of the property.
  - setDhcpConfigPath
```
public void setDhcpConfigPath(java.lang.String dhcpConfigPath)
```
    Policy path to DHCP server or relay configuration to use for all IPv4 & IPv6 subnets configured on this segment.
    
    Parameters:
    
    dhcpConfigPath - New value for the property.
  - getDomainName
```
public java.lang.String getDomainName()
```
    DNS domain name
    
    Returns:
    
    The current value of the property.
  - setDomainName
```
public void setDomainName(java.lang.String domainName)
```
    DNS domain name
    
    Parameters:
    
    domainName - New value for the property.
  - getEvpnSegment
```
public java.lang.Boolean getEvpnSegment()
```
    Flag to indicate if the Segment is a Child-Segment of type EVPN. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setEvpnSegment
```
public void setEvpnSegment(java.lang.Boolean evpnSegment)
```
    Flag to indicate if the Segment is a Child-Segment of type EVPN. 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:
    
    evpnSegment - New value for the property.
  - getEvpnTenantConfigPath
```
public java.lang.String getEvpnTenantConfigPath()
```
    Policy path to the EvpnTenantConfig resource. Supported only for Route-Server Evpn Mode. Supported only for Overlay Segments. This will be populated for both Parent and Child segments participating in Evpn Route-Server Mode.
    
    Returns:
    
    The current value of the property.
  - setEvpnTenantConfigPath
```
public void setEvpnTenantConfigPath(java.lang.String evpnTenantConfigPath)
```
    Policy path to the EvpnTenantConfig resource. Supported only for Route-Server Evpn Mode. Supported only for Overlay Segments. This will be populated for both Parent and Child segments participating in Evpn Route-Server Mode.
    
    Parameters:
    
    evpnTenantConfigPath - New value for the property.
  - getExtraConfigs
```
public java.util.List<SegmentExtraConfig> getExtraConfigs()
```
    This property could be used for vendor specific configuration in key value string pairs, the setting in extra_configs will be automatically inheritted by segment ports in the Segment.
    
    Returns:
    
    The current value of the property.
  - setExtraConfigs
```
public void setExtraConfigs(java.util.List<SegmentExtraConfig> 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 segment ports in the Segment.
    
    Parameters:
    
    extraConfigs - New value for the property.
  - getFederationConfig
```
public FederationConnectivityConfig getFederationConfig()
```
    Returns:
    
    The current value of the property.
  - setFederationConfig
```
public void setFederationConfig(FederationConnectivityConfig federationConfig)
```
    Parameters:
    
    federationConfig - New value for the property.
  - getL2Extension
```
public L2Extension getL2Extension()
```
    Returns:
    
    The current value of the property.
  - setL2Extension
```
public void setL2Extension(L2Extension l2Extension)
```
    Parameters:
    
    l2Extension - New value for the property.
  - getLsId
```
@Deprecated
public java.lang.String getLsId()
```
    Deprecated.
    
    This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.
    
    Returns:
    
    The current value of the property.
  - setLsId
```
@Deprecated
public void setLsId(java.lang.String lsId)
```
    Deprecated.
    
    This property is deprecated. The property will continue to work as expected for existing segments. The segments that are newly created with ls_id will be ignored. Sepcify pre-creted logical switch id for Segment.
    
    Parameters:
    
    lsId - New value for the property.
  - getMacPoolId
```
public java.lang.String getMacPoolId()
```
    Mac pool id that associated with a Segment.
    
    Returns:
    
    The current value of the property.
  - setMacPoolId
```
public void setMacPoolId(java.lang.String macPoolId)
```
    Mac pool id that associated with a Segment.
    
    Parameters:
    
    macPoolId - New value for the property.
  - getMetadataProxyPaths
```
public java.util.List<java.lang.String> getMetadataProxyPaths()
```
    Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured.
    
    Returns:
    
    The current value of the property.
  - setMetadataProxyPaths
```
public void setMetadataProxyPaths(java.util.List<java.lang.String> metadataProxyPaths)
```
    Policy path to metadata proxy configuration. Multiple distinct MD proxies can be configured.
    
    Parameters:
    
    metadataProxyPaths - New value for the property.
  - getOverlayId
```
public java.lang.Long getOverlayId()
```
    Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point. format: int32
    
    Returns:
    
    The current value of the property.
  - setOverlayId
```
public void setOverlayId(java.lang.Long overlayId)
```
    Used for overlay connectivity of segments. The overlay_id should be allocated from the pool as definied by enforcement-point. If not provided, it is auto-allocated from the default pool on the enforcement-point. format: int32
    
    Parameters:
    
    overlayId - New value for the property.
  - getReplicationMode
```
public java.lang.String getReplicationMode()
```
    Possible values are:
    - REPLICATION_MODE_MTEP
    - REPLICATION_MODE_SOURCE
    If this field is not set for overlay segment, then the default of MTEP will be used.
    Returns:
    
    The current value of the property.
  - setReplicationMode
```
public void setReplicationMode(java.lang.String replicationMode)
```
    Possible values are:
    - REPLICATION_MODE_MTEP
    - REPLICATION_MODE_SOURCE
    If this field is not set for overlay segment, then the default of MTEP will be used.
    Parameters:
    
    replicationMode - New value for the property.
  - getSubnets
```
public java.util.List<SegmentSubnet> getSubnets()
```
    Subnet configuration. Max 1 subnet
    
    Returns:
    
    The current value of the property.
  - setSubnets
```
public void setSubnets(java.util.List<SegmentSubnet> subnets)
```
    Subnet configuration. Max 1 subnet
    
    Parameters:
    
    subnets - New value for the property.
  - getTransportZonePath
```
public java.lang.String getTransportZonePath()
```
    Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. - This field is required for VLAN backed Segments. - For overlay Segments, it is auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.
    
    Returns:
    
    The current value of the property.
  - setTransportZonePath
```
public void setTransportZonePath(java.lang.String transportZonePath)
```
    Policy path to the transport zone. Supported for VLAN backed segments as well as Overlay Segments. - This field is required for VLAN backed Segments. - For overlay Segments, it is auto assigned if only one transport zone exists in the enforcement point. Default transport zone is auto assigned for overlay segments if none specified.
    
    Parameters:
    
    transportZonePath - New value for the property.
  - getType
```
public java.lang.String getType()
```
    Possible values are:
    Segment type based on configuration. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(java.lang.String type)
```
    Possible values are:
    Segment type based on configuration. 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:
    
    type - New value for the property.
  - getVlanIds
```
public java.util.List<java.lang.String> getVlanIds()
```
    VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with '-' in between.
    
    Returns:
    
    The current value of the property.
  - setVlanIds
```
public void setVlanIds(java.util.List<java.lang.String> vlanIds)
```
    VLAN ids for a VLAN backed Segment. Can be a VLAN id or a range of VLAN ids specified with '-' in between.
    
    Parameters:
    
    vlanIds - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _getClassType
```
public static com.vmware.vapi.bindings.type.StructType _getClassType()
```
    WARNING: Internal method, subject to change in future versions.
    
    Returns:
    
    StructType instance representing the static bindings type for this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static Segment _newInstance(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Returns new instance of this binding class and injects the provided data value.
    WARNING: The returned object is not fully initialized.
    
    Parameters:
    
    structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.
    
    Returns:
    
    the static bindings StructType
  - _newInstance2
```
public static Segment _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Segment

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ADMIN_STATE_UP

ADMIN_STATE_DOWN

REPLICATION_MODE_MTEP

REPLICATION_MODE_SOURCE

TYPE_ROUTED

TYPE_EXTENDED

TYPE_ROUTED_AND_EXTENDED

TYPE_DISCONNECTED

__dynamicStructureFields

Constructor Detail

Segment

Segment

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getRevision

setRevision

getCreateTime

setCreateTime

getCreateUser

setCreateUser

getLastModifiedTime

setLastModifiedTime

getLastModifiedUser

setLastModifiedUser

getProtection

setProtection

getSystemOwned

setSystemOwned

getDescription

setDescription

getDisplayName

setDisplayName

getId

setId

getResourceType

setResourceType

getTags

setTags

getOriginSiteId

setOriginSiteId

getOwnerId

setOwnerId

getParentPath

setParentPath

getPath

setPath

getRealizationId

setRealizationId

getRelativePath

setRelativePath

getRemotePath

setRemotePath

getUniqueId

setUniqueId

getChildren

setChildren

getMarkedForDelete

setMarkedForDelete

getOverridden

setOverridden

getAddressBindings

setAddressBindings

getAdminState

setAdminState

getAdvancedConfig

setAdvancedConfig

getBridgeProfiles

setBridgeProfiles