Class MultiRegionEndpoint

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

An object that contains multi-region endpoint (global-endpoint) properties.

See Also:

  • Method Details

    • endpointName

      public final String endpointName()

      The name of the multi-region endpoint (global-endpoint).

      Returns:
      The name of the multi-region endpoint (global-endpoint).

    • status

      public final Status status()

      The status of the multi-region endpoint (global-endpoint).

      • CREATING – The resource is being provisioned.

      • READY – The resource is ready to use.

      • FAILED – The resource failed to be provisioned.

      • DELETING – The resource is being deleted as requested.

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

      Returns:
      The status of the multi-region endpoint (global-endpoint).

      • CREATING – The resource is being provisioned.

      • READY – The resource is ready to use.

      • FAILED – The resource failed to be provisioned.

      • DELETING – The resource is being deleted as requested.

      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the multi-region endpoint (global-endpoint).

      • CREATING – The resource is being provisioned.

      • READY – The resource is ready to use.

      • FAILED – The resource failed to be provisioned.

      • DELETING – The resource is being deleted as requested.

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

      Returns:
      The status of the multi-region endpoint (global-endpoint).

      • CREATING – The resource is being provisioned.

      • READY – The resource is ready to use.

      • FAILED – The resource failed to be provisioned.

      • DELETING – The resource is being deleted as requested.

      See Also:

    • endpointId

      public final String endpointId()

      The ID of the multi-region endpoint (global-endpoint).

      Returns:
      The ID of the multi-region endpoint (global-endpoint).

    • hasRegions

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

    • regions

      public final List<String> regions()

      Primary and secondary regions between which multi-region endpoint splits sending traffic.

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

      Returns:
      Primary and secondary regions between which multi-region endpoint splits sending traffic.

    • createdTimestamp

      public final Instant createdTimestamp()

      The time stamp of when the multi-region endpoint (global-endpoint) was created.

      Returns:
      The time stamp of when the multi-region endpoint (global-endpoint) was created.

    • lastUpdatedTimestamp

      public final Instant lastUpdatedTimestamp()

      The time stamp of when the multi-region endpoint (global-endpoint) was last updated.

      Returns:
      The time stamp of when the multi-region endpoint (global-endpoint) was last updated.

    • toBuilder

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

    • builder

      public static MultiRegionEndpoint.Builder builder()

    • serializableBuilderClass

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