Schedule (AWS Java SDK for Amazon Pinpoint 1.11.478 API)

java.lang.Object
- com.amazonaws.services.pinpoint.model.Schedule

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Schedule
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Shcedule that defines when a campaign is run.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Schedule()

Constructors
Constructor and Description
`Schedule()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Schedule`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEndTime()` The scheduled time that the campaign ends in ISO 8601 format.
`CampaignEventFilter`	`getEventFilter()` Defines the type of events that can trigger the campaign.
`String`	`getFrequency()` How often the campaign delivers messages.
`Boolean`	`getIsLocalTime()` Indicates whether the campaign schedule takes effect according to each user's local time.
`QuietTime`	`getQuietTime()` The default quiet time for the campaign.
`String`	`getStartTime()` The scheduled time that the campaign begins in ISO 8601 format.
`String`	`getTimezone()` 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
`int`	`hashCode()`
`Boolean`	`isLocalTime()` Indicates whether the campaign schedule takes effect according to each user's local time.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setEndTime(String endTime)` The scheduled time that the campaign ends in ISO 8601 format.
`void`	`setEventFilter(CampaignEventFilter eventFilter)` Defines the type of events that can trigger the campaign.
`void`	`setFrequency(Frequency frequency)` How often the campaign delivers messages.
`void`	`setFrequency(String frequency)` How often the campaign delivers messages.
`void`	`setIsLocalTime(Boolean isLocalTime)` Indicates whether the campaign schedule takes effect according to each user's local time.
`void`	`setQuietTime(QuietTime quietTime)` The default quiet time for the campaign.
`void`	`setStartTime(String startTime)` The scheduled time that the campaign begins in ISO 8601 format.
`void`	`setTimezone(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
`String`	`toString()` Returns a string representation of this object.
`Schedule`	`withEndTime(String endTime)` The scheduled time that the campaign ends in ISO 8601 format.
`Schedule`	`withEventFilter(CampaignEventFilter eventFilter)` Defines the type of events that can trigger the campaign.
`Schedule`	`withFrequency(Frequency frequency)` How often the campaign delivers messages.
`Schedule`	`withFrequency(String frequency)` How often the campaign delivers messages.
`Schedule`	`withIsLocalTime(Boolean isLocalTime)` Indicates whether the campaign schedule takes effect according to each user's local time.
`Schedule`	`withQuietTime(QuietTime quietTime)` The default quiet time for the campaign.
`Schedule`	`withStartTime(String startTime)` The scheduled time that the campaign begins in ISO 8601 format.
`Schedule`	`withTimezone(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 class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Schedule
```
public Schedule()
```
- Method Detail
  - setEndTime
```
public void setEndTime(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.
  - getEndTime
```
public String getEndTime()
```
    The scheduled time that the campaign ends in ISO 8601 format.
    
    Returns:
    
    The scheduled time that the campaign ends in ISO 8601 format.
  - withEndTime
```
public Schedule withEndTime(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.
  - setEventFilter
```
public void setEventFilter(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.
  - getEventFilter
```
public CampaignEventFilter getEventFilter()
```
    Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
    
    Returns:
    
    Defines the type of events that can trigger the campaign. Used when the Frequency is set to EVENT.
  - withEventFilter
```
public Schedule withEventFilter(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.
  - setFrequency
```
public void setFrequency(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
    
    See Also:
    
    Frequency
  - getFrequency
```
public String getFrequency()
```
    How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    
    Returns:
    
    How often the campaign delivers messages. Valid values: ONCE HOURLY DAILY WEEKLY MONTHLY EVENT
    
    See Also:
    
    Frequency
  - withFrequency
```
public Schedule withFrequency(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
  - setFrequency
```
public void setFrequency(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
    
    See Also:
    
    Frequency
  - withFrequency
```
public Schedule withFrequency(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
  - setIsLocalTime
```
public void setIsLocalTime(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.
  - getIsLocalTime
```
public Boolean getIsLocalTime()
```
    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.
  - withIsLocalTime
```
public Schedule withIsLocalTime(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.
  - 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.
  - setQuietTime
```
public void setQuietTime(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.
  - getQuietTime
```
public QuietTime getQuietTime()
```
    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:
    
    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.
  - withQuietTime
```
public Schedule withQuietTime(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.
  - setStartTime
```
public void setStartTime(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.
  - getStartTime
```
public String getStartTime()
```
    The scheduled time that the campaign begins in ISO 8601 format.
    
    Returns:
    
    The scheduled time that the campaign begins in ISO 8601 format.
  - withStartTime
```
public Schedule withStartTime(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.
  - setTimezone
```
public void setTimezone(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
  - getTimezone
```
public String getTimezone()
```
    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
  - withTimezone
```
public Schedule withTimezone(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.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Schedule clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Schedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Method Detail

setEndTime

getEndTime

withEndTime

setEventFilter

getEventFilter

withEventFilter

setFrequency

getFrequency

withFrequency

setFrequency

withFrequency

setIsLocalTime

getIsLocalTime

withIsLocalTime

isLocalTime

setQuietTime

getQuietTime

withQuietTime

setStartTime

getStartTime

withStartTime

setTimezone

getTimezone

withTimezone

toString

equals

hashCode

clone

marshall