/*
* Copyright 2012-2017 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;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
* Used to create a campaign.
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class WriteCampaignRequest implements Serializable, Cloneable, StructuredPojo {
/** Treatments that are defined in addition to the default treatment. */
private java.util.List<WriteTreatmentResource> additionalTreatments;
/** A description of the campaign. */
private String description;
/** The allocated percentage of end users who will not receive messages from this campaign. */
private Integer holdoutPercent;
/**
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*/
private Boolean isPaused;
/** The campaign limits settings. */
private CampaignLimits limits;
/** The message configuration settings. */
private MessageConfiguration messageConfiguration;
/** The custom name of the campaign. */
private String name;
/** The campaign schedule. */
private Schedule schedule;
/** The ID of the segment to which the campaign sends messages. */
private String segmentId;
/** The version of the segment to which the campaign sends messages. */
private Integer segmentVersion;
/** A custom description for the treatment. */
private String treatmentDescription;
/** The custom name of a variation of the campaign used for A/B testing. */
private String treatmentName;
/**
* Treatments that are defined in addition to the default treatment.
*
* @return Treatments that are defined in addition to the default treatment.
*/
public java.util.List<WriteTreatmentResource> getAdditionalTreatments() {
return additionalTreatments;
}
/**
* Treatments that are defined in addition to the default treatment.
*
* @param additionalTreatments
* Treatments that are defined in addition to the default treatment.
*/
public void setAdditionalTreatments(java.util.Collection<WriteTreatmentResource> additionalTreatments) {
if (additionalTreatments == null) {
this.additionalTreatments = null;
return;
}
this.additionalTreatments = new java.util.ArrayList<WriteTreatmentResource>(additionalTreatments);
}
/**
* Treatments that are defined in addition to the default treatment.
* <p>
* <b>NOTE:</b> This method appends the values to the existing list (if any). Use
* {@link #setAdditionalTreatments(java.util.Collection)} or {@link #withAdditionalTreatments(java.util.Collection)}
* if you want to override the existing values.
* </p>
*
* @param additionalTreatments
* Treatments that are defined in addition to the default treatment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withAdditionalTreatments(WriteTreatmentResource... additionalTreatments) {
if (this.additionalTreatments == null) {
setAdditionalTreatments(new java.util.ArrayList<WriteTreatmentResource>(additionalTreatments.length));
}
for (WriteTreatmentResource ele : additionalTreatments) {
this.additionalTreatments.add(ele);
}
return this;
}
/**
* Treatments that are defined in addition to the default treatment.
*
* @param additionalTreatments
* Treatments that are defined in addition to the default treatment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withAdditionalTreatments(java.util.Collection<WriteTreatmentResource> additionalTreatments) {
setAdditionalTreatments(additionalTreatments);
return this;
}
/**
* A description of the campaign.
*
* @param description
* A description of the campaign.
*/
public void setDescription(String description) {
this.description = description;
}
/**
* A description of the campaign.
*
* @return A description of the campaign.
*/
public String getDescription() {
return this.description;
}
/**
* A description of the campaign.
*
* @param description
* A description of the campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withDescription(String description) {
setDescription(description);
return this;
}
/**
* The allocated percentage of end users who will not receive messages from this campaign.
*
* @param holdoutPercent
* The allocated percentage of end users who will not receive messages from this campaign.
*/
public void setHoldoutPercent(Integer holdoutPercent) {
this.holdoutPercent = holdoutPercent;
}
/**
* The allocated percentage of end users who will not receive messages from this campaign.
*
* @return The allocated percentage of end users who will not receive messages from this campaign.
*/
public Integer getHoldoutPercent() {
return this.holdoutPercent;
}
/**
* The allocated percentage of end users who will not receive messages from this campaign.
*
* @param holdoutPercent
* The allocated percentage of end users who will not receive messages from this campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withHoldoutPercent(Integer holdoutPercent) {
setHoldoutPercent(holdoutPercent);
return this;
}
/**
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*
* @param isPaused
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*/
public void setIsPaused(Boolean isPaused) {
this.isPaused = isPaused;
}
/**
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*
* @return Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it
* by setting IsPaused to false.
*/
public Boolean getIsPaused() {
return this.isPaused;
}
/**
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*
* @param isPaused
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withIsPaused(Boolean isPaused) {
setIsPaused(isPaused);
return this;
}
/**
* Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it by
* setting IsPaused to false.
*
* @return Indicates whether the campaign is paused. A paused campaign does not send messages unless you resume it
* by setting IsPaused to false.
*/
public Boolean isPaused() {
return this.isPaused;
}
/**
* The campaign limits settings.
*
* @param limits
* The campaign limits settings.
*/
public void setLimits(CampaignLimits limits) {
this.limits = limits;
}
/**
* The campaign limits settings.
*
* @return The campaign limits settings.
*/
public CampaignLimits getLimits() {
return this.limits;
}
/**
* The campaign limits settings.
*
* @param limits
* The campaign limits settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withLimits(CampaignLimits limits) {
setLimits(limits);
return this;
}
/**
* The message configuration settings.
*
* @param messageConfiguration
* The message configuration settings.
*/
public void setMessageConfiguration(MessageConfiguration messageConfiguration) {
this.messageConfiguration = messageConfiguration;
}
/**
* The message configuration settings.
*
* @return The message configuration settings.
*/
public MessageConfiguration getMessageConfiguration() {
return this.messageConfiguration;
}
/**
* The message configuration settings.
*
* @param messageConfiguration
* The message configuration settings.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withMessageConfiguration(MessageConfiguration messageConfiguration) {
setMessageConfiguration(messageConfiguration);
return this;
}
/**
* The custom name of the campaign.
*
* @param name
* The custom name of the campaign.
*/
public void setName(String name) {
this.name = name;
}
/**
* The custom name of the campaign.
*
* @return The custom name of the campaign.
*/
public String getName() {
return this.name;
}
/**
* The custom name of the campaign.
*
* @param name
* The custom name of the campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withName(String name) {
setName(name);
return this;
}
/**
* The campaign schedule.
*
* @param schedule
* The campaign schedule.
*/
public void setSchedule(Schedule schedule) {
this.schedule = schedule;
}
/**
* The campaign schedule.
*
* @return The campaign schedule.
*/
public Schedule getSchedule() {
return this.schedule;
}
/**
* The campaign schedule.
*
* @param schedule
* The campaign schedule.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withSchedule(Schedule schedule) {
setSchedule(schedule);
return this;
}
/**
* The ID of the segment to which the campaign sends messages.
*
* @param segmentId
* The ID of the segment to which the campaign sends messages.
*/
public void setSegmentId(String segmentId) {
this.segmentId = segmentId;
}
/**
* The ID of the segment to which the campaign sends messages.
*
* @return The ID of the segment to which the campaign sends messages.
*/
public String getSegmentId() {
return this.segmentId;
}
/**
* The ID of the segment to which the campaign sends messages.
*
* @param segmentId
* The ID of the segment to which the campaign sends messages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withSegmentId(String segmentId) {
setSegmentId(segmentId);
return this;
}
/**
* The version of the segment to which the campaign sends messages.
*
* @param segmentVersion
* The version of the segment to which the campaign sends messages.
*/
public void setSegmentVersion(Integer segmentVersion) {
this.segmentVersion = segmentVersion;
}
/**
* The version of the segment to which the campaign sends messages.
*
* @return The version of the segment to which the campaign sends messages.
*/
public Integer getSegmentVersion() {
return this.segmentVersion;
}
/**
* The version of the segment to which the campaign sends messages.
*
* @param segmentVersion
* The version of the segment to which the campaign sends messages.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withSegmentVersion(Integer segmentVersion) {
setSegmentVersion(segmentVersion);
return this;
}
/**
* A custom description for the treatment.
*
* @param treatmentDescription
* A custom description for the treatment.
*/
public void setTreatmentDescription(String treatmentDescription) {
this.treatmentDescription = treatmentDescription;
}
/**
* A custom description for the treatment.
*
* @return A custom description for the treatment.
*/
public String getTreatmentDescription() {
return this.treatmentDescription;
}
/**
* A custom description for the treatment.
*
* @param treatmentDescription
* A custom description for the treatment.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withTreatmentDescription(String treatmentDescription) {
setTreatmentDescription(treatmentDescription);
return this;
}
/**
* The custom name of a variation of the campaign used for A/B testing.
*
* @param treatmentName
* The custom name of a variation of the campaign used for A/B testing.
*/
public void setTreatmentName(String treatmentName) {
this.treatmentName = treatmentName;
}
/**
* The custom name of a variation of the campaign used for A/B testing.
*
* @return The custom name of a variation of the campaign used for A/B testing.
*/
public String getTreatmentName() {
return this.treatmentName;
}
/**
* The custom name of a variation of the campaign used for A/B testing.
*
* @param treatmentName
* The custom name of a variation of the campaign used for A/B testing.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public WriteCampaignRequest withTreatmentName(String treatmentName) {
setTreatmentName(treatmentName);
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 (getAdditionalTreatments() != null)
sb.append("AdditionalTreatments: ").append(getAdditionalTreatments()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getHoldoutPercent() != null)
sb.append("HoldoutPercent: ").append(getHoldoutPercent()).append(",");
if (getIsPaused() != null)
sb.append("IsPaused: ").append(getIsPaused()).append(",");
if (getLimits() != null)
sb.append("Limits: ").append(getLimits()).append(",");
if (getMessageConfiguration() != null)
sb.append("MessageConfiguration: ").append(getMessageConfiguration()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getSchedule() != null)
sb.append("Schedule: ").append(getSchedule()).append(",");
if (getSegmentId() != null)
sb.append("SegmentId: ").append(getSegmentId()).append(",");
if (getSegmentVersion() != null)
sb.append("SegmentVersion: ").append(getSegmentVersion()).append(",");
if (getTreatmentDescription() != null)
sb.append("TreatmentDescription: ").append(getTreatmentDescription()).append(",");
if (getTreatmentName() != null)
sb.append("TreatmentName: ").append(getTreatmentName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof WriteCampaignRequest == false)
return false;
WriteCampaignRequest other = (WriteCampaignRequest) obj;
if (other.getAdditionalTreatments() == null ^ this.getAdditionalTreatments() == null)
return false;
if (other.getAdditionalTreatments() != null && other.getAdditionalTreatments().equals(this.getAdditionalTreatments()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getHoldoutPercent() == null ^ this.getHoldoutPercent() == null)
return false;
if (other.getHoldoutPercent() != null && other.getHoldoutPercent().equals(this.getHoldoutPercent()) == false)
return false;
if (other.getIsPaused() == null ^ this.getIsPaused() == null)
return false;
if (other.getIsPaused() != null && other.getIsPaused().equals(this.getIsPaused()) == false)
return false;
if (other.getLimits() == null ^ this.getLimits() == null)
return false;
if (other.getLimits() != null && other.getLimits().equals(this.getLimits()) == false)
return false;
if (other.getMessageConfiguration() == null ^ this.getMessageConfiguration() == null)
return false;
if (other.getMessageConfiguration() != null && other.getMessageConfiguration().equals(this.getMessageConfiguration()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getSchedule() == null ^ this.getSchedule() == null)
return false;
if (other.getSchedule() != null && other.getSchedule().equals(this.getSchedule()) == false)
return false;
if (other.getSegmentId() == null ^ this.getSegmentId() == null)
return false;
if (other.getSegmentId() != null && other.getSegmentId().equals(this.getSegmentId()) == false)
return false;
if (other.getSegmentVersion() == null ^ this.getSegmentVersion() == null)
return false;
if (other.getSegmentVersion() != null && other.getSegmentVersion().equals(this.getSegmentVersion()) == false)
return false;
if (other.getTreatmentDescription() == null ^ this.getTreatmentDescription() == null)
return false;
if (other.getTreatmentDescription() != null && other.getTreatmentDescription().equals(this.getTreatmentDescription()) == false)
return false;
if (other.getTreatmentName() == null ^ this.getTreatmentName() == null)
return false;
if (other.getTreatmentName() != null && other.getTreatmentName().equals(this.getTreatmentName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getAdditionalTreatments() == null) ? 0 : getAdditionalTreatments().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getHoldoutPercent() == null) ? 0 : getHoldoutPercent().hashCode());
hashCode = prime * hashCode + ((getIsPaused() == null) ? 0 : getIsPaused().hashCode());
hashCode = prime * hashCode + ((getLimits() == null) ? 0 : getLimits().hashCode());
hashCode = prime * hashCode + ((getMessageConfiguration() == null) ? 0 : getMessageConfiguration().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getSchedule() == null) ? 0 : getSchedule().hashCode());
hashCode = prime * hashCode + ((getSegmentId() == null) ? 0 : getSegmentId().hashCode());
hashCode = prime * hashCode + ((getSegmentVersion() == null) ? 0 : getSegmentVersion().hashCode());
hashCode = prime * hashCode + ((getTreatmentDescription() == null) ? 0 : getTreatmentDescription().hashCode());
hashCode = prime * hashCode + ((getTreatmentName() == null) ? 0 : getTreatmentName().hashCode());
return hashCode;
}
@Override
public WriteCampaignRequest clone() {
try {
return (WriteCampaignRequest) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.pinpoint.model.transform.WriteCampaignRequestMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}