com.vmware.nsx_policy.model

Class Tier1.Builder

java.lang.Object

com.vmware.nsx_policy.model.Tier1.Builder

Enclosing class:

Tier1

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

Builder class for Tier1.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Tier1	build()
Tier1.Builder	setArpLimit(java.lang.Long arpLimit) Maximum number of ARP entries per transport node.
Tier1.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
Tier1.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.
Tier1.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.
Tier1.Builder	setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging) Indicates if logging should be enabled for the default whitelisting rule.
Tier1.Builder	setDescription(java.lang.String description) Description of this resource
Tier1.Builder	setDhcpConfigPaths(java.util.List<java.lang.String> dhcpConfigPaths) DHCP configuration for Segments connected to Tier-1.
Tier1.Builder	setDisableFirewall(java.lang.Boolean disableFirewall) Disable or enable gateway fiewall.
Tier1.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
Tier1.Builder	setEnableStandbyRelocation(java.lang.Boolean enableStandbyRelocation) Flag to enable standby service router relocation.
Tier1.Builder	setFailoverMode(java.lang.String failoverMode) Possible values are: Tier1.FAILOVER_MODE_PREEMPTIVE Tier1.FAILOVER_MODE_NON_PREEMPTIVE Determines the behavior when a Tier-1 instance restarts after a failure.
Tier1.Builder	setFederationConfig(FederationGatewayConfig federationConfig)
Tier1.Builder	setForceWhitelisting(java.lang.Boolean forceWhitelisting) This field is deprecated and recommended to change Rule action field.
Tier1.Builder	setHaMode(java.lang.String haMode) Possible values are: Tier1.HA_MODE_STANDBY Tier1.HA_MODE_ACTIVE Specify high-availability mode for Tier-1.
Tier1.Builder	setId(java.lang.String id) Unique identifier of this resource
Tier1.Builder	setIntersiteConfig(IntersiteGatewayConfig intersiteConfig)
Tier1.Builder	setIpv6ProfilePaths(java.util.List<java.lang.String> ipv6ProfilePaths) Configuration IPv6 NDRA and DAD profiles.
Tier1.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.
Tier1.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.
Tier1.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
Tier1.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
Tier1.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
Tier1.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
Tier1.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
Tier1.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.
Tier1.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.
Tier1.Builder	setPoolAllocation(java.lang.String poolAllocation) Possible values are: Tier1.POOL_ALLOCATION_ROUTING Tier1.POOL_ALLOCATION_LB_SMALL Tier1.POOL_ALLOCATION_LB_MEDIUM Tier1.POOL_ALLOCATION_LB_LARGE Tier1.POOL_ALLOCATION_LB_XLARGE Supports edge node allocation at different sizes for routing and load balancer service to meet performance and scalability requirements.
Tier1.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.
Tier1.Builder	setQosProfile(GatewayQosProfileConfig qosProfile)
Tier1.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
Tier1.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.
Tier1.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.
Tier1.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
Tier1.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
Tier1.Builder	setRouteAdvertisementRules(java.util.List<RouteAdvertisementRule> routeAdvertisementRules) Route advertisement rules and filtering
Tier1.Builder	setRouteAdvertisementTypes(java.util.List<java.lang.String> routeAdvertisementTypes) Possible values are: Tier1.ROUTE_ADVERTISEMENT_TYPES_STATIC_ROUTES Tier1.ROUTE_ADVERTISEMENT_TYPES_CONNECTED Tier1.ROUTE_ADVERTISEMENT_TYPES_NAT Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_VIP Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_SNAT Tier1.ROUTE_ADVERTISEMENT_TYPES_DNS_FORWARDER_IP Tier1.ROUTE_ADVERTISEMENT_TYPES_IPSEC_LOCAL_ENDPOINT Enable different types of route advertisements.
Tier1.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.
Tier1.Builder	setSelf(SelfResourceLink self)
Tier1.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.
Tier1.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
Tier1.Builder	setTier0Path(java.lang.String tier0Path) The reference to the Tier-0 instance using the policy path of the Tier-0 or label of type Provider.
Tier1.Builder	setType(java.lang.String type) Possible values are: Tier1.TYPE_ROUTED Tier1.TYPE_ISOLATED Tier1.TYPE_NATTED Tier1 connectivity type for reference.
Tier1.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setArpLimit

public Tier1.Builder setArpLimit(java.lang.Long arpLimit)

Maximum number of ARP entries per transport node. format: int32

Parameters:

arpLimit - New value for the property.

setDefaultRuleLogging

public Tier1.Builder setDefaultRuleLogging(java.lang.Boolean defaultRuleLogging)

Indicates if logging should be enabled for the default whitelisting rule. This field is deprecated and recommended to change Rule logging field. Note that this field is not synchronized with default logging field.

Parameters:

defaultRuleLogging - New value for the property.

setDhcpConfigPaths

public Tier1.Builder setDhcpConfigPaths(java.util.List<java.lang.String> dhcpConfigPaths)

DHCP configuration for Segments connected to Tier-1. DHCP service is enabled in relay mode.

Parameters:

dhcpConfigPaths - New value for the property.

setDisableFirewall

