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:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Schedule.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Schedule.Builder`	`builder()`
`String`	`endTime()`	The scheduled time, in ISO 8601 format, when the campaign ended or will end.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`CampaignEventFilter`	`eventFilter()`	The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
`Frequency`	`frequency()`	Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
`String`	`frequencyAsString()`	Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Boolean`	`isLocalTime()`	Specifies whether the start and end times for the campaign schedule use each recipient's local time.
`QuietTime`	`quietTime()`	The default quiet time for the campaign.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Schedule.Builder>`	`serializableBuilderClass()`
`String`	`startTime()`	The scheduled time when the campaign began or will begin.
`String`	`timezone()`	The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.
`Schedule.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - 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:
    
    Frequency
  - 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:
    
    Frequency
  - 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()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Schedule.Builder,Schedule>
  - 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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class Schedule

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

endTime

eventFilter

frequency

frequencyAsString

isLocalTime

quietTime

startTime

timezone

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields