com.amazonaws.services.pinpoint.model.Schedule Maven / Gradle / Ivy
/*
* Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.pinpoint.model;
import java.io.Serializable;
/**
* Shcedule that defines when a campaign is run.
*/
public class Schedule implements Serializable {
/**
* The scheduled time that the campaign ends in ISO 8601 format.
*/
private String endTime;
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*/
private String frequency;
/**
* Indicates whether the campaign schedule takes effect according to each
* user's local time.
*/
private Boolean isLocalTime;
/**
* The time during which the campaign sends no messages.
*/
private QuietTime quietTime;
/**
* The scheduled time that the campaign begins in ISO 8601 format.
*/
private String startTime;
/**
* 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
*/
private String timezone;
/**
* The scheduled time that the campaign ends in ISO 8601 format.
*
* @return The scheduled time that the campaign ends in ISO 8601 format.
*/
public String getEndTime() {
return endTime;
}
/**
* The scheduled time that the campaign ends in ISO 8601 format.
*
* @param endTime The scheduled time that the campaign ends in ISO 8601
* format.
*/
public void setEndTime(String endTime) {
this.endTime = endTime;
}
/**
* The scheduled time that the campaign ends in ISO 8601 format.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param endTime The scheduled time that the campaign ends in ISO 8601
* format.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Schedule withEndTime(String endTime) {
this.endTime = endTime;
return this;
}
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*
* @return How often the campaign delivers messages. Valid values: ONCE,
* HOURLY, DAILY, WEEKLY, MONTHLY
* @see Frequency
*/
public String getFrequency() {
return frequency;
}
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*
* @param frequency How often the campaign delivers messages. Valid values:
* ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
* @see Frequency
*/
public void setFrequency(String frequency) {
this.frequency = frequency;
}
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*
* @param frequency How often the campaign delivers messages. Valid values:
* ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
* @return A reference to this updated object so that method calls can be
* chained together.
* @see Frequency
*/
public Schedule withFrequency(String frequency) {
this.frequency = frequency;
return this;
}
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*
* @param frequency How often the campaign delivers messages. Valid values:
* ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
* @see Frequency
*/
public void setFrequency(Frequency frequency) {
this.frequency = frequency.toString();
}
/**
* How often the campaign delivers messages. Valid values: ONCE, HOURLY,
* DAILY, WEEKLY, MONTHLY
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* Constraints:
* Allowed Values: ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
*
* @param frequency How often the campaign delivers messages. Valid values:
* ONCE, HOURLY, DAILY, WEEKLY, MONTHLY
* @return A reference to this updated object so that method calls can be
* chained together.
* @see Frequency
*/
public Schedule withFrequency(Frequency frequency) {
this.frequency = frequency.toString();
return this;
}
/**
* Indicates whether the campaign schedule takes effect according to each
* user's local time.
*
* @return Indicates whether the campaign schedule takes effect according to
* each user's local time.
*/
public Boolean isIsLocalTime() {
return isLocalTime;
}
/**
* Indicates whether the campaign schedule takes effect according to each
* user's local time.
*
* @return Indicates whether the campaign schedule takes effect according to
* each user's local time.
*/
public Boolean getIsLocalTime() {
return isLocalTime;
}
/**
* Indicates whether the campaign schedule takes effect according to each
* user's local time.
*
* @param isLocalTime Indicates whether the campaign schedule takes effect
* according to each user's local time.
*/
public void setIsLocalTime(Boolean isLocalTime) {
this.isLocalTime = isLocalTime;
}
/**
* Indicates whether the campaign schedule takes effect according to each
* user's local time.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param isLocalTime Indicates whether the campaign schedule takes effect
* according to each user's local time.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Schedule withIsLocalTime(Boolean isLocalTime) {
this.isLocalTime = isLocalTime;
return this;
}
/**
* The time during which the campaign sends no messages.
*
* @return The time during which the campaign sends no messages.
*/
public QuietTime getQuietTime() {
return quietTime;
}
/**
* The time during which the campaign sends no messages.
*
* @param quietTime The time during which the campaign sends no messages.
*/
public void setQuietTime(QuietTime quietTime) {
this.quietTime = quietTime;
}
/**
* The time during which the campaign sends no messages.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param quietTime The time during which the campaign sends no messages.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Schedule withQuietTime(QuietTime quietTime) {
this.quietTime = quietTime;
return this;
}
/**
* The scheduled time that the campaign begins in ISO 8601 format.
*
* @return The scheduled time that the campaign begins in ISO 8601 format.
*/
public String getStartTime() {
return startTime;
}
/**
* The scheduled time that the campaign begins in ISO 8601 format.
*
* @param startTime The scheduled time that the campaign begins in ISO 8601
* format.
*/
public void setStartTime(String startTime) {
this.startTime = startTime;
}
/**
* The scheduled time that the campaign begins in ISO 8601 format.
*
* Returns a reference to this object so that method calls can be chained
* together.
*
* @param startTime The scheduled time that the campaign begins in ISO 8601
* format.
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Schedule withStartTime(String startTime) {
this.startTime = startTime;
return this;
}
/**
* 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
*
* @return 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
*/
public String getTimezone() {
return 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
*
* @param 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
*/
public void setTimezone(String timezone) {
this.timezone = 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 a reference to this object so that method calls can be chained
* together.
*
* @param 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
* @return A reference to this updated object so that method calls can be
* chained together.
*/
public Schedule withTimezone(String timezone) {
this.timezone = timezone;
return this;
}
/**
* Returns a string representation of this object; useful for testing and
* debugging.
*
* @return A string representation of this object.
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getEndTime() != null)
sb.append("EndTime: " + getEndTime() + ",");
if (getFrequency() != null)
sb.append("Frequency: " + getFrequency() + ",");
if (getIsLocalTime() != null)
sb.append("IsLocalTime: " + getIsLocalTime() + ",");
if (getQuietTime() != null)
sb.append("QuietTime: " + getQuietTime() + ",");
if (getStartTime() != null)
sb.append("StartTime: " + getStartTime() + ",");
if (getTimezone() != null)
sb.append("Timezone: " + getTimezone());
sb.append("}");
return sb.toString();
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getEndTime() == null) ? 0 : getEndTime().hashCode());
hashCode = prime * hashCode + ((getFrequency() == null) ? 0 : getFrequency().hashCode());
hashCode = prime * hashCode
+ ((getIsLocalTime() == null) ? 0 : getIsLocalTime().hashCode());
hashCode = prime * hashCode + ((getQuietTime() == null) ? 0 : getQuietTime().hashCode());
hashCode = prime * hashCode + ((getStartTime() == null) ? 0 : getStartTime().hashCode());
hashCode = prime * hashCode + ((getTimezone() == null) ? 0 : getTimezone().hashCode());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Schedule == false)
return false;
Schedule other = (Schedule) obj;
if (other.getEndTime() == null ^ this.getEndTime() == null)
return false;
if (other.getEndTime() != null && other.getEndTime().equals(this.getEndTime()) == false)
return false;
if (other.getFrequency() == null ^ this.getFrequency() == null)
return false;
if (other.getFrequency() != null
&& other.getFrequency().equals(this.getFrequency()) == false)
return false;
if (other.getIsLocalTime() == null ^ this.getIsLocalTime() == null)
return false;
if (other.getIsLocalTime() != null
&& other.getIsLocalTime().equals(this.getIsLocalTime()) == false)
return false;
if (other.getQuietTime() == null ^ this.getQuietTime() == null)
return false;
if (other.getQuietTime() != null
&& other.getQuietTime().equals(this.getQuietTime()) == false)
return false;
if (other.getStartTime() == null ^ this.getStartTime() == null)
return false;
if (other.getStartTime() != null
&& other.getStartTime().equals(this.getStartTime()) == false)
return false;
if (other.getTimezone() == null ^ this.getTimezone() == null)
return false;
if (other.getTimezone() != null && other.getTimezone().equals(this.getTimezone()) == false)
return false;
return true;
}
}