Package com.vmware.nsx_policy.model
Class IpAddressPoolBlockSubnet.Builder
- java.lang.Object
-
- com.vmware.nsx_policy.model.IpAddressPoolBlockSubnet.Builder
-
- Enclosing class:
- IpAddressPoolBlockSubnet
public static final class IpAddressPoolBlockSubnet.Builder extends java.lang.Object
Builder class forIpAddressPoolBlockSubnet
.
-
-
Constructor Summary
Constructors Constructor Description Builder()
Constructor with parameters for the required properties ofIpAddressPoolBlockSubnet
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description IpAddressPoolBlockSubnet
build()
IpAddressPoolBlockSubnet.Builder
setAllocationRange(java.lang.Long allocationRange)
Allocation range is used to limit subnet range to be used for allocations of IPs from subnet.IpAddressPoolBlockSubnet.Builder
setAutoAssignGateway(java.lang.Boolean autoAssignGateway)
If this property is set to true, the first IP in the range will be reserved for gateway.IpAddressPoolBlockSubnet.Builder
setBroadcastAddress(java.lang.String broadcastAddress)
Represents Broadcast address of the subnet in a NSX+ instance.IpAddressPoolBlockSubnet.Builder
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.IpAddressPoolBlockSubnet.Builder
setCidr(java.lang.String cidr)
Represents network address and the prefix length in a NSX+ instance which will be associated with a layer-2 broadcast domain.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setDescription(java.lang.String description)
Description of this resourceIpAddressPoolBlockSubnet.Builder
setDisplayName(java.lang.String displayName)
Defaults to ID if not setIpAddressPoolBlockSubnet.Builder
setGatewayAddress(java.lang.String gatewayAddress)
Represents Gateway address of the subnet in a NSX+ instance.IpAddressPoolBlockSubnet.Builder
setId(java.lang.String id)
Unique identifier of this resourceIpAddressPoolBlockSubnet.Builder
setIpBlockPath(java.lang.String ipBlockPath)
The path of the IpAddressBlock from which the subnet is to be created.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.IpAddressPoolBlockSubnet.Builder
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.IpAddressPoolBlockSubnet.Builder
setNetworkAddress(java.lang.String networkAddress)
Represents Network address of the subnet in a NSX+ instance.IpAddressPoolBlockSubnet.Builder
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.IpAddressPoolBlockSubnet.Builder
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.IpAddressPoolBlockSubnet.Builder
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.IpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setSelf(SelfResourceLink self)
IpAddressPoolBlockSubnet.Builder
setSize(java.lang.Long size)
The size parameter is required for subnet creation.IpAddressPoolBlockSubnet.Builder
setStartIp(java.lang.String startIp)
For internal system use Only.IpAddressPoolBlockSubnet.Builder
setSubnetSize(java.lang.String subnetSize)
The size parameter is required for subnet creation.IpAddressPoolBlockSubnet.Builder
setSyncRealization(java.lang.Boolean syncRealization)
Realization of intent will be called synchronouslyIpAddressPoolBlockSubnet.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.IpAddressPoolBlockSubnet.Builder
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API userIpAddressPoolBlockSubnet.Builder
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.
-
-
-
Constructor Detail
-
Builder
public Builder()
Constructor with parameters for the required properties ofIpAddressPoolBlockSubnet
.
-
-
Method Detail
-
setAllocationRange
public IpAddressPoolBlockSubnet.Builder setAllocationRange(java.lang.Long allocationRange)
Allocation range is used to limit subnet range to be used for allocations of IPs from subnet. This must be less than or equal to subnet size. Instead of taking whole subnet range for allocations, user can limit the range used for allocation of IPs. This is very useful in IPv6 case where big subnets needs to be carved out from IpAddressBlock but whole subnet range will not be needed for IP allocations. Eg: subnet range is (2002:2345::0001-2002:2345::7fff:ffff): subnet_start_ip: 2002:2345::0001-2002:2345 subnet_end_ip: 2002:2345::7fff:ffff User would like to use only 128 IPs for allocations. allocation_range: 128 allocation range used (2002:2345::0001-2002:2345::7fff:007f): allocation_range_start_ip: 2002:2345::0001-2002:2345 allocation_range_end_ip: 2002:2345::7fff:007f format: int64- Parameters:
allocationRange
- New value for the property.
-
setAutoAssignGateway
public IpAddressPoolBlockSubnet.Builder setAutoAssignGateway(java.lang.Boolean autoAssignGateway)
If this property is set to true, the first IP in the range will be reserved for gateway.- Parameters:
autoAssignGateway
- New value for the property.
-
setBroadcastAddress
public IpAddressPoolBlockSubnet.Builder setBroadcastAddress(java.lang.String broadcastAddress)
Represents Broadcast address of the subnet in a NSX+ instance. 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:
broadcastAddress
- New value for the property.
-
setCidr
public IpAddressPoolBlockSubnet.Builder setCidr(java.lang.String cidr)
Represents network address and the prefix length in a NSX+ instance which will be associated with a layer-2 broadcast domain. format: ip-cidr-block 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:
cidr
- New value for the property.
-
setGatewayAddress
public IpAddressPoolBlockSubnet.Builder setGatewayAddress(java.lang.String gatewayAddress)
Represents Gateway address of the subnet in a NSX+ instance. 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:
gatewayAddress
- New value for the property.
-
setIpBlockPath
public IpAddressPoolBlockSubnet.Builder setIpBlockPath(java.lang.String ipBlockPath)
The path of the IpAddressBlock from which the subnet is to be created.- Parameters:
ipBlockPath
- New value for the property.
-
setNetworkAddress
public IpAddressPoolBlockSubnet.Builder setNetworkAddress(java.lang.String networkAddress)
Represents Network address of the subnet in a NSX+ instance. 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:
networkAddress
- New value for the property.
-
setSize
public IpAddressPoolBlockSubnet.Builder setSize(java.lang.Long size)
The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later. Please use subnet_size instead as integer type cannot hold big values needs for IPv6. format: int64- Parameters:
size
- New value for the property.
-
setStartIp
public IpAddressPoolBlockSubnet.Builder setStartIp(java.lang.String startIp)
For internal system use Only. Represents start ip address of the subnet from IP block. Subnet ip adddress will start from this ip address. format: ip- Parameters:
startIp
- New value for the property.
-
setSubnetSize
public IpAddressPoolBlockSubnet.Builder setSubnetSize(java.lang.String subnetSize)
The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later.- Parameters:
subnetSize
- New value for the property.
-
setLinks
public IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.Builder setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
setRevision
public IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.Builder setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
setDisplayName
public IpAddressPoolBlockSubnet.Builder setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
setId
public IpAddressPoolBlockSubnet.Builder setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
setTags
public IpAddressPoolBlockSubnet.Builder setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
setOriginSiteId
public IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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 inChildPolicyConfigResource
. When methods return a value of this class as a return value, the property will contain all the properties defined inChildPolicyConfigResource
.
-
setMarkedForDelete
public IpAddressPoolBlockSubnet.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 IpAddressPoolBlockSubnet.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.
-
setSyncRealization
public IpAddressPoolBlockSubnet.Builder setSyncRealization(java.lang.Boolean syncRealization)
Realization of intent will be called synchronously- Parameters:
syncRealization
- New value for the property.
-
build
public IpAddressPoolBlockSubnet build()
-
-