com.vmware.nsx_global_policy.model

Class IpAddressPool.Builder

java.lang.Object

com.vmware.nsx_global_policy.model.IpAddressPool.Builder

Enclosing class:

IpAddressPool

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

Builder class for IpAddressPool.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IpAddressPool	build()
IpAddressPool.Builder	setCheckOverlapWithExistingPools(java.lang.Boolean checkOverlapWithExistingPools) If an existing IpAddressPool is found that overlaps with the given IpAddressPool, then a validation error would be thrown while realization.
IpAddressPool.Builder	setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children) Subtree for this type within policy tree containing nested elements.
IpAddressPool.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.
IpAddressPool.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.
IpAddressPool.Builder	setDescription(java.lang.String description) Description of this resource
IpAddressPool.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IpAddressPool.Builder	setId(java.lang.String id) Unique identifier of this resource
IpAddressPool.Builder	setIpReleaseDelay(java.lang.Long ipReleaseDelay) Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).
IpAddressPool.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.
IpAddressPool.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.
IpAddressPool.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IpAddressPool.Builder	setMarkedForDelete(java.lang.Boolean markedForDelete) Intent objects are not directly deleted from the system when a delete is invoked on them.
IpAddressPool.Builder	setOriginSiteId(java.lang.String originSiteId) This is a UUID generated by the system for knowing which site owns an object.
IpAddressPool.Builder	setOverridden(java.lang.Boolean overridden) Global intent objects cannot be modified by the user.
IpAddressPool.Builder	setOwnerId(java.lang.String ownerId) This is a UUID generated by the system for knowing whoes owns this object.
IpAddressPool.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.
IpAddressPool.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.
IpAddressPool.Builder	setPoolUsage(PolicyPoolUsage poolUsage)
IpAddressPool.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.
IpAddressPool.Builder	setRealizationId(java.lang.String realizationId) This is a UUID generated by the system for realizing the entity object.
IpAddressPool.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.
IpAddressPool.Builder	setRemotePath(java.lang.String remotePath) This is the path of the object on the local managers when queried on the PMaaS service, and path of the object on PMaaS service when queried from the local managers.
IpAddressPool.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IpAddressPool.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IpAddressPool.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.
IpAddressPool.Builder	setSelf(SelfResourceLink self)
IpAddressPool.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.
IpAddressPool.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user
IpAddressPool.Builder	setUniqueId(java.lang.String uniqueId) This is a UUID generated by the GM/LM to uniquely identify entites in a federated environment.
IpAddressPool.Builder	setVisibility(java.lang.String visibility) Possible values are: IpAddressPool.VISIBILITY_PRIVATE IpAddressPool.VISIBILITY_PUBLIC Represents visibility or scope of IpAddressPool and expected consumption of IpAddressPool with same scope.

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setOriginSiteId

public IpAddressPool.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 Pmaas 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 IpAddressPool.Builder setOwnerId(java.lang.String ownerId)

This is a UUID generated by the system for knowing whoes owns this object. This is used in Pmaas 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 IpAddressPool.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 IpAddressPool.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 IpAddressPool.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 thier 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 IpAddressPool.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 IpAddressPool.Builder setRemotePath(java.lang.String remotePath)

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

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

setCheckOverlapWithExistingPools

public IpAddressPool.Builder setCheckOverlapWithExistingPools(java.lang.Boolean checkOverlapWithExistingPools)

If an existing IpAddressPool is found that overlaps with the given IpAddressPool, then a validation error would be thrown while realization. It is false by default.

Parameters:

checkOverlapWithExistingPools - New value for the property.

setIpReleaseDelay

public IpAddressPool.Builder setIpReleaseDelay(java.lang.Long ipReleaseDelay)

Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins). format: int64

Parameters:

ipReleaseDelay - New value for the property.

setPoolUsage

public IpAddressPool.Builder setPoolUsage(PolicyPoolUsage poolUsage)

Parameters:

poolUsage - New value for the property.

setVisibility

public IpAddressPool.Builder setVisibility(java.lang.String visibility)

Possible values are:

• IpAddressPool.VISIBILITY_PRIVATE
• IpAddressPool.VISIBILITY_PUBLIC

Represents visibility or scope of IpAddressPool and expected consumption of IpAddressPool with same scope.

Parameters:

visibility - New value for the property.

build

public IpAddressPool build()