ContainerIpPool (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.ContainerIpPool

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class ContainerIpPool
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Details of Container Ip Pool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class ContainerIpPool.Builder
Builder class for ContainerIpPool.

Nested Classes
Modifier and Type	Class and Description
`static class`	`ContainerIpPool.Builder` Builder class for `ContainerIpPool`.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

static long IP_VERSION_4

static long IP_VERSION_6

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static long`	`IP_VERSION_4`
`static long`	`IP_VERSION_6`

Constructor Summary

Constructors
Modifier Constructor and Description

ContainerIpPool()
Default constructor.

protected ContainerIpPool(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`ContainerIpPool()` Default constructor.
`protected`	`ContainerIpPool(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 ContainerIpPool`	`_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 ContainerIpPool`	`_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.String`	`getContainerClusterId()` Specifies identifier of the container cluster this container ip pool belongs to.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.String`	`getExternalId()` Specifies identifier of the container ip pool.
`java.util.List<SubnetIpRange>`	`getIpRanges()` Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.
`java.lang.Long`	`getIpVersion()` Possible values are: `IP_VERSION_4` `IP_VERSION_6` Specifies IP version of container IP pool.
`java.lang.Long`	`getLastSyncTime()` 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.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.util.List<KeyValuePair>`	`getOriginProperties()` Array of additional specific properties of container ip pool in key-value format.
`java.lang.String`	`getResourceType()` The type of this 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.
`java.util.List<DiscoveredResourceScope>`	`getScope()` Specifies list of scope of discovered resource.
`SelfResourceLink`	`getSelf()`
`java.lang.String`	`getSpec()` This specifies yaml definition of ContainerIpPool resource.
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`int`	`hashCode()`
`void`	`setContainerClusterId(java.lang.String containerClusterId)` Specifies identifier of the container cluster this container ip pool belongs to.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setExternalId(java.lang.String externalId)` Specifies identifier of the container ip pool.
`void`	`setIpRanges(java.util.List<SubnetIpRange> ipRanges)` Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.
`void`	`setIpVersion(java.lang.Long ipVersion)` Possible values are: `IP_VERSION_4` `IP_VERSION_6` Specifies IP version of container IP pool.
`void`	`setLastSyncTime(java.lang.Long lastSyncTime)` 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`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setOriginProperties(java.util.List<KeyValuePair> originProperties)` Array of additional specific properties of container ip pool in key-value format.
`void`	`setResourceType(java.lang.String resourceType)` The type of this 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`	`setScope(java.util.List<DiscoveredResourceScope> scope)` Specifies list of scope of discovered resource.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setSpec(java.lang.String spec)` This specifies yaml definition of ContainerIpPool resource.
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - IP_VERSION_4
```
public static final long IP_VERSION_4
```
    See Also:
    
    Constant Field Values
  - IP_VERSION_6
```
public static final long IP_VERSION_6
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - ContainerIpPool
```
public ContainerIpPool()
```
    Default constructor.
  - ContainerIpPool
```
protected ContainerIpPool(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - 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.
  - getLastSyncTime
```
public java.lang.Long getLastSyncTime()
```
    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.
  - setLastSyncTime
```
public void setLastSyncTime(java.lang.Long lastSyncTime)
```
    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:
    
    lastSyncTime - 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.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getScope
```
public java.util.List<DiscoveredResourceScope> getScope()
```
    Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.
    
    Returns:
    
    The current value of the property.
  - setScope
```
public void setScope(java.util.List<DiscoveredResourceScope> scope)
```
    Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.
    
    Parameters:
    
    scope - New value for 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.
  - getContainerClusterId
```
public java.lang.String getContainerClusterId()
```
    Specifies identifier of the container cluster this container ip pool belongs to.
    
    Returns:
    
    The current value of the property.
  - setContainerClusterId
```
public void setContainerClusterId(java.lang.String containerClusterId)
```
    Specifies identifier of the container cluster this container ip pool belongs to.
    
    Parameters:
    
    containerClusterId - New value for the property.
  - getExternalId
```
public java.lang.String getExternalId()
```
    Specifies identifier of the container ip pool.
    
    Returns:
    
    The current value of the property.
  - setExternalId
```
public void setExternalId(java.lang.String externalId)
```
    Specifies identifier of the container ip pool.
    
    Parameters:
    
    externalId - New value for the property.
  - getIpRanges
```
public java.util.List<SubnetIpRange> getIpRanges()
```
    Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.
    
    Returns:
    
    The current value of the property.
  - setIpRanges
```
public void setIpRanges(java.util.List<SubnetIpRange> ipRanges)
```
    Specifies list of SubnetIpRange, which is a set of contiguous IP addresses, represented by a CIDR or a pair of start and end IPs, along with subnet definition.
    
    Parameters:
    
    ipRanges - New value for the property.
  - getIpVersion
```
public java.lang.Long getIpVersion()
```
    Possible values are:
    - IP_VERSION_4
    - IP_VERSION_6
    Specifies IP version of container IP pool. format: int64
    Returns:
    
    The current value of the property.
  - setIpVersion
```
public void setIpVersion(java.lang.Long ipVersion)
```
    Possible values are:
    - IP_VERSION_4
    - IP_VERSION_6
    Specifies IP version of container IP pool. format: int64
    Parameters:
    
    ipVersion - New value for the property.
  - getOriginProperties
```
public java.util.List<KeyValuePair> getOriginProperties()
```
    Array of additional specific properties of container ip pool in key-value format.
    
    Returns:
    
    The current value of the property.
  - setOriginProperties
```
public void setOriginProperties(java.util.List<KeyValuePair> originProperties)
```
    Array of additional specific properties of container ip pool in key-value format.
    
    Parameters:
    
    originProperties - New value for the property.
  - getSpec
```
public java.lang.String getSpec()
```
    This specifies yaml definition of ContainerIpPool resource.
    
    Returns:
    
    The current value of the property.
  - setSpec
```
public void setSpec(java.lang.String spec)
```
    This specifies yaml definition of ContainerIpPool resource.
    
    Parameters:
    
    spec - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.StaticStructure
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - toString
```
public java.lang.String toString()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.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 this Structure.
  - _getCanonicalName
```
public java.lang.String _getCanonicalName()
```
    Specified by:
    
    _getCanonicalName in interface com.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 ContainerIpPool _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 ContainerIpPool _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class ContainerIpPool

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

IP_VERSION_4

IP_VERSION_6

__dynamicStructureFields

Constructor Detail

ContainerIpPool

ContainerIpPool

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getLastSyncTime

setLastSyncTime

getDescription

setDescription

getDisplayName

setDisplayName

getResourceType

setResourceType

getScope

setScope

getTags

setTags

getContainerClusterId

setContainerClusterId

getExternalId

setExternalId

getIpRanges

setIpRanges

getIpVersion

setIpVersion

getOriginProperties

setOriginProperties

getSpec

setSpec

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2