Class CanaryRun

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

This structure contains the details about one run of one canary.

See Also:

  • Method Details

    • id

      public final String id()

      A unique ID that identifies this canary run.

      Returns:
      A unique ID that identifies this canary run.

    • scheduledRunId

      public final String scheduledRunId()

      The ID of the scheduled canary run.

      Returns:
      The ID of the scheduled canary run.

    • retryAttempt

      public final Integer retryAttempt()

      The count in number of the retry attempt.

      Returns:
      The count in number of the retry attempt.

    • name

      public final String name()

      The name of the canary.

      Returns:
      The name of the canary.

    • status

      public final CanaryRunStatus status()

      The status of this run.

      Returns:
      The status of this run.

    • timeline

      public final CanaryRunTimeline timeline()

      A structure that contains the start and end times of this run.

      Returns:
      A structure that contains the start and end times of this run.

    • artifactS3Location

      public final String artifactS3Location()

      The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

      Returns:
      The location where the canary stored artifacts from the run. Artifacts include the log file, screenshots, and HAR files.

    • dryRunConfig

      public final CanaryDryRunConfigOutput dryRunConfig()

      Returns the dry run configurations for a canary.

      Returns:
      Returns the dry run configurations for a canary.

    • toBuilder

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

    • builder

      public static CanaryRun.Builder builder()

    • serializableBuilderClass

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