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:

  • Method Details

    • 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 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.

    • 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 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.

    • 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 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.

    • 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 2 designates 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 2 designates 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 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.

    • 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()
      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<RecurrenceSettings.Builder,RecurrenceSettings>
      Returns:
      a builder for type T

    • builder

      public static RecurrenceSettings.Builder builder()

    • serializableBuilderClass

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