IpamPoolProperties Class

Package:

com.azure.resourcemanager.network.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-network:2.61.0

• java.lang.Object
• • com.azure.resourcemanager.network.models.IpamPoolProperties

Implements

JsonSerializable<IpamPoolProperties>

public final class IpamPoolProperties
implements JsonSerializable<IpamPoolProperties>

Properties of IpamPool resource properties which are specific to the Pool resource.

Constructor Summary

Constructor	Description
IpamPoolProperties()	Creates an instance of IpamPoolProperties class.

Method Summary

Modifier and Type	Method and Description
List<String>	addressPrefixes() Get the addressPrefixes property: List of IP address prefixes of the resource.
String	description() Get the description property: The description property.
String	displayName() Get the displayName property: String representing a friendly name for the resource.
static IpamPoolProperties	fromJson(JsonReader jsonReader) Reads an instance of IpamPoolProperties from the JsonReader.
List<IpType>	ipAddressType() Get the ipAddressType property: List of IP address type for the IpamPool.
String	maxAllocationSize() Get the maxAllocationSize property: Maximum number of IP addresses allowed for allocations from this IpamPool to be compliant.
String	minAllocationSize() Get the minAllocationSize property: Minimum number of IP addresses required for allocations from this IpamPool to be compliant.
String	parentPoolName() Get the parentPoolName property: String representing parent IpamPool resource name.
ProvisioningState	provisioningState() Get the provisioningState property: Provisioning states of a resource.
JsonWriter	toJson(JsonWriter jsonWriter)
void	validate() Validates the instance.
IpamPoolProperties	withAddressPrefixes(List<String> addressPrefixes) Set the addressPrefixes property: List of IP address prefixes of the resource.
IpamPoolProperties	withDescription(String description) Set the description property: The description property.
IpamPoolProperties	withDisplayName(String displayName) Set the displayName property: String representing a friendly name for the resource.
IpamPoolProperties	withMaxAllocationSize(String maxAllocationSize) Set the maxAllocationSize property: Maximum number of IP addresses allowed for allocations from this IpamPool to be compliant.
IpamPoolProperties	withMinAllocationSize(String minAllocationSize) Set the minAllocationSize property: Minimum number of IP addresses required for allocations from this IpamPool to be compliant.
IpamPoolProperties	withParentPoolName(String parentPoolName) Set the parentPoolName property: String representing parent IpamPool resource name.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

IpamPoolProperties

public IpamPoolProperties()

Creates an instance of IpamPoolProperties class.

Method Details

addressPrefixes

public List<String> addressPrefixes()

Get the addressPrefixes property: List of IP address prefixes of the resource.

Returns:

the addressPrefixes value.

description

public String description()

Get the description property: The description property.

Returns:

the description value.

displayName

public String displayName()

Get the displayName property: String representing a friendly name for the resource.

Returns:

the displayName value.

fromJson

public static IpamPoolProperties fromJson(JsonReader jsonReader)

Reads an instance of IpamPoolProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of IpamPoolProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

ipAddressType

public List<IpType> ipAddressType()

Get the ipAddressType property: List of IP address type for the IpamPool.

Returns:

the ipAddressType value.

maxAllocationSize

public String maxAllocationSize()

Get the maxAllocationSize property: Maximum number of IP addresses allowed for allocations from this IpamPool to be compliant. Must be greater than or equal to the minimum allocation size. If not specified or empty, no maximum is enforced.

Returns:

the maxAllocationSize value.

minAllocationSize

public String minAllocationSize()

Get the minAllocationSize property: Minimum number of IP addresses required for allocations from this IpamPool to be compliant. Must be less than or equal to the maximum allocation size. If not specified or empty, no minimum is enforced.

Returns:

the minAllocationSize value.

parentPoolName

public String parentPoolName()

Get the parentPoolName property: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

Returns:

the parentPoolName value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: Provisioning states of a resource.

Returns:

the provisioningState value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

validate

public void validate()

Validates the instance.

withAddressPrefixes

public IpamPoolProperties withAddressPrefixes(List<String> addressPrefixes)

Set the addressPrefixes property: List of IP address prefixes of the resource.

Parameters:

addressPrefixes - the addressPrefixes value to set.

Returns:

the IpamPoolProperties object itself.

withDescription

public IpamPoolProperties withDescription(String description)

Set the description property: The description property.

Parameters:

description - the description value to set.

Returns:

the IpamPoolProperties object itself.

withDisplayName

public IpamPoolProperties withDisplayName(String displayName)

Set the displayName property: String representing a friendly name for the resource.

Parameters:

displayName - the displayName value to set.

Returns:

the IpamPoolProperties object itself.

withMaxAllocationSize

public IpamPoolProperties withMaxAllocationSize(String maxAllocationSize)

Set the maxAllocationSize property: Maximum number of IP addresses allowed for allocations from this IpamPool to be compliant. Must be greater than or equal to the minimum allocation size. If not specified or empty, no maximum is enforced.

Parameters:

maxAllocationSize - the maxAllocationSize value to set.

Returns:

the IpamPoolProperties object itself.

withMinAllocationSize

public IpamPoolProperties withMinAllocationSize(String minAllocationSize)

Set the minAllocationSize property: Minimum number of IP addresses required for allocations from this IpamPool to be compliant. Must be less than or equal to the maximum allocation size. If not specified or empty, no minimum is enforced.

Parameters:

minAllocationSize - the minAllocationSize value to set.

Returns:

the IpamPoolProperties object itself.

withParentPoolName

public IpamPoolProperties withParentPoolName(String parentPoolName)

Set the parentPoolName property: String representing parent IpamPool resource name. If empty the IpamPool will be a root pool.

Parameters:

parentPoolName - the parentPoolName value to set.

Returns:

the IpamPoolProperties object itself.