com.vmware.nsx_policy.model

Class Tier0Interface.Builder

java.lang.Object

com.vmware.nsx_policy.model.Tier0Interface.Builder

Enclosing class:

Tier0Interface

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

Builder class for Tier0Interface.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Tier0Interface	build()
Tier0Interface.Builder	setAccessVlanId(java.lang.Long accessVlanId) Vlan id.
Tier0Interface.Builder	setAdminState(java.lang.String adminState) Possible values are: Tier0Interface.ADMIN_STATE_UP Tier0Interface.ADMIN_STATE_DOWN This flag is used to enable/disable admin state on tier-0 service port.
Tier0Interface.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
Tier0Interface.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.
Tier0Interface.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.
Tier0Interface.Builder	setDescription(java.lang.String description) Description of this resource
Tier0Interface.Builder	setDhcpRelayPath(java.lang.String dhcpRelayPath) Policy path of dhcp-relay-config to be attached to this Interface.
Tier0Interface.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
Tier0Interface.Builder	setEdgeClusterMemberIndex(java.lang.Long edgeClusterMemberIndex) Specify association of interface with edge cluster member.
Tier0Interface.Builder	setEdgePath(java.lang.String edgePath) Policy path to edge node to handle external connectivity.
Tier0Interface.Builder	setId(java.lang.String id) Unique identifier of this resource
Tier0Interface.Builder	setIgmpLocalJoinGroups(java.util.List<java.lang.String> igmpLocalJoinGroups) IGMP local join groups configuration.
Tier0Interface.Builder	setIpv6ProfilePaths(java.util.List<java.lang.String> ipv6ProfilePaths) Configuration IPv6 NDRA profile.
Tier0Interface.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.
Tier0Interface.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.
Tier0Interface.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
Tier0Interface.Builder	setLsId(java.lang.String lsId) Specify logical switch to which tier-0 interface is connected for external access.
Tier0Interface.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
Tier0Interface.Builder	setMtu(java.lang.Long mtu) Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit.
Tier0Interface.Builder	setMulticast(Tier0InterfacePimConfig multicast)
Tier0Interface.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
Tier0Interface.Builder	setOspf(PolicyInterfaceOspfConfig ospf)
Tier0Interface.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
Tier0Interface.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
Tier0Interface.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.
Tier0Interface.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.
Tier0Interface.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.
Tier0Interface.Builder	setProxyArpFilters(java.util.List<java.lang.String> proxyArpFilters) Array of prefix lists used to specify filtering for ARP proxy.
Tier0Interface.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
Tier0Interface.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.
Tier0Interface.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.
Tier0Interface.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
Tier0Interface.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
Tier0Interface.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.
Tier0Interface.Builder	setSegmentPath(java.lang.String segmentPath) Specify Segment to which this interface is connected to.
Tier0Interface.Builder	setSelf(SelfResourceLink self)
Tier0Interface.Builder	setSubnets(java.util.List<InterfaceSubnet> subnets) Specify IP address and network prefix for interface.
Tier0Interface.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.
Tier0Interface.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
Tier0Interface.Builder	setType(java.lang.String type) Possible values are: Tier0Interface.TYPE_EXTERNAL Tier0Interface.TYPE_SERVICE Tier0Interface.TYPE_LOOPBACK Tier0Interface.TYPE_INTERVRF Interface type
Tier0Interface.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
Tier0Interface.Builder	setUrpfMode(java.lang.String urpfMode) Possible values are: Tier0Interface.URPF_MODE_NONE Tier0Interface.URPF_MODE_STRICT Unicast Reverse Path Forwarding mode

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setDhcpRelayPath

public Tier0Interface.Builder setDhcpRelayPath(java.lang.String dhcpRelayPath)

Policy path of dhcp-relay-config to be attached to this Interface.

Parameters:

dhcpRelayPath - New value for the property.

setSubnets

public Tier0Interface.Builder setSubnets(java.util.List<InterfaceSubnet> subnets)

Specify IP address and network prefix for interface.

Parameters:

subnets - New value for the property.

setAccessVlanId

public Tier0Interface.Builder setAccessVlanId(java.lang.Long accessVlanId)

Vlan id. format: int64

