Class ByoipCidr

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

Information about an IP address range that is provisioned for use with your Amazon Web Services resources through bring your own IP address (BYOIP).

The following describes each BYOIP State that your IP address range can be in.

  • PENDING_PROVISIONING — You’ve submitted a request to provision an IP address range but it is not yet provisioned with Global Accelerator.

  • READY — The address range is provisioned with Global Accelerator and can be advertised.

  • PENDING_ADVERTISING — You’ve submitted a request for Global Accelerator to advertise an address range but it is not yet being advertised.

  • ADVERTISING — The address range is being advertised by Global Accelerator.

  • PENDING_WITHDRAWING — You’ve submitted a request to withdraw an address range from being advertised but it is still being advertised by Global Accelerator.

  • PENDING_DEPROVISIONING — You’ve submitted a request to deprovision an address range from Global Accelerator but it is still provisioned.

  • DEPROVISIONED — The address range is deprovisioned from Global Accelerator.

  • FAILED_PROVISION — The request to provision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.

  • FAILED_ADVERTISING — The request for Global Accelerator to advertise the address range was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.

  • FAILED_WITHDRAW — The request to withdraw the address range from advertising by Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.

  • FAILED_DEPROVISION — The request to deprovision the address range from Global Accelerator was not successful. Please make sure that you provide all of the correct information, and try again. If the request fails a second time, contact Amazon Web Services support.

See Also:

  • Method Details

    • cidr

      public final String cidr()

      The address range, in CIDR notation.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

      Returns:
      The address range, in CIDR notation.

      For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.

    • state

      public final ByoipCidrState state()

      The state of the address pool.

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

      Returns:
      The state of the address pool.
      See Also:

    • stateAsString

      public final String stateAsString()

      The state of the address pool.

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

      Returns:
      The state of the address pool.
      See Also:

    • hasEvents

      public final boolean hasEvents()
      For responses, this returns true if the service returned a value for the Events 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.

    • events

      public final List<ByoipCidrEvent> events()

      A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

      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 hasEvents() method.

      Returns:
      A history of status changes for an IP address range that you bring to Global Accelerator through bring your own IP address (BYOIP).

    • toBuilder

      public ByoipCidr.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<ByoipCidr.Builder,ByoipCidr>
      Returns:
      a builder for type T

    • builder

      public static ByoipCidr.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ByoipCidr.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.