@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class Schedule extends Object implements Serializable, Cloneable, StructuredPojo
Specifies the schedule settings for a campaign.
Constructor and Description |
---|
Schedule() |
Modifier and Type | Method and Description |
---|---|
Schedule |
clone() |
boolean |
equals(Object obj) |
String |
getEndTime()
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
|
CampaignEventFilter |
getEventFilter()
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
|
String |
getFrequency()
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
|
Boolean |
getIsLocalTime()
Specifies whether the start and end times for the campaign schedule use each recipient's local time.
|
QuietTime |
getQuietTime()
The default quiet time for the campaign.
|
String |
getStartTime()
The scheduled time when the campaign began or will begin.
|
String |
getTimezone()
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.
|
int |
hashCode() |
Boolean |
isLocalTime()
Specifies whether the start and end times for the campaign schedule use each recipient's local time.
|
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setEndTime(String endTime)
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
|
void |
setEventFilter(CampaignEventFilter eventFilter)
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
|
void |
setFrequency(Frequency frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
|
void |
setFrequency(String frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
|
void |
setIsLocalTime(Boolean isLocalTime)
Specifies whether the start and end times for the campaign schedule use each recipient's local time.
|
void |
setQuietTime(QuietTime quietTime)
The default quiet time for the campaign.
|
void |
setStartTime(String startTime)
The scheduled time when the campaign began or will begin.
|
void |
setTimezone(String timezone)
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.
|
String |
toString()
Returns a string representation of this object.
|
Schedule |
withEndTime(String endTime)
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
|
Schedule |
withEventFilter(CampaignEventFilter eventFilter)
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
|
Schedule |
withFrequency(Frequency frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
|
Schedule |
withFrequency(String frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
|
Schedule |
withIsLocalTime(Boolean isLocalTime)
Specifies whether the start and end times for the campaign schedule use each recipient's local time.
|
Schedule |
withQuietTime(QuietTime quietTime)
The default quiet time for the campaign.
|
Schedule |
withStartTime(String startTime)
The scheduled time when the campaign began or will begin.
|
Schedule |
withTimezone(String timezone)
The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true.
|
public void setEndTime(String endTime)
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
endTime
- The scheduled time, in ISO 8601 format, when the campaign ended or will end.public String getEndTime()
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
public Schedule withEndTime(String endTime)
The scheduled time, in ISO 8601 format, when the campaign ended or will end.
endTime
- The scheduled time, in ISO 8601 format, when the campaign ended or will end.public void setEventFilter(CampaignEventFilter eventFilter)
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
eventFilter
- The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.public CampaignEventFilter getEventFilter()
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
public Schedule withEventFilter(CampaignEventFilter eventFilter)
The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
eventFilter
- The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.public void setFrequency(String frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
frequency
- Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.Frequency
public String getFrequency()
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
Frequency
public Schedule withFrequency(String frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
frequency
- Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.Frequency
public void setFrequency(Frequency frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
frequency
- Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.Frequency
public Schedule withFrequency(Frequency frequency)
Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
frequency
- Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.Frequency
public void setIsLocalTime(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.
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.public Boolean getIsLocalTime()
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.
public Schedule withIsLocalTime(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.
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.public 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.
public void setQuietTime(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.
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.
public QuietTime getQuietTime()
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.
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.
public Schedule withQuietTime(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.
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.
public void setStartTime(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.
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.public String getStartTime()
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.
public Schedule withStartTime(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.
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.public void setTimezone(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.
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.public String getTimezone()
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.
public Schedule withTimezone(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.
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.public String toString()
toString
in class Object
Object.toString()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.