com.vmware.nsx_policy.model

Class LocaleServices.Builder

java.lang.Object

com.vmware.nsx_policy.model.LocaleServices.Builder

Enclosing class:

LocaleServices

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

Builder class for LocaleServices.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
LocaleServices	build()
LocaleServices.Builder	setBfdProfilePath(java.lang.String bfdProfilePath) This profile is applied to all static route peers in this locale.
LocaleServices.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
LocaleServices.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.
LocaleServices.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.
LocaleServices.Builder	setDescription(java.lang.String description) Description of this resource
LocaleServices.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
LocaleServices.Builder	setEdgeClusterPath(java.lang.String edgeClusterPath) The reference to the edge cluster using the policy path of the edge cluster or label of type PolicyEdgeCluster.
LocaleServices.Builder	setHaVipConfigs(java.util.List<Tier0HaVipConfig> haVipConfigs) This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy.
LocaleServices.Builder	setId(java.lang.String id) Unique identifier of this resource
LocaleServices.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.
LocaleServices.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.
LocaleServices.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
LocaleServices.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
LocaleServices.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
LocaleServices.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
LocaleServices.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing who owns this object.
LocaleServices.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.
LocaleServices.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.
LocaleServices.Builder	setPreferredEdgePaths(java.util.List<java.lang.String> preferredEdgePaths) Policy paths to edge nodes.
LocaleServices.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.
LocaleServices.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
LocaleServices.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.
LocaleServices.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.
LocaleServices.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
LocaleServices.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
LocaleServices.Builder	setRouteRedistributionConfig(Tier0RouteRedistributionConfig routeRedistributionConfig)
LocaleServices.Builder	setRouteRedistributionTypes(java.util.List<java.lang.String> routeRedistributionTypes) Possible values are: LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_STATIC LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_CONNECTED LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_EXTERNAL_INTERFACE LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SEGMENT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_ROUTER_LINK LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SERVICE_INTERFACE LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_LOOPBACK_INTERFACE LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_DNS_FORWARDER_IP LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_IPSEC_LOCAL_IP LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_NAT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_EVPN_TEP_IP LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_NAT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_STATIC LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_VIP LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_SNAT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_DNS_FORWARDER_IP LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_CONNECTED LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SERVICE_INTERFACE LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SEGMENT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_IPSEC_LOCAL_ENDPOINT LocaleServices.ROUTE_REDISTRIBUTION_TYPES_INTER_VRF_STATIC Enable redistribution of different types of routes on Tier-0.
LocaleServices.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.
LocaleServices.Builder	setSelf(SelfResourceLink self)
LocaleServices.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.
LocaleServices.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
LocaleServices.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 LocaleServices.

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

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

setBfdProfilePath

public LocaleServices.Builder setBfdProfilePath(java.lang.String bfdProfilePath)

This profile is applied to all static route peers in this locale. BFD profile configured on static route peers takes precedence over global configuration. If this field is empty, a default profile is applied to all peers.

Parameters:

bfdProfilePath - New value for the property.

setEdgeClusterPath

public LocaleServices.Builder setEdgeClusterPath(java.lang.String edgeClusterPath)

The reference to the edge cluster using the policy path of the edge cluster or label of type PolicyEdgeCluster. Auto assigned on Tier0 if the associated enforcement point has only one edge cluster. For Tier1 ACTIVE-ACTIVE, edge cluster can not be removed and Edge Cluster will be defaulted to edge cluster from connected Tier0.

Parameters:

edgeClusterPath - New value for the property.

setHaVipConfigs

public LocaleServices.Builder setHaVipConfigs(java.util.List<Tier0HaVipConfig> haVipConfigs)

This configuration can be defined only for Active-Standby Tier0 gateway to provide redundancy. For mulitple external interfaces, multiple HA VIP configs must be defined and each config will pair exactly two external interfaces. The VIP will move and will always be owned by the Active node. When this property is configured, configuration of dynamic-routing is not allowed.

Parameters:

haVipConfigs - New value for the property.

setPreferredEdgePaths

public LocaleServices.Builder setPreferredEdgePaths(java.util.List<java.lang.String> preferredEdgePaths)

Policy paths to edge nodes. For Tier1 gateway, the field is used to statically assign the ordered list of up to two edge nodes for stateful services. To enable auto allocation of nodes from the specified edge cluster the field must be left unset. The auto allocation of nodes is supported only for the Tier1 gateway. For Tier0 gateway specified edge is used as a preferred edge node when failover mode is set to PREEMPTIVE, not applicable otherwise.

Parameters:

preferredEdgePaths - New value for the property.

setRouteRedistributionConfig

public LocaleServices.Builder setRouteRedistributionConfig(Tier0RouteRedistributionConfig routeRedistributionConfig)

Parameters:

routeRedistributionConfig - New value for the property.

setRouteRedistributionTypes

public LocaleServices.Builder setRouteRedistributionTypes(java.util.List<java.lang.String> routeRedistributionTypes)

Possible values are:

• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_STATIC
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_CONNECTED
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_EXTERNAL_INTERFACE
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SEGMENT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_ROUTER_LINK
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_SERVICE_INTERFACE
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_LOOPBACK_INTERFACE
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_DNS_FORWARDER_IP
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_IPSEC_LOCAL_IP
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_NAT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER0_EVPN_TEP_IP
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_NAT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_STATIC
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_VIP
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_LB_SNAT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_DNS_FORWARDER_IP
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_CONNECTED
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SERVICE_INTERFACE
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_SEGMENT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_TIER1_IPSEC_LOCAL_ENDPOINT
• LocaleServices.ROUTE_REDISTRIBUTION_TYPES_INTER_VRF_STATIC

Enable redistribution of different types of routes on Tier-0. This property is only valid for locale-service under Tier-0. This property is deprecated, please use \"route_redistribution_config\" property to configure redistribution rules.

Parameters:

routeRedistributionTypes - New value for the property.

build

public LocaleServices build()