Class RegionStatus

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

Represents the status of a multi-region operation in a specific Amazon Web Services Region. This structure is used to report per-region progress for both telemetry evaluation and telemetry rule replication.

See Also:

  • Method Details

    • region

      public final String region()

      The Amazon Web Services Region code (for example, eu-west-1 or us-west-2) that this status applies to.

      Returns:
      The Amazon Web Services Region code (for example, eu-west-1 or us-west-2) that this status applies to.

    • status

      public final String status()

      The status of the operation in this region. For telemetry evaluation, valid values include STARTING, RUNNING, and FAILED_START. For telemetry rules, valid values include PENDING, ACTIVE, and FAILED.

      Returns:
      The status of the operation in this region. For telemetry evaluation, valid values include STARTING, RUNNING, and FAILED_START. For telemetry rules, valid values include PENDING, ACTIVE, and FAILED.

    • failureReason

      public final String failureReason()

      The reason for a failure status in this region. This field is only populated when Status indicates a failure.

      Returns:
      The reason for a failure status in this region. This field is only populated when Status indicates a failure.

    • ruleArn

      public final String ruleArn()

      The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is ACTIVE).

      Returns:
      The Amazon Resource Name (ARN) of the telemetry rule in this spoke region. This field is only present for telemetry rule region statuses and is populated when the rule has been successfully created in the spoke region (status is ACTIVE).

    • toBuilder

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

    • builder

      public static RegionStatus.Builder builder()

    • serializableBuilderClass

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