Package software.amazon.awssdk.services.synthetics.model

Class CanaryStatus

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

A structure that contains the current state of the canary.

See Also:

  • Method Details

    • state

      public final CanaryState state()

      The current state of the canary.

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

      Returns:
      The current state of the canary.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the canary.

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

      Returns:
      The current state of the canary.
      See Also:

    • stateReason

      public final String stateReason()

      If the canary has insufficient permissions to run, this field provides more details.

      Returns:
      If the canary has insufficient permissions to run, this field provides more details.

    • stateReasonCode

      public final CanaryStateReasonCode stateReasonCode()

      If the canary cannot run or has failed, this field displays the reason.

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

      Returns:
      If the canary cannot run or has failed, this field displays the reason.
      See Also:

    • stateReasonCodeAsString

      public final String stateReasonCodeAsString()

      If the canary cannot run or has failed, this field displays the reason.

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

      Returns:
      If the canary cannot run or has failed, this field displays the reason.
      See Also:

    • toBuilder

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

    • builder

      public static CanaryStatus.Builder builder()

    • serializableBuilderClass

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