Schedule (AWS SDK for Java

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.
`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 time during which the campaign sends no messages.
`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)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEndTime(String endTime)` The scheduled time that the campaign ends in ISO 8601 format.
`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 time during which the campaign sends no messages.
`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; useful for testing and debugging.
`Schedule`	`withEndTime(String endTime)` The scheduled time that the campaign ends in ISO 8601 format.
`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 time during which the campaign sends no messages.
`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
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.
  - setFrequency
```
public void setFrequency(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
    
    See Also:
    
    Frequency
  - getFrequency
```
public String getFrequency()
```
    How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    
    Returns:
    
    How often the campaign delivers messages. Valid values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
    
    See Also:
    
    Frequency
  - withFrequency
```
public Schedule withFrequency(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
  - setFrequency
```
public void setFrequency(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
    
    See Also:
    
    Frequency
  - withFrequency
```
public Schedule withFrequency(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
  - 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 time during which the campaign sends no messages.
    
    Parameters:
    
    quietTime - The time during which the campaign sends no messages.
  - getQuietTime
```
public QuietTime getQuietTime()
```
    The time during which the campaign sends no messages.
    
    Returns:
    
    The time during which the campaign sends no messages.
  - withQuietTime
```
public Schedule withQuietTime(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.
  - 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; useful for testing and debugging.
    
    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)
```
    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.

Did this page help you?

Class Schedule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Schedule

Method Detail

setEndTime

getEndTime

withEndTime

setFrequency

getFrequency

withFrequency

setFrequency

withFrequency

setIsLocalTime

getIsLocalTime

withIsLocalTime

isLocalTime

setQuietTime

getQuietTime

withQuietTime

setStartTime

getStartTime

withStartTime

setTimezone

getTimezone

withTimezone

toString

equals

hashCode

clone

marshall