com.amazonaws.services.personalize.model.Campaign Maven / Gradle / Ivy
Show all versions of aws-java-sdk-personalize Show documentation
/*
* Copyright 2019-2024 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.personalize.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Campaign implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the campaign.
*
*/
private String name;
/**
*
* The Amazon Resource Name (ARN) of the campaign.
*
*/
private String campaignArn;
/**
*
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
*
*/
private String solutionVersionArn;
/**
*
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS as necessary.
*
*/
private Integer minProvisionedTPS;
/**
*
* The configuration details of a campaign.
*
*/
private CampaignConfig campaignConfig;
/**
*
* The status of the campaign.
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*/
private String status;
/**
*
* If a campaign fails, the reason behind the failure.
*
*/
private String failureReason;
/**
*
* The date and time (in Unix format) that the campaign was created.
*
*/
private java.util.Date creationDateTime;
/**
*
* The date and time (in Unix format) that the campaign was last updated.
*
*/
private java.util.Date lastUpdatedDateTime;
private CampaignUpdateSummary latestCampaignUpdate;
/**
*
* The name of the campaign.
*
*
* @param name
* The name of the campaign.
*/
public void setName(String name) {
this.name = name;
}
/**
*
* The name of the campaign.
*
*
* @return The name of the campaign.
*/
public String getName() {
return this.name;
}
/**
*
* The name of the campaign.
*
*
* @param name
* The name of the campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withName(String name) {
setName(name);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the campaign.
*
*
* @param campaignArn
* The Amazon Resource Name (ARN) of the campaign.
*/
public void setCampaignArn(String campaignArn) {
this.campaignArn = campaignArn;
}
/**
*
* The Amazon Resource Name (ARN) of the campaign.
*
*
* @return The Amazon Resource Name (ARN) of the campaign.
*/
public String getCampaignArn() {
return this.campaignArn;
}
/**
*
* The Amazon Resource Name (ARN) of the campaign.
*
*
* @param campaignArn
* The Amazon Resource Name (ARN) of the campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withCampaignArn(String campaignArn) {
setCampaignArn(campaignArn);
return this;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
*/
public void setSolutionVersionArn(String solutionVersionArn) {
this.solutionVersionArn = solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
*
*
* @return The Amazon Resource Name (ARN) of the solution version the campaign uses.
*/
public String getSolutionVersionArn() {
return this.solutionVersionArn;
}
/**
*
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
*
*
* @param solutionVersionArn
* The Amazon Resource Name (ARN) of the solution version the campaign uses.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withSolutionVersionArn(String solutionVersionArn) {
setSolutionVersionArn(solutionVersionArn);
return this;
}
/**
*
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS as necessary.
*
*
* @param minProvisionedTPS
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and
* increase the minProvisionedTPS as necessary.
*/
public void setMinProvisionedTPS(Integer minProvisionedTPS) {
this.minProvisionedTPS = minProvisionedTPS;
}
/**
*
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS as necessary.
*
*
* @return Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and
* increase the minProvisionedTPS as necessary.
*/
public Integer getMinProvisionedTPS() {
return this.minProvisionedTPS;
}
/**
*
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and increase the
* minProvisionedTPS as necessary.
*
*
* @param minProvisionedTPS
* Specifies the requested minimum provisioned transactions (recommendations) per second. A high
* minProvisionedTPS will increase your bill. We recommend starting with 1 for
* minProvisionedTPS (the default). Track your usage using Amazon CloudWatch metrics, and
* increase the minProvisionedTPS as necessary.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withMinProvisionedTPS(Integer minProvisionedTPS) {
setMinProvisionedTPS(minProvisionedTPS);
return this;
}
/**
*
* The configuration details of a campaign.
*
*
* @param campaignConfig
* The configuration details of a campaign.
*/
public void setCampaignConfig(CampaignConfig campaignConfig) {
this.campaignConfig = campaignConfig;
}
/**
*
* The configuration details of a campaign.
*
*
* @return The configuration details of a campaign.
*/
public CampaignConfig getCampaignConfig() {
return this.campaignConfig;
}
/**
*
* The configuration details of a campaign.
*
*
* @param campaignConfig
* The configuration details of a campaign.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withCampaignConfig(CampaignConfig campaignConfig) {
setCampaignConfig(campaignConfig);
return this;
}
/**
*
* The status of the campaign.
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @param status
* The status of the campaign.
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*/
public void setStatus(String status) {
this.status = status;
}
/**
*
* The status of the campaign.
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @return The status of the campaign.
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*/
public String getStatus() {
return this.status;
}
/**
*
* The status of the campaign.
*
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
*
*
* @param status
* The status of the campaign.
*
* A campaign can be in one of the following states:
*
*
* -
*
* CREATE PENDING > CREATE IN_PROGRESS > ACTIVE -or- CREATE FAILED
*
*
* -
*
* DELETE PENDING > DELETE IN_PROGRESS
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withStatus(String status) {
setStatus(status);
return this;
}
/**
*
* If a campaign fails, the reason behind the failure.
*
*
* @param failureReason
* If a campaign fails, the reason behind the failure.
*/
public void setFailureReason(String failureReason) {
this.failureReason = failureReason;
}
/**
*
* If a campaign fails, the reason behind the failure.
*
*
* @return If a campaign fails, the reason behind the failure.
*/
public String getFailureReason() {
return this.failureReason;
}
/**
*
* If a campaign fails, the reason behind the failure.
*
*
* @param failureReason
* If a campaign fails, the reason behind the failure.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withFailureReason(String failureReason) {
setFailureReason(failureReason);
return this;
}
/**
*
* The date and time (in Unix format) that the campaign was created.
*
*
* @param creationDateTime
* The date and time (in Unix format) that the campaign was created.
*/
public void setCreationDateTime(java.util.Date creationDateTime) {
this.creationDateTime = creationDateTime;
}
/**
*
* The date and time (in Unix format) that the campaign was created.
*
*
* @return The date and time (in Unix format) that the campaign was created.
*/
public java.util.Date getCreationDateTime() {
return this.creationDateTime;
}
/**
*
* The date and time (in Unix format) that the campaign was created.
*
*
* @param creationDateTime
* The date and time (in Unix format) that the campaign was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withCreationDateTime(java.util.Date creationDateTime) {
setCreationDateTime(creationDateTime);
return this;
}
/**
*
* The date and time (in Unix format) that the campaign was last updated.
*
*
* @param lastUpdatedDateTime
* The date and time (in Unix format) that the campaign was last updated.
*/
public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
this.lastUpdatedDateTime = lastUpdatedDateTime;
}
/**
*
* The date and time (in Unix format) that the campaign was last updated.
*
*
* @return The date and time (in Unix format) that the campaign was last updated.
*/
public java.util.Date getLastUpdatedDateTime() {
return this.lastUpdatedDateTime;
}
/**
*
* The date and time (in Unix format) that the campaign was last updated.
*
*
* @param lastUpdatedDateTime
* The date and time (in Unix format) that the campaign was last updated.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) {
setLastUpdatedDateTime(lastUpdatedDateTime);
return this;
}
/**
* @param latestCampaignUpdate
*/
public void setLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate) {
this.latestCampaignUpdate = latestCampaignUpdate;
}
/**
* @return
*/
public CampaignUpdateSummary getLatestCampaignUpdate() {
return this.latestCampaignUpdate;
}
/**
* @param latestCampaignUpdate
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Campaign withLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate) {
setLatestCampaignUpdate(latestCampaignUpdate);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getCampaignArn() != null)
sb.append("CampaignArn: ").append(getCampaignArn()).append(",");
if (getSolutionVersionArn() != null)
sb.append("SolutionVersionArn: ").append(getSolutionVersionArn()).append(",");
if (getMinProvisionedTPS() != null)
sb.append("MinProvisionedTPS: ").append(getMinProvisionedTPS()).append(",");
if (getCampaignConfig() != null)
sb.append("CampaignConfig: ").append(getCampaignConfig()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getFailureReason() != null)
sb.append("FailureReason: ").append(getFailureReason()).append(",");
if (getCreationDateTime() != null)
sb.append("CreationDateTime: ").append(getCreationDateTime()).append(",");
if (getLastUpdatedDateTime() != null)
sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime()).append(",");
if (getLatestCampaignUpdate() != null)
sb.append("LatestCampaignUpdate: ").append(getLatestCampaignUpdate());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Campaign == false)
return false;
Campaign other = (Campaign) obj;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getCampaignArn() == null ^ this.getCampaignArn() == null)
return false;
if (other.getCampaignArn() != null && other.getCampaignArn().equals(this.getCampaignArn()) == false)
return false;
if (other.getSolutionVersionArn() == null ^ this.getSolutionVersionArn() == null)
return false;
if (other.getSolutionVersionArn() != null && other.getSolutionVersionArn().equals(this.getSolutionVersionArn()) == false)
return false;
if (other.getMinProvisionedTPS() == null ^ this.getMinProvisionedTPS() == null)
return false;
if (other.getMinProvisionedTPS() != null && other.getMinProvisionedTPS().equals(this.getMinProvisionedTPS()) == false)
return false;
if (other.getCampaignConfig() == null ^ this.getCampaignConfig() == null)
return false;
if (other.getCampaignConfig() != null && other.getCampaignConfig().equals(this.getCampaignConfig()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getFailureReason() == null ^ this.getFailureReason() == null)
return false;
if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == false)
return false;
if (other.getCreationDateTime() == null ^ this.getCreationDateTime() == null)
return false;
if (other.getCreationDateTime() != null && other.getCreationDateTime().equals(this.getCreationDateTime()) == false)
return false;
if (other.getLastUpdatedDateTime() == null ^ this.getLastUpdatedDateTime() == null)
return false;
if (other.getLastUpdatedDateTime() != null && other.getLastUpdatedDateTime().equals(this.getLastUpdatedDateTime()) == false)
return false;
if (other.getLatestCampaignUpdate() == null ^ this.getLatestCampaignUpdate() == null)
return false;
if (other.getLatestCampaignUpdate() != null && other.getLatestCampaignUpdate().equals(this.getLatestCampaignUpdate()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getCampaignArn() == null) ? 0 : getCampaignArn().hashCode());
hashCode = prime * hashCode + ((getSolutionVersionArn() == null) ? 0 : getSolutionVersionArn().hashCode());
hashCode = prime * hashCode + ((getMinProvisionedTPS() == null) ? 0 : getMinProvisionedTPS().hashCode());
hashCode = prime * hashCode + ((getCampaignConfig() == null) ? 0 : getCampaignConfig().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode());
hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode());
hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode());
hashCode = prime * hashCode + ((getLatestCampaignUpdate() == null) ? 0 : getLatestCampaignUpdate().hashCode());
return hashCode;
}
@Override
public Campaign clone() {
try {
return (Campaign) 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.personalize.model.transform.CampaignMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}