Class CanaryRunConfigOutput

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

A structure that contains information about a canary run.

See Also:

  • Method Details

    • timeoutInSeconds

      public final Integer timeoutInSeconds()

      How long the canary is allowed to run before it must stop.

      Returns:
      How long the canary is allowed to run before it must stop.

    • memoryInMB

      public final Integer memoryInMB()

      The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

      Returns:
      The maximum amount of memory available to the canary while it is running, in MB. This value must be a multiple of 64.

    • activeTracing

      public final Boolean activeTracing()

      Displays whether this canary run used active X-Ray tracing.

      Returns:
      Displays whether this canary run used active X-Ray tracing.

    • ephemeralStorage

      public final Integer ephemeralStorage()

      Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

      Returns:
      Specifies the amount of ephemeral storage (in MB) to allocate for the canary run during execution. This temporary storage is used for storing canary run artifacts (which are uploaded to an Amazon S3 bucket at the end of the run), and any canary browser operations. This temporary storage is cleared after the run is completed. Default storage value is 1024 MB.

    • toBuilder

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

    • builder

      public static CanaryRunConfigOutput.Builder builder()

    • serializableBuilderClass

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