IpPoolSubnet (Java SDK for NSX Manager API 4.1.2.0.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class IpPoolSubnet
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
A set of IPv4 or IPv6 addresses defined by a network CIDR.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class IpPoolSubnet.Builder
Builder class for IpPoolSubnet.

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

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

IpPoolSubnet()
Default constructor.

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

Constructors
Modifier	Constructor and Description
	`IpPoolSubnet()` Default constructor.
`protected`	`IpPoolSubnet(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 IpPoolSubnet`	`_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 IpPoolSubnet`	`_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.util.List<IpPoolRange>`	`getAllocationRanges()` A collection of IPv4 or IPv6 IP Pool Ranges.
`java.lang.String`	`getCidr()` Represents network address and the prefix length which will be associated with a layer-2 broadcast domain
`java.util.List<java.lang.String>`	`getDnsNameservers()` The collection of upto 3 DNS servers for the subnet.
`java.lang.String`	`getDnsSuffix()` The DNS suffix for the DNS server.
`java.lang.String`	`getGatewayIp()` The default gateway address on a layer-3 router.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing 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()`
`int`	`hashCode()`
`void`	`setAllocationRanges(java.util.List<IpPoolRange> allocationRanges)` A collection of IPv4 or IPv6 IP Pool Ranges.
`void`	`setCidr(java.lang.String cidr)` Represents network address and the prefix length which will be associated with a layer-2 broadcast domain
`void`	`setDnsNameservers(java.util.List<java.lang.String> dnsNameservers)` The collection of upto 3 DNS servers for the subnet.
`void`	`setDnsSuffix(java.lang.String dnsSuffix)` The DNS suffix for the DNS server.
`void`	`setGatewayIp(java.lang.String gatewayIp)` The default gateway address on a layer-3 router.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing 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)`
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - IpPoolSubnet
```
public IpPoolSubnet()
```
    Default constructor.
  - IpPoolSubnet
```
protected IpPoolSubnet(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.
  - getAllocationRanges
```
public java.util.List<IpPoolRange> getAllocationRanges()
```
    A collection of IPv4 or IPv6 IP Pool Ranges.
    
    Returns:
    
    The current value of the property.
  - setAllocationRanges
```
public void setAllocationRanges(java.util.List<IpPoolRange> allocationRanges)
```
    A collection of IPv4 or IPv6 IP Pool Ranges.
    
    Parameters:
    
    allocationRanges - New value for the property.
  - getCidr
```
public java.lang.String getCidr()
```
    Represents network address and the prefix length which will be associated with a layer-2 broadcast domain
    
    Returns:
    
    The current value of the property.
  - setCidr
```
public void setCidr(java.lang.String cidr)
```
    Represents network address and the prefix length which will be associated with a layer-2 broadcast domain
    
    Parameters:
    
    cidr - New value for the property.
  - getDnsNameservers
```
public java.util.List<java.lang.String> getDnsNameservers()
```
    The collection of upto 3 DNS servers for the subnet. format: ip
    
    Returns:
    
    The current value of the property.
  - setDnsNameservers
```
public void setDnsNameservers(java.util.List<java.lang.String> dnsNameservers)
```
    The collection of upto 3 DNS servers for the subnet. format: ip
    
    Parameters:
    
    dnsNameservers - New value for the property.
  - getDnsSuffix
```
public java.lang.String getDnsSuffix()
```
    The DNS suffix for the DNS server. format: hostname
    
    Returns:
    
    The current value of the property.
  - setDnsSuffix
```
public void setDnsSuffix(java.lang.String dnsSuffix)
```
    The DNS suffix for the DNS server. format: hostname
    
    Parameters:
    
    dnsSuffix - New value for the property.
  - getGatewayIp
```
public java.lang.String getGatewayIp()
```
    The default gateway address on a layer-3 router. format: ip
    
    Returns:
    
    The current value of the property.
  - setGatewayIp
```
public void setGatewayIp(java.lang.String gatewayIp)
```
    The default gateway address on a layer-3 router. format: ip
    
    Parameters:
    
    gatewayIp - 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 IpPoolSubnet _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 IpPoolSubnet _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class IpPoolSubnet

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

IpPoolSubnet

IpPoolSubnet

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getAllocationRanges

setAllocationRanges

getCidr

setCidr

getDnsNameservers

setDnsNameservers

getDnsSuffix

setDnsSuffix

getGatewayIp

setGatewayIp

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2