Class CanaryScheduleInput

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

This structure specifies how often a canary is to make runs and the date and time when it should stop making runs.

See Also:

  • Method Details

    • expression

      public final String expression()

      A rate expression or a cron expression that defines how often the canary is to run.

      For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

      For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

      Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

      Returns:
      A rate expression or a cron expression that defines how often the canary is to run.

      For a rate expression, The syntax is rate(number unit). unit can be minute, minutes, or hour.

      For example, rate(1 minute) runs the canary once a minute, rate(10 minutes) runs it once every 10 minutes, and rate(1 hour) runs it once every hour. You can specify a frequency between rate(1 minute) and rate(1 hour).

      Specifying rate(0 minute) or rate(0 hour) is a special value that causes the canary to run only once when it is started.

      Use cron(expression) to specify a cron expression. You can't schedule a canary to wait for more than a year before running. For information about the syntax for cron expressions, see Scheduling canary runs using cron.

    • durationInSeconds

      public final Long durationInSeconds()

      How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

      Returns:
      How long, in seconds, for the canary to continue making regular runs according to the schedule in the Expression value. If you specify 0, the canary continues making runs until you stop it. If you omit this field, the default of 0 is used.

    • retryConfig

      public final RetryConfigInput retryConfig()

      A structure that contains the retry configuration for a canary

      Returns:
      A structure that contains the retry configuration for a canary

    • toBuilder

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

    • builder

      public static CanaryScheduleInput.Builder builder()

    • serializableBuilderClass

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