Class RegionMetadata

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

Contains information about an enabled Region of an IAM Identity Center instance, including the Region name, status, date added, and whether it is the primary Region.

See Also:

  • Method Details

    • regionName

      public final String regionName()

      The Amazon Web Services Region name.

      Returns:
      The Amazon Web Services Region name.

    • status

      public final RegionStatus status()

      The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress).

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

      Returns:
      The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress).
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress).

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

      Returns:
      The current status of the Region. Valid values are ACTIVE (Region is operational), ADDING (Region extension workflow is in progress), or REMOVING (Region removal workflow is in progress).
      See Also:

    • addedDate

      public final Instant addedDate()

      The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the instance creation time.

      Returns:
      The timestamp when the Region was added to the IAM Identity Center instance. For the primary Region, this is the instance creation time.

    • isPrimaryRegion

      public final Boolean isPrimaryRegion()

      Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

      Returns:
      Indicates whether this is the primary Region where the IAM Identity Center instance was originally enabled. The primary Region cannot be removed.

    • toBuilder

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

    • builder

      public static RegionMetadata.Builder builder()

    • serializableBuilderClass

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