Parameters:

accessVlanId - New value for the property.

setAdminState

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

Possible values are:

• Tier0Interface.ADMIN_STATE_UP
• Tier0Interface.ADMIN_STATE_DOWN

This flag is used to enable/disable admin state on tier-0 service port. If admin_state flag value is not specified then default is UP. When set to UP then traffic on service port will be enabled and service port is enabled from routing perspective. When set to DOWN then traffic on service port will be disabled and service port is down from routing perspective. This flag is experimental because it will be used in V2T BYOT migration. This flag should not be set to UP or DOWN if EVPN is configured, and tier-0 LR is in A/S mode. Also this flag can not be set to UP or DOWN for service interfaces which are configured on vrf-lite.

Parameters:

adminState - New value for the property.

setEdgeClusterMemberIndex

public Tier0Interface.Builder setEdgeClusterMemberIndex(java.lang.Long edgeClusterMemberIndex)

Specify association of interface with edge cluster member. This property is deprecated, use edge_path instead. When both properties are specifed, only edge_path property is used. format: int32

Parameters:

edgeClusterMemberIndex - New value for the property.

setEdgePath

public Tier0Interface.Builder setEdgePath(java.lang.String edgePath)

Policy path to edge node to handle external connectivity. Required when interface type is EXTERNAL. Edge path is required for service interface when tier0 is in ACTIVE_ACTIVE ha_mode. Edge path is required for VRF service interface when parent tier0 is in ACTIVE_ACTIVE ha_mode.

Parameters:

edgePath - New value for the property.

setIgmpLocalJoinGroups

public Tier0Interface.Builder setIgmpLocalJoinGroups(java.util.List<java.lang.String> igmpLocalJoinGroups)

IGMP local join groups configuration. format: ipv4

Parameters:

igmpLocalJoinGroups - New value for the property.

setIpv6ProfilePaths

public Tier0Interface.Builder setIpv6ProfilePaths(java.util.List<java.lang.String> ipv6ProfilePaths)

Configuration IPv6 NDRA profile. Only one NDRA profile can be configured.

Parameters:

ipv6ProfilePaths - New value for the property.

setLsId

public Tier0Interface.Builder setLsId(java.lang.String lsId)

Specify logical switch to which tier-0 interface is connected for external access. This property is deprecated, use segment_path instead. Both properties cannot be used together.

Parameters:

lsId - New value for the property.

setMtu

public Tier0Interface.Builder setMtu(java.lang.Long mtu)

Maximum transmission unit (MTU) specifies the size of the largest packet that a network protocol can transmit. format: int32

Parameters:

mtu - New value for the property.

setMulticast

public Tier0Interface.Builder setMulticast(Tier0InterfacePimConfig multicast)

Parameters:

multicast - New value for the property.

setOspf

public Tier0Interface.Builder setOspf(PolicyInterfaceOspfConfig ospf)

Parameters:

ospf - New value for the property.

setProxyArpFilters

public Tier0Interface.Builder setProxyArpFilters(java.util.List<java.lang.String> proxyArpFilters)

Array of prefix lists used to specify filtering for ARP proxy. Prefixes in this array are used to configure ARP proxy entries on Tier-0 gateway (for uplinks).

Parameters:

proxyArpFilters - New value for the property.

setSegmentPath

public Tier0Interface.Builder setSegmentPath(java.lang.String segmentPath)

Specify Segment to which this interface is connected to. Either segment_path or ls_id property is required.

Parameters:

segmentPath - New value for the property.

setType

public Tier0Interface.Builder setType(java.lang.String type)

Possible values are:

• Tier0Interface.TYPE_EXTERNAL
• Tier0Interface.TYPE_SERVICE
• Tier0Interface.TYPE_LOOPBACK
• Tier0Interface.TYPE_INTERVRF

Interface type

Parameters:

type - New value for the property.

setUrpfMode

public Tier0Interface.Builder setUrpfMode(java.lang.String urpfMode)

Possible values are:

• Tier0Interface.URPF_MODE_NONE
• Tier0Interface.URPF_MODE_STRICT

Unicast Reverse Path Forwarding mode

Parameters:

urpfMode - New value for the property.

build

public Tier0Interface build()