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:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ScheduledInstanceRecurrenceRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ScheduledInstanceRecurrenceRequest.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
String
frequency()
The frequency (Daily
,Weekly
, orMonthly
).<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasOccurrenceDays()
For responses, this returns true if the service returned a value for the OccurrenceDays property.Integer
interval()
The interval quantity.List<Integer>
occurrenceDays()
The days.Boolean
occurrenceRelativeToEnd()
Indicates whether the occurrence is relative to the end of the specified week or month.String
occurrenceUnit()
The unit forOccurrenceDays
(DayOfWeek
orDayOfMonth
).List<SdkField<?>>
sdkFields()
static Class<? extends ScheduledInstanceRecurrenceRequest.Builder>
serializableBuilderClass()
ScheduledInstanceRecurrenceRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
frequency
public final String frequency()
The frequency (
Daily
,Weekly
, orMonthly
).- Returns:
- The frequency (
Daily
,Weekly
, orMonthly
).
-
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 theisEmpty()
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
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.- Returns:
- The unit for
OccurrenceDays
(DayOfWeek
orDayOfMonth
). This value is required for a monthly schedule. You can't specifyDayOfWeek
with a weekly schedule. You can't specify this value with a daily schedule.
-
toBuilder
public ScheduledInstanceRecurrenceRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ScheduledInstanceRecurrenceRequest.Builder,ScheduledInstanceRecurrenceRequest>
-
builder
public static ScheduledInstanceRecurrenceRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ScheduledInstanceRecurrenceRequest.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-