public Tier1.Builder setDisableFirewall(java.lang.Boolean disableFirewall)

Disable or enable gateway fiewall.

Parameters:

disableFirewall - New value for the property.

setEnableStandbyRelocation

public Tier1.Builder setEnableStandbyRelocation(java.lang.Boolean enableStandbyRelocation)

Flag to enable standby service router relocation. Standby relocation is not enabled until edge cluster is configured for Tier1.

Parameters:

enableStandbyRelocation - New value for the property.

setFailoverMode

public Tier1.Builder setFailoverMode(java.lang.String failoverMode)

Possible values are:

• Tier1.FAILOVER_MODE_PREEMPTIVE
• Tier1.FAILOVER_MODE_NON_PREEMPTIVE

Determines the behavior when a Tier-1 instance restarts after a failure. If set to PREEMPTIVE, the preferred node will take over, even if it causes another failure. If set to NON_PREEMPTIVE, then the instance that restarted will remain secondary. Only applicable when edge cluster is configured in Tier1 locale-service.

Parameters:

failoverMode - New value for the property.

setFederationConfig

public Tier1.Builder setFederationConfig(FederationGatewayConfig federationConfig)

Parameters:

federationConfig - New value for the property.

setForceWhitelisting

public Tier1.Builder setForceWhitelisting(java.lang.Boolean forceWhitelisting)

This field is deprecated and recommended to change Rule action field. Note that this field is not synchornied with default rule field.

Parameters:

forceWhitelisting - New value for the property.

setHaMode

public Tier1.Builder setHaMode(java.lang.String haMode)

Possible values are:

• Tier1.HA_MODE_STANDBY
• Tier1.HA_MODE_ACTIVE

Specify high-availability mode for Tier-1.

Parameters:

haMode - New value for the property.

setIntersiteConfig

public Tier1.Builder setIntersiteConfig(IntersiteGatewayConfig intersiteConfig)

Parameters:

intersiteConfig - New value for the property.

setIpv6ProfilePaths

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

Configuration IPv6 NDRA and DAD profiles. Either or both NDRA and/or DAD profiles can be configured.

Parameters:

ipv6ProfilePaths - New value for the property.

setPoolAllocation

public Tier1.Builder setPoolAllocation(java.lang.String poolAllocation)

Possible values are:

• Tier1.POOL_ALLOCATION_ROUTING
• Tier1.POOL_ALLOCATION_LB_SMALL
• Tier1.POOL_ALLOCATION_LB_MEDIUM
• Tier1.POOL_ALLOCATION_LB_LARGE
• Tier1.POOL_ALLOCATION_LB_XLARGE

Supports edge node allocation at different sizes for routing and load balancer service to meet performance and scalability requirements. ROUTING: Allocate edge node to provide routing services. LB_SMALL, LB_MEDIUM, LB_LARGE, LB_XLARGE: Specify size of load balancer service that will be configured on TIER1 gateway.

Parameters:

poolAllocation - New value for the property.

setQosProfile

public Tier1.Builder setQosProfile(GatewayQosProfileConfig qosProfile)

Parameters:

qosProfile - New value for the property.

setRouteAdvertisementRules

public Tier1.Builder setRouteAdvertisementRules(java.util.List<RouteAdvertisementRule> routeAdvertisementRules)

Route advertisement rules and filtering

Parameters:

routeAdvertisementRules - New value for the property.

setRouteAdvertisementTypes

public Tier1.Builder setRouteAdvertisementTypes(java.util.List<java.lang.String> routeAdvertisementTypes)

Possible values are:

• Tier1.ROUTE_ADVERTISEMENT_TYPES_STATIC_ROUTES
• Tier1.ROUTE_ADVERTISEMENT_TYPES_CONNECTED
• Tier1.ROUTE_ADVERTISEMENT_TYPES_NAT
• Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_VIP
• Tier1.ROUTE_ADVERTISEMENT_TYPES_LB_SNAT
• Tier1.ROUTE_ADVERTISEMENT_TYPES_DNS_FORWARDER_IP
• Tier1.ROUTE_ADVERTISEMENT_TYPES_IPSEC_LOCAL_ENDPOINT

Enable different types of route advertisements. When not specified, routes to IPSec VPN local-endpoint subnets (TIER1_IPSEC_LOCAL_ENDPOINT) are automatically advertised.

Parameters:

routeAdvertisementTypes - New value for the property.

setTier0Path

public Tier1.Builder setTier0Path(java.lang.String tier0Path)

The reference to the Tier-0 instance using the policy path of the Tier-0 or label of type Provider. Specify the Tier-1 connectivity to Tier-0 instance. .

Parameters:

tier0Path - New value for the property.

setType

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

Possible values are:

• Tier1.TYPE_ROUTED
• Tier1.TYPE_ISOLATED
• Tier1.TYPE_NATTED

Tier1 connectivity type for reference. Property value is not validated with Tier1 configuration. ROUTED: Tier1 is connected to Tier0 gateway and routing is enabled. ISOLATED: Tier1 is not connected to any Tier0 gateway. NATTED: Tier1 is in ROUTED type with NAT configured locally.

Parameters:

type - New value for the property.

build

public Tier1 build()