Class CanaryRunStatus

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

This structure contains the status information about a canary run.

See Also:

  • Method Details

    • state

      public final CanaryRunState state()

      The current state of the run.

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

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

    • stateAsString

      public final String stateAsString()

      The current state of the run.

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

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

    • stateReason

      public final String stateReason()

      If run of the canary failed, this field contains the reason for the error.

      Returns:
      If run of the canary failed, this field contains the reason for the error.

    • stateReasonCode

      public final CanaryRunStateReasonCode stateReasonCode()

      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

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

      Returns:
      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

      See Also:

    • stateReasonCodeAsString

      public final String stateReasonCodeAsString()

      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

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

      Returns:
      If this value is CANARY_FAILURE, either the canary script failed or Synthetics ran into a fatal error when running the canary. For example, a canary timeout misconfiguration setting can cause the canary to timeout before Synthetics can evaluate its status.

      If this value is EXECUTION_FAILURE, a non-critical failure occurred such as failing to save generated debug artifacts (for example, screenshots or har files).

      If both types of failures occurred, the CANARY_FAILURE takes precedence. To understand the exact error, use the StateReason API.

      See Also:

    • testResult

      public final CanaryRunTestResult testResult()

      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

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

      Returns:
      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.
      See Also:

    • testResultAsString

      public final String testResultAsString()

      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.

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

      Returns:
      Specifies the status of canary script for this run. When Synthetics tries to determine the status but fails, the result is marked as UNKNOWN. For the overall status of canary run, see State.
      See Also:

    • toBuilder

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

    • builder

      public static CanaryRunStatus.Builder builder()

    • serializableBuilderClass

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