Package com.vmware.nsx_policy.model
Class IpAddressPoolBlockSubnet
- java.lang.Object
-
- com.vmware.nsx_policy.model.IpAddressPoolBlockSubnet
-
- All Implemented Interfaces:
com.vmware.vapi.bindings.StaticStructure
,com.vmware.vapi.bindings.Structure
,java.io.Serializable
public final class IpAddressPoolBlockSubnet extends java.lang.Object implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
This type of subnet allows user to dynamically carve a subnet out of a preconfigured IpAddressBlock. The user must specify the size of the subnet and the IpAddressBlock from which the subnet is to be derived. If the required amount of IP address space is available in the specified IpAddressBlock, the system automatically configures subnet range. IpAddressBlock available size is calculated based on the size of IpAddressPoolBlockSubnet intent object and not on realized. The user should delete failed IpAddressPoolBlockSubnet to utilize IpAddressBlock size correctly.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
IpAddressPoolBlockSubnet.Builder
Builder class forIpAddressPoolBlockSubnet
.
-
Field Summary
Fields Modifier and Type Field Description protected com.vmware.vapi.data.StructValue
__dynamicStructureFields
static java.lang.String
_TYPE_IDENTIFIER
Identifier denoting this class, when it is used in polymorphic context.
-
Constructor Summary
Constructors Modifier Constructor Description IpAddressPoolBlockSubnet()
Default constructor.protected
IpAddressPoolBlockSubnet(com.vmware.vapi.data.StructValue __dynamicStructureFields)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description <T extends com.vmware.vapi.bindings.Structure>
T_convertTo(java.lang.Class<T> clazz)
java.lang.String
_getCanonicalName()
static java.lang.String
_getCanonicalTypeName()
Returns the canonical type name.static com.vmware.vapi.bindings.type.StructType
_getClassType()
WARNING: Internal method, subject to change in future versions.com.vmware.vapi.data.StructValue
_getDataValue()
com.vmware.vapi.data.DataValue
_getDynamicField(java.lang.String fieldName)
java.util.Set<java.lang.String>
_getDynamicFieldNames()
com.vmware.vapi.bindings.type.StructType
_getType()
boolean
_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
static IpAddressPoolBlockSubnet
_newInstance(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.static IpAddressPoolBlockSubnet
_newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.void
_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
protected void
_updateDataValue(com.vmware.vapi.data.StructValue structValue)
void
_validate()
boolean
equals(java.lang.Object obj)
java.lang.Long
getAllocationRange()
Allocation range is used to limit subnet range to be used for allocations of IPs from subnet.java.lang.Boolean
getAutoAssignGateway()
If this property is set to true, the first IP in the range will be reserved for gateway.java.lang.String
getBroadcastAddress()
Represents Broadcast address of the subnet in a NSX+ instance.java.util.List<com.vmware.vapi.bindings.Structure>
getChildren()
Subtree for this type within policy tree containing nested elements.java.lang.String
getCidr()
Represents network address and the prefix length in a NSX+ instance which will be associated with a layer-2 broadcast domain.java.lang.Long
getCreateTime()
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.java.lang.String
getCreateUser()
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.java.lang.String
getDescription()
Description of this resourcejava.lang.String
getDisplayName()
Defaults to ID if not setjava.lang.String
getGatewayAddress()
Represents Gateway address of the subnet in a NSX+ instance.java.lang.String
getId()
Unique identifier of this resourcejava.lang.String
getIpBlockPath()
The path of the IpAddressBlock from which the subnet is to be created.java.lang.Long
getLastModifiedTime()
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.java.lang.String
getLastModifiedUser()
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.java.util.List<ResourceLink>
getLinks()
The server will populate this field when returing the resource.java.lang.Boolean
getMarkedForDelete()
Intent objects are not directly deleted from the system when a delete is invoked on them.java.lang.String
getNetworkAddress()
Represents Network address of the subnet in a NSX+ instance.java.lang.String
getOriginSiteId()
This is a UUID generated by the system for knowing which site owns an object.java.lang.Boolean
getOverridden()
Global intent objects cannot be modified by the user.java.lang.String
getOwnerId()
This is a UUID generated by the system for knowing who owns this object.java.lang.String
getParentPath()
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.java.lang.String
getPath()
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.java.lang.String
getProtection()
Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it.java.lang.String
getRealizationId()
This is a UUID generated by the system for realizing the entity object.java.lang.String
getRelativePath()
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.java.lang.String
getRemotePath()
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.java.lang.String
getResourceType()
Possible values are:IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET
IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET
Specifies whether the IpAddressPoolSubnet is to be carved out of a IpAddressBlock or will be specified by the user The value of this property is automatically populated to"IpAddressPoolBlockSubnet"
.java.lang.Long
getRevision()
The _revision property describes the current revision of the resource.java.lang.String
getSchema()
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.SelfResourceLink
getSelf()
java.lang.Long
getSize()
Deprecated.java.lang.String
getStartIp()
For internal system use Only.java.lang.String
getSubnetSize()
The size parameter is required for subnet creation.java.lang.Boolean
getSyncRealization()
Realization of intent will be called synchronouslyjava.lang.Boolean
getSystemOwned()
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.java.util.List<Tag>
getTags()
Opaque identifiers meaningful to the API userjava.lang.String
getUniqueId()
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.int
hashCode()
void
setAllocationRange(java.lang.Long allocationRange)
Allocation range is used to limit subnet range to be used for allocations of IPs from subnet.void
setAutoAssignGateway(java.lang.Boolean autoAssignGateway)
If this property is set to true, the first IP in the range will be reserved for gateway.void
setBroadcastAddress(java.lang.String broadcastAddress)
Represents Broadcast address of the subnet in a NSX+ instance.void
setChildren(java.util.List<com.vmware.vapi.bindings.Structure> children)
Subtree for this type within policy tree containing nested elements.void
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.void
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.void
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.void
setDescription(java.lang.String description)
Description of this resourcevoid
setDisplayName(java.lang.String displayName)
Defaults to ID if not setvoid
setGatewayAddress(java.lang.String gatewayAddress)
Represents Gateway address of the subnet in a NSX+ instance.void
setId(java.lang.String id)
Unique identifier of this resourcevoid
setIpBlockPath(java.lang.String ipBlockPath)
The path of the IpAddressBlock from which the subnet is to be created.void
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.void
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.void
setLinks(java.util.List<ResourceLink> links)
The server will populate this field when returing the resource.void
setMarkedForDelete(java.lang.Boolean markedForDelete)
Intent objects are not directly deleted from the system when a delete is invoked on them.void
setNetworkAddress(java.lang.String networkAddress)
Represents Network address of the subnet in a NSX+ instance.void
setOriginSiteId(java.lang.String originSiteId)
This is a UUID generated by the system for knowing which site owns an object.void
setOverridden(java.lang.Boolean overridden)
Global intent objects cannot be modified by the user.void
setOwnerId(java.lang.String ownerId)
This is a UUID generated by the system for knowing who owns this object.void
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.void
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.void
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.void
setRealizationId(java.lang.String realizationId)
This is a UUID generated by the system for realizing the entity object.void
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.void
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.void
setRevision(java.lang.Long revision)
The _revision property describes the current revision of the resource.void
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.void
setSelf(SelfResourceLink self)
void
setSize(java.lang.Long size)
Deprecated.void
setStartIp(java.lang.String startIp)
For internal system use Only.void
setSubnetSize(java.lang.String subnetSize)
The size parameter is required for subnet creation.void
setSyncRealization(java.lang.Boolean syncRealization)
Realization of intent will be called synchronouslyvoid
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.void
setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API uservoid
setUniqueId(java.lang.String uniqueId)
This is a UUID generated by the GM/LM to uniquely identify entities in a federated environment.java.lang.String
toString()
-
-
-
Field Detail
-
_TYPE_IDENTIFIER
public static final java.lang.String _TYPE_IDENTIFIER
Identifier denoting this class, when it is used in polymorphic context.This value should be assigned to the property which is used to discriminate the actual type used in the polymorphic context.
- See Also:
- Constant Field Values
-
__dynamicStructureFields
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
-
-
Method Detail
-
getAllocationRange
public java.lang.Long getAllocationRange()
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- Returns:
- The current value of the property.
-
setAllocationRange
public void 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.
-
getAutoAssignGateway
public java.lang.Boolean getAutoAssignGateway()
If this property is set to true, the first IP in the range will be reserved for gateway.- Returns:
- The current value of the property.
-
setAutoAssignGateway
public void 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.
-
getBroadcastAddress
public java.lang.String getBroadcastAddress()
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.- Returns:
- The current value of the property.
-
setBroadcastAddress
public void 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.
-
getCidr
public java.lang.String getCidr()
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.- Returns:
- The current value of the property.
-
setCidr
public void 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.
-
getGatewayAddress
public java.lang.String getGatewayAddress()
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.- Returns:
- The current value of the property.
-
setGatewayAddress
public void 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.
-
getIpBlockPath
public java.lang.String getIpBlockPath()
The path of the IpAddressBlock from which the subnet is to be created.- Returns:
- The current value of the property.
-
setIpBlockPath
public void 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.
-
getNetworkAddress
public java.lang.String getNetworkAddress()
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.- Returns:
- The current value of the property.
-
setNetworkAddress
public void 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.
-
getSize
@Deprecated public java.lang.Long getSize()
Deprecated.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- Returns:
- The current value of the property.
-
setSize
@Deprecated public void setSize(java.lang.Long size)
Deprecated.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.
-
getStartIp
public java.lang.String getStartIp()
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- Returns:
- The current value of the property.
-
setStartIp
public void 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.
-
getSubnetSize
public java.lang.String getSubnetSize()
The size parameter is required for subnet creation. It must be specified during creation but cannot be changed later.- Returns:
- The current value of the property.
-
setSubnetSize
public void 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.
-
getLinks
public java.util.List<ResourceLink> getLinks()
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.- Returns:
- The current value of the property.
-
setLinks
public void 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.
-
getSchema
public java.lang.String getSchema()
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.- Returns:
- The current value of the property.
-
setSchema
public void 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.
-
getSelf
public SelfResourceLink getSelf()
- Returns:
- The current value of the property.
-
setSelf
public void setSelf(SelfResourceLink self)
- Parameters:
self
- New value for the property.
-
getRevision
public java.lang.Long getRevision()
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- Returns:
- The current value of the property.
-
setRevision
public void 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.
-
getCreateTime
public java.lang.Long getCreateTime()
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.- Returns:
- The current value of the property.
-
setCreateTime
public void 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.
-
getCreateUser
public java.lang.String getCreateUser()
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.- Returns:
- The current value of the property.
-
setCreateUser
public void 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.
-
getLastModifiedTime
public java.lang.Long getLastModifiedTime()
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.- Returns:
- The current value of the property.
-
setLastModifiedTime
public void 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.
-
getLastModifiedUser
public java.lang.String getLastModifiedUser()
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.- Returns:
- The current value of the property.
-
setLastModifiedUser
public void 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.
-
getProtection
public java.lang.String getProtection()
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.- Returns:
- The current value of the property.
-
setProtection
public void 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.
-
getSystemOwned
public java.lang.Boolean getSystemOwned()
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.- Returns:
- The current value of the property.
-
setSystemOwned
public void 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.
-
getDescription
public java.lang.String getDescription()
Description of this resource- Returns:
- The current value of the property.
-
setDescription
public void setDescription(java.lang.String description)
Description of this resource- Parameters:
description
- New value for the property.
-
getDisplayName
public java.lang.String getDisplayName()
Defaults to ID if not set- Returns:
- The current value of the property.
-
setDisplayName
public void setDisplayName(java.lang.String displayName)
Defaults to ID if not set- Parameters:
displayName
- New value for the property.
-
getId
public java.lang.String getId()
Unique identifier of this resource- Returns:
- The current value of the property.
-
setId
public void setId(java.lang.String id)
Unique identifier of this resource- Parameters:
id
- New value for the property.
-
getResourceType
public java.lang.String getResourceType()
Possible values are:-
IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLBLOCKSUBNET
-
IpAddressPoolSubnet.RESOURCE_TYPE_IPADDRESSPOOLSTATICSUBNET
"IpAddressPoolBlockSubnet"
.- Returns:
- The current value of the property.
-
-
getTags
public java.util.List<Tag> getTags()
Opaque identifiers meaningful to the API user- Returns:
- The current value of the property.
-
setTags
public void setTags(java.util.List<Tag> tags)
Opaque identifiers meaningful to the API user- Parameters:
tags
- New value for the property.
-
getOriginSiteId
public java.lang.String getOriginSiteId()
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.- Returns:
- The current value of the property.
-
setOriginSiteId
public void 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.
-
getOwnerId
public java.lang.String getOwnerId()
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.- Returns:
- The current value of the property.
-
setOwnerId
public void 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.
-
getParentPath
public java.lang.String getParentPath()
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.- Returns:
- The current value of the property.
-
setParentPath
public void 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.
-
getPath
public java.lang.String getPath()
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.- Returns:
- The current value of the property.
-
setPath
public void 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.
-
getRealizationId
public java.lang.String getRealizationId()
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.- Returns:
- The current value of the property.
-
setRealizationId
public void 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.
-
getRelativePath
public java.lang.String getRelativePath()
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.- Returns:
- The current value of the property.
-
setRelativePath
public void 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.
-
getRemotePath
public java.lang.String getRemotePath()
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.- Returns:
- The current value of the property.
-
setRemotePath
public void 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.
-
getUniqueId
public java.lang.String getUniqueId()
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.- Returns:
- The current value of the property.
-
setUniqueId
public void 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.
-
getChildren
public java.util.List<com.vmware.vapi.bindings.Structure> getChildren()
Subtree for this type within policy tree containing nested elements. Note that this type is applicable to be used in Hierarchical API only.- Returns:
- The current value of 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 inChildPolicyConfigResource
.
-
setChildren
public void 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
.
-
getMarkedForDelete
public java.lang.Boolean getMarkedForDelete()
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.- Returns:
- The current value of the property.
-
setMarkedForDelete
public void 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.
-
getOverridden
public java.lang.Boolean getOverridden()
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.- Returns:
- The current value of the property.
-
setOverridden
public void 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.
-
getSyncRealization
public java.lang.Boolean getSyncRealization()
Realization of intent will be called synchronously- Returns:
- The current value of the property.
-
setSyncRealization
public void setSyncRealization(java.lang.Boolean syncRealization)
Realization of intent will be called synchronously- Parameters:
syncRealization
- New value for the property.
-
_getType
public com.vmware.vapi.bindings.type.StructType _getType()
- Specified by:
_getType
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDataValue
public com.vmware.vapi.data.StructValue _getDataValue()
- Specified by:
_getDataValue
in interfacecom.vmware.vapi.bindings.Structure
-
_updateDataValue
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
-
_validate
public void _validate()
- Specified by:
_validate
in interfacecom.vmware.vapi.bindings.StaticStructure
-
equals
public boolean equals(java.lang.Object obj)
- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Specified by:
toString
in interfacecom.vmware.vapi.bindings.StaticStructure
- Overrides:
toString
in classjava.lang.Object
-
_hasTypeNameOf
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
- Specified by:
_hasTypeNameOf
in interfacecom.vmware.vapi.bindings.Structure
-
_convertTo
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
- Specified by:
_convertTo
in interfacecom.vmware.vapi.bindings.Structure
-
_setDynamicField
public void _setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)
- Specified by:
_setDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicField
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
- Specified by:
_getDynamicField
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getDynamicFieldNames
public java.util.Set<java.lang.String> _getDynamicFieldNames()
- Specified by:
_getDynamicFieldNames
in interfacecom.vmware.vapi.bindings.StaticStructure
-
_getClassType
public static com.vmware.vapi.bindings.type.StructType _getClassType()
WARNING: Internal method, subject to change in future versions.- Returns:
StructType
instance representing the static bindings type for thisStructure
.
-
_getCanonicalName
public java.lang.String _getCanonicalName()
- Specified by:
_getCanonicalName
in interfacecom.vmware.vapi.bindings.Structure
-
_getCanonicalTypeName
public static java.lang.String _getCanonicalTypeName()
Returns the canonical type name. See_getCanonicalName()
.- Returns:
- canonical type name
-
_newInstance
public static IpAddressPoolBlockSubnet _newInstance(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.- Parameters:
structValue
- the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.- Returns:
- the static bindings
StructType
-
_newInstance2
public static IpAddressPoolBlockSubnet _newInstance2(com.vmware.vapi.data.StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.
-
-