Package software.amazon.awssdk.services.ec2.model

Class ScheduledInstanceRecurrenceRequest

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

Describes the recurring schedule for a Scheduled Instance.

See Also:

  • Method Details

    • frequency

      public final String frequency()

      The frequency (Daily, Weekly, or Monthly).

      Returns:
      The frequency (Daily, Weekly, or Monthly).

    • interval

      public final Integer interval()

      The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

      Returns:
      The interval quantity. The interval unit depends on the value of Frequency. For example, every 2 weeks or every 2 months.

    • hasOccurrenceDays

      public final boolean hasOccurrenceDays()
      For responses, this returns true if the service returned a value for the OccurrenceDays 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.

    • occurrenceDays

      public final List<Integer> occurrenceDays()

      The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

      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 hasOccurrenceDays() method.

      Returns:
      The days. For a monthly schedule, this is one or more days of the month (1-31). For a weekly schedule, this is one or more days of the week (1-7, where 1 is Sunday). You can't specify this value with a daily schedule. If the occurrence is relative to the end of the month, you can specify only a single day.

    • occurrenceRelativeToEnd

      public final Boolean occurrenceRelativeToEnd()

      Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

      Returns:
      Indicates whether the occurrence is relative to the end of the specified week or month. You can't specify this value with a daily schedule.

    • occurrenceUnit

      public final String occurrenceUnit()

      The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

      Returns:
      The unit for OccurrenceDays (DayOfWeek or DayOfMonth). This value is required for a monthly schedule. You can't specify DayOfWeek with a weekly schedule. You can't specify this value with a daily schedule.

    • toBuilder

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

    • builder

      public static ScheduledInstanceRecurrenceRequest.Builder builder()

    • serializableBuilderClass

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