Class IpamPoolAllocation

java.lang.Object
software.amazon.awssdk.services.ec2.model.IpamPoolAllocation
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<IpamPoolAllocation.Builder,IpamPoolAllocation>
@Generated("software.amazon.awssdk:codegen") public final class IpamPoolAllocation extends Object implements SdkPojo, Serializable, ToCopyableBuilder<IpamPoolAllocation.Builder,IpamPoolAllocation>

In IPAM, an allocation is a CIDR assignment from an IPAM pool to another IPAM pool or to a resource.

See Also:

  • Method Details

    • cidr

      public final String cidr()

      The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

      Returns:
      The CIDR for the allocation. A CIDR is a representation of an IP address and its associated network mask (or netmask) and refers to a range of IP addresses. An IPv4 CIDR example is 10.24.34.0/23. An IPv6 CIDR example is 2001:DB8::/32.

    • ipamPoolAllocationId

      public final String ipamPoolAllocationId()

      The ID of an allocation.

      Returns:
      The ID of an allocation.

    • description

      public final String description()

      A description of the pool allocation.

      Returns:
      A description of the pool allocation.

    • resourceId

      public final String resourceId()

      The ID of the resource.

      Returns:
      The ID of the resource.

    • resourceType

      public final IpamPoolAllocationResourceType resourceType()

      The type of the resource.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return IpamPoolAllocationResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of the resource.
      See Also:

    • resourceTypeAsString

      public final String resourceTypeAsString()

      The type of the resource.

      If the service returns an enum value that is not available in the current SDK version, resourceType will return IpamPoolAllocationResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

      Returns:
      The type of the resource.
      See Also:

    • resourceRegion

      public final String resourceRegion()

      The Amazon Web Services Region of the resource.

      Returns:
      The Amazon Web Services Region of the resource.

    • resourceOwner

      public final String resourceOwner()

      The owner of the resource.

      Returns:
      The owner of the resource.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final List<Tag> tags()

      The tags for the IPAM pool allocation.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      The tags for the IPAM pool allocation.

    • toBuilder

      public IpamPoolAllocation.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<IpamPoolAllocation.Builder,IpamPoolAllocation>
      Returns:
      a builder for type T

    • builder

      public static IpamPoolAllocation.Builder builder()

    • serializableBuilderClass

      public static Class<? extends IpamPoolAllocation.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.