All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.amazonaws.services.personalize.model.CampaignSummary Maven / Gradle / Ivy

Go to download

The AWS Java SDK for Amazon Personalize module holds the client classes that are used for communicating with Amazon Personalize Service

The newest version!
/*
 * 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;

/**
 * 

* Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API. *

* * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CampaignSummary implements Serializable, Cloneable, StructuredPojo { /** *

* The name of the campaign. *

*/ private String name; /** *

* The Amazon Resource Name (ARN) of the campaign. *

*/ private String campaignArn; /** *

* 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; /** *

* The date and time (in Unix time) that the campaign was created. *

*/ private java.util.Date creationDateTime; /** *

* The date and time (in Unix time) that the campaign was last updated. *

*/ private java.util.Date lastUpdatedDateTime; /** *

* If a campaign fails, the reason behind the failure. *

*/ private String failureReason; /** *

* 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 CampaignSummary 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 CampaignSummary withCampaignArn(String campaignArn) { setCampaignArn(campaignArn); 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 CampaignSummary withStatus(String status) { setStatus(status); return this; } /** *

        * The date and time (in Unix time) that the campaign was created. *

        * * @param creationDateTime * The date and time (in Unix time) that the campaign was created. */ public void setCreationDateTime(java.util.Date creationDateTime) { this.creationDateTime = creationDateTime; } /** *

        * The date and time (in Unix time) that the campaign was created. *

        * * @return The date and time (in Unix time) that the campaign was created. */ public java.util.Date getCreationDateTime() { return this.creationDateTime; } /** *

        * The date and time (in Unix time) that the campaign was created. *

        * * @param creationDateTime * The date and time (in Unix time) that the campaign was created. * @return Returns a reference to this object so that method calls can be chained together. */ public CampaignSummary withCreationDateTime(java.util.Date creationDateTime) { setCreationDateTime(creationDateTime); return this; } /** *

        * The date and time (in Unix time) that the campaign was last updated. *

        * * @param lastUpdatedDateTime * The date and time (in Unix time) that the campaign was last updated. */ public void setLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { this.lastUpdatedDateTime = lastUpdatedDateTime; } /** *

        * The date and time (in Unix time) that the campaign was last updated. *

        * * @return The date and time (in Unix time) that the campaign was last updated. */ public java.util.Date getLastUpdatedDateTime() { return this.lastUpdatedDateTime; } /** *

        * The date and time (in Unix time) that the campaign was last updated. *

        * * @param lastUpdatedDateTime * The date and time (in Unix time) that the campaign was last updated. * @return Returns a reference to this object so that method calls can be chained together. */ public CampaignSummary withLastUpdatedDateTime(java.util.Date lastUpdatedDateTime) { setLastUpdatedDateTime(lastUpdatedDateTime); 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 CampaignSummary withFailureReason(String failureReason) { setFailureReason(failureReason); 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 (getStatus() != null) sb.append("Status: ").append(getStatus()).append(","); if (getCreationDateTime() != null) sb.append("CreationDateTime: ").append(getCreationDateTime()).append(","); if (getLastUpdatedDateTime() != null) sb.append("LastUpdatedDateTime: ").append(getLastUpdatedDateTime()).append(","); if (getFailureReason() != null) sb.append("FailureReason: ").append(getFailureReason()); sb.append("}"); return sb.toString(); } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof CampaignSummary == false) return false; CampaignSummary other = (CampaignSummary) 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.getStatus() == null ^ this.getStatus() == null) return false; if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == 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.getFailureReason() == null ^ this.getFailureReason() == null) return false; if (other.getFailureReason() != null && other.getFailureReason().equals(this.getFailureReason()) == 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 + ((getStatus() == null) ? 0 : getStatus().hashCode()); hashCode = prime * hashCode + ((getCreationDateTime() == null) ? 0 : getCreationDateTime().hashCode()); hashCode = prime * hashCode + ((getLastUpdatedDateTime() == null) ? 0 : getLastUpdatedDateTime().hashCode()); hashCode = prime * hashCode + ((getFailureReason() == null) ? 0 : getFailureReason().hashCode()); return hashCode; } @Override public CampaignSummary clone() { try { return (CampaignSummary) 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.CampaignSummaryMarshaller.getInstance().marshall(this, protocolMarshaller); } }




© 2015 - 2025 Weber Informatics LLC | Privacy Policy