com.vmware.nsx.model

Class IpPool.Builder

java.lang.Object

com.vmware.nsx.model.IpPool.Builder

Enclosing class:

IpPool

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

Builder class for IpPool.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
IpPool	build()
IpPool.Builder	setCheckOverlapWithExistingPools(java.lang.Boolean checkOverlapWithExistingPools) If true, a validation error will be thrown if another IP pool is found to be overlapping with this pool.
IpPool.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.
IpPool.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.
IpPool.Builder	setDescription(java.lang.String description) Description of this resource
IpPool.Builder	setDisplayName(java.lang.String displayName) Defaults to ID if not set
IpPool.Builder	setId(java.lang.String id) Unique identifier of this resource
IpPool.Builder	setIpAddressType(java.lang.String ipAddressType) Possible values are: IpPool.IP_ADDRESS_TYPE_IPV4 IpPool.IP_ADDRESS_TYPE_IPV6 IpPool.IP_ADDRESS_TYPE_DUAL Represents the type of IP addresses present inside the IP Pool.
IpPool.Builder	setIpReleaseDelay(java.lang.Long ipReleaseDelay) Delay in milliseconds, while releasing allocated IP address from IP pool (Default is 2 mins).
IpPool.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.
IpPool.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.
IpPool.Builder	setLinks(java.util.List<ResourceLink> links) The server will populate this field when returing the resource.
IpPool.Builder	setPoolUsage(PoolUsage poolUsage)
IpPool.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.
IpPool.Builder	setResourceType(java.lang.String resourceType) The type of this resource.
IpPool.Builder	setRevision(java.lang.Long revision) The _revision property describes the current revision of the resource.
IpPool.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.
IpPool.Builder	setSelf(SelfResourceLink self)
IpPool.Builder	setSubnets(java.util.List<IpPoolSubnet> subnets) Subnets can be IPv4 or IPv6 and they should not overlap.
IpPool.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.
IpPool.Builder	setTags(java.util.List<Tag> tags) Opaque identifiers meaningful to the API user

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

Method Detail

setLinks

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

Parameters:

self - New value for the property.

setRevision

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

Description of this resource

Parameters:

description - New value for the property.

setDisplayName

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

Defaults to ID if not set

Parameters:

displayName - New value for the property.

setId

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

Unique identifier of this resource

Parameters:

id - New value for the property.

setResourceType

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

The type of this resource.

Parameters:

resourceType - New value for the property.

setTags

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

Opaque identifiers meaningful to the API user

Parameters:

tags - New value for the property.

setCheckOverlapWithExistingPools

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

If true, a validation error will be thrown if another IP pool is found to be overlapping with this pool. The flag is false by default.

Parameters:

checkOverlapWithExistingPools - New value for the property.

setIpAddressType

public IpPool.Builder setIpAddressType(java.lang.String ipAddressType)

Possible values are:

• IpPool.IP_ADDRESS_TYPE_IPV4
• IpPool.IP_ADDRESS_TYPE_IPV6
• IpPool.IP_ADDRESS_TYPE_DUAL

Represents the type of IP addresses present inside the IP Pool. 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:

ipAddressType - New value for the property.

setIpReleaseDelay

public IpPool.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 IpPool.Builder setPoolUsage(PoolUsage poolUsage)

Parameters:

poolUsage - New value for the property.

setSubnets

public IpPool.Builder setSubnets(java.util.List<IpPoolSubnet> subnets)

Subnets can be IPv4 or IPv6 and they should not overlap. The maximum number will not exceed 5 subnets.

Parameters:

subnets - New value for the property.

build

public IpPool build()