software.amazon.awssdk.services.pinpoint.model

Interface Schedule.Builder

All Superinterfaces:

CopyableBuilder<Schedule.Builder,Schedule>, SdkBuilder<Schedule.Builder,Schedule>

Enclosing class:

Schedule

public static interface Schedule.Builder
extends 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	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 time during which the campaign sends no messages.
Schedule.Builder	quietTime(QuietTime quietTime) The time during which the campaign sends no messages.
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.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.

frequency

Schedule.Builder frequency(String frequency)

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

Parameters:

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

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

Parameters:

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

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 time during which the campaign sends no messages.

Parameters:

quietTime - The time during which the campaign sends no messages.

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 time during which the campaign sends no messages. 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.