CampaignSummary (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.personalize.model.CampaignSummary

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CampaignSummary
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides a summary of the properties of a campaign. For a complete listing, call the DescribeCampaign API.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

CampaignSummary()

Constructors
Constructor and Description
`CampaignSummary()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CampaignSummary`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCampaignArn()` The Amazon Resource Name (ARN) of the campaign.
`Date`	`getCreationDateTime()` The date and time (in Unix time) that the campaign was created.
`String`	`getFailureReason()` If a campaign fails, the reason behind the failure.
`Date`	`getLastUpdatedDateTime()` The date and time (in Unix time) that the campaign was last updated.
`String`	`getName()` The name of the campaign.
`String`	`getStatus()` The status of the campaign.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setCampaignArn(String campaignArn)` The Amazon Resource Name (ARN) of the campaign.
`void`	`setCreationDateTime(Date creationDateTime)` The date and time (in Unix time) that the campaign was created.
`void`	`setFailureReason(String failureReason)` If a campaign fails, the reason behind the failure.
`void`	`setLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the campaign was last updated.
`void`	`setName(String name)` The name of the campaign.
`void`	`setStatus(String status)` The status of the campaign.
`String`	`toString()` Returns a string representation of this object.
`CampaignSummary`	`withCampaignArn(String campaignArn)` The Amazon Resource Name (ARN) of the campaign.
`CampaignSummary`	`withCreationDateTime(Date creationDateTime)` The date and time (in Unix time) that the campaign was created.
`CampaignSummary`	`withFailureReason(String failureReason)` If a campaign fails, the reason behind the failure.
`CampaignSummary`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix time) that the campaign was last updated.
`CampaignSummary`	`withName(String name)` The name of the campaign.
`CampaignSummary`	`withStatus(String status)` The status of the campaign.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - CampaignSummary
```
public CampaignSummary()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the campaign.
    
    Parameters:
    
    name - The name of the campaign.
  - getName
```
public String getName()
```
    The name of the campaign.
    
    Returns:
    
    The name of the campaign.
  - withName
```
public CampaignSummary withName(String name)
```
    The name of the campaign.
    
    Parameters:
    
    name - The name of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCampaignArn
```
public void setCampaignArn(String campaignArn)
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Parameters:
    
    campaignArn - The Amazon Resource Name (ARN) of the campaign.
  - getCampaignArn
```
public String getCampaignArn()
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the campaign.
  - withCampaignArn
```
public CampaignSummary withCampaignArn(String campaignArn)
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Parameters:
    
    campaignArn - The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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
    Parameters:
    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
  - getStatus
```
public String getStatus()
```
    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
    Returns:
    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
  - withStatus
```
public CampaignSummary withStatus(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix time) that the campaign was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix time) that the campaign was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The date and time (in Unix time) that the campaign was created.
    
    Returns:
    
    The date and time (in Unix time) that the campaign was created.
  - withCreationDateTime
```
public CampaignSummary withCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix time) that the campaign was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix time) that the campaign was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDateTime
```
public void setLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) that the campaign was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) that the campaign was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The date and time (in Unix time) that the campaign was last updated.
    
    Returns:
    
    The date and time (in Unix time) that the campaign was last updated.
  - withLastUpdatedDateTime
```
public CampaignSummary withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix time) that the campaign was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix time) that the campaign was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFailureReason
```
public void setFailureReason(String failureReason)
```
    If a campaign fails, the reason behind the failure.
    
    Parameters:
    
    failureReason - If a campaign fails, the reason behind the failure.
  - getFailureReason
```
public String getFailureReason()
```
    If a campaign fails, the reason behind the failure.
    
    Returns:
    
    If a campaign fails, the reason behind the failure.
  - withFailureReason
```
public CampaignSummary withFailureReason(String failureReason)
```
    If a campaign fails, the reason behind the failure.
    
    Parameters:
    
    failureReason - If a campaign fails, the reason behind the failure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public String toString()
```
    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.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public CampaignSummary clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.773

Class CampaignSummary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CampaignSummary

Method Detail

setName

getName

withName

setCampaignArn

getCampaignArn

withCampaignArn

setStatus

getStatus

withStatus

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

setFailureReason

getFailureReason

withFailureReason

toString

equals

hashCode

clone

marshall