Package software.amazon.awssdk.services.pinpoint.model

Interface Schedule.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Schedule.Builder,Schedule>, SdkBuilder<Schedule.Builder,Schedule>, SdkPojo
Enclosing class:
Schedule
public static interface Schedule.Builder extends SdkPojo, CopyableBuilder<Schedule.Builder,Schedule>

  • Method Details

    • endTime

      Schedule.Builder endTime(String endTime)

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

      Parameters:
      endTime - The scheduled time, in ISO 8601 format, when the campaign ended or will end.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventFilter

      Schedule.Builder eventFilter(CampaignEventFilter eventFilter)

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

      Parameters:
      eventFilter - The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • eventFilter

      default Schedule.Builder eventFilter(Consumer<CampaignEventFilter.Builder> eventFilter)

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

      This is a convenience method that creates an instance of the CampaignEventFilter.Builder avoiding the need to create one manually via CampaignEventFilter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to eventFilter(CampaignEventFilter).

      Parameters:
      eventFilter - a consumer that will call methods on CampaignEventFilter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frequency

      Schedule.Builder frequency(String frequency)

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

      Parameters:
      frequency - Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • frequency

      Schedule.Builder frequency(Frequency frequency)

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

      Parameters:
      frequency - Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • isLocalTime

      Schedule.Builder isLocalTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • quietTime

      Schedule.Builder quietTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • quietTime

      default Schedule.Builder quietTime(Consumer<QuietTime.Builder> 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.

      This is a convenience method that creates an instance of the QuietTime.Builder avoiding the need to create one manually via QuietTime.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to quietTime(QuietTime).

      Parameters:
      quietTime - a consumer that will call methods on QuietTime.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • startTime

      Schedule.Builder startTime(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • timezone

      Schedule.Builder timezone(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.