Class RecurrenceSettings
- java.lang.Object
-
- software.amazon.awssdk.services.ssmcontacts.model.RecurrenceSettings
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RecurrenceSettings.Builder,RecurrenceSettings>
@Generated("software.amazon.awssdk:codegen") public final class RecurrenceSettings extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RecurrenceSettings.Builder,RecurrenceSettings>
Information about when an on-call rotation is in effect and how long the rotation period lasts.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRecurrenceSettings.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static RecurrenceSettings.Builderbuilder()List<HandOffTime>dailySettings()Information about on-call rotations that recur daily.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDailySettings()For responses, this returns true if the service returned a value for the DailySettings property.inthashCode()booleanhasMonthlySettings()For responses, this returns true if the service returned a value for the MonthlySettings property.booleanhasShiftCoverages()For responses, this returns true if the service returned a value for the ShiftCoverages property.booleanhasWeeklySettings()For responses, this returns true if the service returned a value for the WeeklySettings property.List<MonthlySetting>monthlySettings()Information about on-call rotations that recur monthly.IntegernumberOfOnCalls()The number of contacts, or shift team members designated to be on call concurrently during a shift.IntegerrecurrenceMultiplier()The number of days, weeks, or months a single rotation lasts.List<SdkField<?>>sdkFields()static Class<? extends RecurrenceSettings.Builder>serializableBuilderClass()Map<DayOfWeek,List<CoverageTime>>shiftCoverages()Information about the days of the week included in on-call rotation coverage.Map<String,List<CoverageTime>>shiftCoveragesAsStrings()Information about the days of the week included in on-call rotation coverage.RecurrenceSettings.BuildertoBuilder()StringtoString()Returns a string representation of this object.List<WeeklySetting>weeklySettings()Information about on-call rotations that recur weekly.-
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
-
hasMonthlySettings
public final boolean hasMonthlySettings()
For responses, this returns true if the service returned a value for the MonthlySettings 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.
-
monthlySettings
public final List<MonthlySetting> monthlySettings()
Information about on-call rotations that recur monthly.
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
hasMonthlySettings()method.- Returns:
- Information about on-call rotations that recur monthly.
-
hasWeeklySettings
public final boolean hasWeeklySettings()
For responses, this returns true if the service returned a value for the WeeklySettings 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.
-
weeklySettings
public final List<WeeklySetting> weeklySettings()
Information about on-call rotations that recur weekly.
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
hasWeeklySettings()method.- Returns:
- Information about on-call rotations that recur weekly.
-
hasDailySettings
public final boolean hasDailySettings()
For responses, this returns true if the service returned a value for the DailySettings 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.
-
dailySettings
public final List<HandOffTime> dailySettings()
Information about on-call rotations that recur daily.
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
hasDailySettings()method.- Returns:
- Information about on-call rotations that recur daily.
-
numberOfOnCalls
public final Integer numberOfOnCalls()
The number of contacts, or shift team members designated to be on call concurrently during a shift. For example, in an on-call schedule containing ten contacts, a value of
2designates that two of them are on call at any given time.- Returns:
- The number of contacts, or shift team members designated to be on call concurrently during a shift. For
example, in an on-call schedule containing ten contacts, a value of
2designates that two of them are on call at any given time.
-
shiftCoverages
public final Map<DayOfWeek,List<CoverageTime>> shiftCoverages()
Information about the days of the week included in on-call rotation coverage.
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
hasShiftCoverages()method.- Returns:
- Information about the days of the week included in on-call rotation coverage.
-
hasShiftCoverages
public final boolean hasShiftCoverages()
For responses, this returns true if the service returned a value for the ShiftCoverages 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.
-
shiftCoveragesAsStrings
public final Map<String,List<CoverageTime>> shiftCoveragesAsStrings()
Information about the days of the week included in on-call rotation coverage.
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
hasShiftCoverages()method.- Returns:
- Information about the days of the week included in on-call rotation coverage.
-
recurrenceMultiplier
public final Integer recurrenceMultiplier()
The number of days, weeks, or months a single rotation lasts.
- Returns:
- The number of days, weeks, or months a single rotation lasts.
-
toBuilder
public RecurrenceSettings.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RecurrenceSettings.Builder,RecurrenceSettings>
-
builder
public static RecurrenceSettings.Builder builder()
-
serializableBuilderClass
public static Class<? extends RecurrenceSettings.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin 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.
-
-