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 Summary

Modifier and Type	Method and Description
Schedule.Builder	endTime(String endTime) The scheduled time that the campaign ends in ISO 8601 format.
Schedule.Builder	eventFilter(CampaignEventFilter eventFilter) Defines the type of events that can trigger the campaign.
default Schedule.Builder	eventFilter(Consumer<CampaignEventFilter.Builder> eventFilter) Defines the type of events that can trigger the campaign.
Schedule.Builder	frequency(Frequency frequency) How often the campaign delivers messages.
Schedule.Builder	frequency(String frequency) How often the campaign delivers messages.
Schedule.Builder	isLocalTime(Boolean isLocalTime) Indicates whether the campaign schedule takes effect according to each user's local time.
default Schedule.Builder	quietTime(Consumer<QuietTime.Builder> quietTime) The default quiet time for the campaign.
Schedule.Builder	quietTime(QuietTime quietTime) The default quiet time for the campaign.
Schedule.Builder	startTime(String startTime) The scheduled time that the campaign begins in ISO 8601 format.
Schedule.Builder	timezone(String timezone) The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: 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 UTC-11

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

endTime

Schedule.Builder endTime(String endTime)

The scheduled time that the campaign ends in ISO 8601 format.

Parameters:

endTime - The scheduled time that the campaign ends in ISO 8601 format.

Returns:

Returns a reference to this object so that method calls can be chained together.

eventFilter

Schedule.Builder eventFilter(CampaignEventFilter eventFilter)

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.

Parameters:

eventFilter - Defines the type of events that can trigger the campaign. Used when the Frequency is set to 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)

Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT. This is a convenience 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:

eventFilter(CampaignEventFilter)

frequency

Schedule.Builder frequency(String frequency)

How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Parameters:

frequency - How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Frequency, Frequency

frequency

Schedule.Builder frequency(Frequency frequency)

How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Parameters:

frequency - How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

Frequency, Frequency

isLocalTime

Schedule.Builder isLocalTime(Boolean isLocalTime)

Indicates whether the campaign schedule takes effect according to each user's local time.

Parameters:

isLocalTime - Indicates whether the campaign schedule takes effect according to each user's local time.

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. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.

Parameters:

quietTime - The default quiet time for the campaign. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign.

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. The campaign doesn't send messages to endpoints during the quiet time. Note: Make sure that your endpoints include the Demographics.Timezone attribute if you plan to enable a quiet time for your campaign. If your endpoints don't include this attribute, they'll receive the messages that you send them, even if quiet time is enabled. When you set up a campaign to use quiet time, the campaign doesn't send messages during the time range you specified, as long as all of the following are true: - The endpoint includes a valid Demographic.Timezone attribute. - The current time in the endpoint's time zone is later than or equal to the time specified in the QuietTime.Start attribute for the campaign. - The current time in the endpoint's time zone is earlier than or equal to the time specified in the QuietTime.End attribute for the campaign. This is a convenience 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:

quietTime(QuietTime)

startTime

Schedule.Builder startTime(String startTime)

The scheduled time that the campaign begins in ISO 8601 format.

Parameters:

startTime - The scheduled time that the campaign begins 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 schedule if the value for isLocalTime is true Valid values: 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 UTC-11

Parameters:

timezone - The starting UTC offset for the schedule if the value for isLocalTime is true Valid values: 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 UTC-11

Returns:

Returns a reference to this object so that method calls can be chained together.