java.lang.Object
software.amazon.awssdk.services.pinpoint.model.Schedule
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Schedule.Builder,Schedule>

@Generated("software.amazon.awssdk:codegen") public final class Schedule extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Schedule.Builder,Schedule>

Specifies the schedule settings for a campaign.

See Also:
  • Method Details

    • endTime

      public final String endTime()

      The scheduled time, in ISO 8601 format, when the campaign ended or will end.

      Returns:
      The scheduled time, in ISO 8601 format, when the campaign ended or will end.
    • eventFilter

      public final CampaignEventFilter eventFilter()

      The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.

      Returns:
      The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
    • frequency

      public final Frequency frequency()

      Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

      If the service returns an enum value that is not available in the current SDK version, frequency will return Frequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().

      Returns:
      Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
      See Also:
    • frequencyAsString

      public final String frequencyAsString()

      Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.

      If the service returns an enum value that is not available in the current SDK version, frequency will return Frequency.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from frequencyAsString().

      Returns:
      Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
      See Also:
    • isLocalTime

      public final Boolean isLocalTime()

      Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.

      Returns:
      Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
    • quietTime

      public final QuietTime quietTime()

      The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

      • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

      • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

      • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

      If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

      Returns:
      The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met:

      • The EndpointDemographic.Timezone property of the endpoint is set to a valid value.

      • The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign.

      • The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign.

      If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.

    • startTime

      public final String startTime()

      The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.

      Returns:
      The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
    • timezone

      public final String timezone()

      The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.

      Returns:
      The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30, UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
    • toBuilder

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

      public static Schedule.Builder builder()
    • serializableBuilderClass

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