Package software.amazon.awssdk.services.arczonalshift.model

Class PracticeRunConfiguration

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

A practice run configuration for a resource includes the Amazon CloudWatch alarms that you've specified for a practice run, as well as any blocked dates or blocked windows for the practice run.

You can update or delete a practice run configuration. Before you delete a practice run configuration, you must disable zonal autoshift for the resource. A practice run configuration is required when zonal autoshift is enabled.

See Also:

  • Method Details

    • hasBlockedDates

      public final boolean hasBlockedDates()
      For responses, this returns true if the service returned a value for the BlockedDates property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockedDates

      public final List<String> blockedDates()

      An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.

      Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockedDates() method.

      Returns:
      An array of one or more dates that you can specify when Amazon Web Services does not start practice runs for a resource.

      Specify blocked dates, in UTC, in the format YYYY-MM-DD, separated by spaces.

    • hasBlockedWindows

      public final boolean hasBlockedWindows()
      For responses, this returns true if the service returned a value for the BlockedWindows property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockedWindows

      public final List<String> blockedWindows()

      An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.

      Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockedWindows() method.

      Returns:
      An array of one or more windows of days and times that you can block Route 53 ARC from starting practice runs for a resource.

      Specify the blocked windows in UTC, using the format DAY:HH:MM-DAY:HH:MM, separated by spaces. For example, MON:18:30-MON:19:30 TUE:18:30-TUE:19:30.

    • hasBlockingAlarms

      public final boolean hasBlockingAlarms()
      For responses, this returns true if the service returned a value for the BlockingAlarms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • blockingAlarms

      public final List<ControlCondition> blockingAlarms()

      The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBlockingAlarms() method.

      Returns:
      The blocking alarm for practice runs is an optional alarm that you can specify that blocks practice runs when the alarm is in an ALARM state.

    • hasOutcomeAlarms

      public final boolean hasOutcomeAlarms()
      For responses, this returns true if the service returned a value for the OutcomeAlarms property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • outcomeAlarms

      public final List<ControlCondition> outcomeAlarms()

      The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOutcomeAlarms() method.

      Returns:
      The outcome alarm for practice runs is an alarm that you specify that ends a practice run when the alarm is in an ALARM state.

    • toBuilder

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

    • builder

      public static PracticeRunConfiguration.Builder builder()

    • serializableBuilderClass

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