software.amazon.awssdk.services.pinpoint.model

Class Schedule

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.Schedule

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<Schedule.Builder,Schedule>

@Generated(value="software.amazon.awssdk:codegen")
public class Schedule
extends Object
implements StructuredPojo, ToCopyableBuilder<Schedule.Builder,Schedule>

Shcedule that defines when a campaign is run.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Schedule.Builder

Method Summary

Modifier and Type	Method and Description
static Schedule.Builder	builder()
String	endTime() The scheduled time that the campaign ends in ISO 8601 format.
boolean	equals(Object obj)
Frequency	frequency() How often the campaign delivers messages.
String	frequencyAsString() How often the campaign delivers messages.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	isLocalTime() Indicates whether the campaign schedule takes effect according to each user's local time.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
QuietTime	quietTime() The time during which the campaign sends no messages.
static Class<? extends Schedule.Builder>	serializableBuilderClass()
String	startTime() The scheduled time that the campaign begins in ISO 8601 format.
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
Schedule.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

endTime

public String endTime()

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

Returns:

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

frequency

public Frequency frequency()

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

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:

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

See Also:

Frequency

frequencyAsString

public String frequencyAsString()

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

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:

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

See Also:

Frequency

isLocalTime

public Boolean isLocalTime()

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

Returns:

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

quietTime

public QuietTime quietTime()

The time during which the campaign sends no messages.

Returns:

The time during which the campaign sends no messages.

startTime

public String startTime()

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

Returns:

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

timezone

public 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

Returns:

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

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 int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.