Campaign (AWS SDK for Java

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

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Campaign
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Campaign()

Constructors
Constructor and Description
`Campaign()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Campaign`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getCampaignArn()` The Amazon Resource Name (ARN) of the campaign.
`Date`	`getCreationDateTime()` The date and time (in Unix format) that the campaign was created.
`String`	`getFailureReason()` If a campaign fails, the reason behind the failure.
`Date`	`getLastUpdatedDateTime()` The date and time (in Unix format) that the campaign was last updated.
`CampaignUpdateSummary`	`getLatestCampaignUpdate()`
`Integer`	`getMinProvisionedTPS()` Specifies the requested minimum provisioned transactions (recommendations) per second.
`String`	`getName()` The name of the campaign.
`String`	`getSolutionVersionArn()` The Amazon Resource Name (ARN) of a specific version of the solution.
`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 format) 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 format) that the campaign was last updated.
`void`	`setLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate)`
`void`	`setMinProvisionedTPS(Integer minProvisionedTPS)` Specifies the requested minimum provisioned transactions (recommendations) per second.
`void`	`setName(String name)` The name of the campaign.
`void`	`setSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of a specific version of the solution.
`void`	`setStatus(String status)` The status of the campaign.
`String`	`toString()` Returns a string representation of this object.
`Campaign`	`withCampaignArn(String campaignArn)` The Amazon Resource Name (ARN) of the campaign.
`Campaign`	`withCreationDateTime(Date creationDateTime)` The date and time (in Unix format) that the campaign was created.
`Campaign`	`withFailureReason(String failureReason)` If a campaign fails, the reason behind the failure.
`Campaign`	`withLastUpdatedDateTime(Date lastUpdatedDateTime)` The date and time (in Unix format) that the campaign was last updated.
`Campaign`	`withLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate)`
`Campaign`	`withMinProvisionedTPS(Integer minProvisionedTPS)` Specifies the requested minimum provisioned transactions (recommendations) per second.
`Campaign`	`withName(String name)` The name of the campaign.
`Campaign`	`withSolutionVersionArn(String solutionVersionArn)` The Amazon Resource Name (ARN) of a specific version of the solution.
`Campaign`	`withStatus(String status)` The status of the campaign.

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

- Constructor Detail
  - Campaign
```
public Campaign()
```
- 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 Campaign 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 Campaign 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.
  - setSolutionVersionArn
```
public void setSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of a specific version of the solution.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of a specific version of the solution.
  - getSolutionVersionArn
```
public String getSolutionVersionArn()
```
    The Amazon Resource Name (ARN) of a specific version of the solution.
    
    Returns:
    
    The Amazon Resource Name (ARN) of a specific version of the solution.
  - withSolutionVersionArn
```
public Campaign withSolutionVersionArn(String solutionVersionArn)
```
    The Amazon Resource Name (ARN) of a specific version of the solution.
    
    Parameters:
    
    solutionVersionArn - The Amazon Resource Name (ARN) of a specific version of the solution.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMinProvisionedTPS
```
public void setMinProvisionedTPS(Integer minProvisionedTPS)
```
    Specifies the requested minimum provisioned transactions (recommendations) per second.
    
    Parameters:
    
    minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second.
  - getMinProvisionedTPS
```
public Integer getMinProvisionedTPS()
```
    Specifies the requested minimum provisioned transactions (recommendations) per second.
    
    Returns:
    
    Specifies the requested minimum provisioned transactions (recommendations) per second.
  - withMinProvisionedTPS
```
public Campaign withMinProvisionedTPS(Integer minProvisionedTPS)
```
    Specifies the requested minimum provisioned transactions (recommendations) per second.
    
    Parameters:
    
    minProvisionedTPS - Specifies the requested minimum provisioned transactions (recommendations) per second.
    
    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 Campaign 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.
  - 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 Campaign 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.
  - setCreationDateTime
```
public void setCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix format) that the campaign was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix format) that the campaign was created.
  - getCreationDateTime
```
public Date getCreationDateTime()
```
    The date and time (in Unix format) that the campaign was created.
    
    Returns:
    
    The date and time (in Unix format) that the campaign was created.
  - withCreationDateTime
```
public Campaign withCreationDateTime(Date creationDateTime)
```
    The date and time (in Unix format) that the campaign was created.
    
    Parameters:
    
    creationDateTime - The date and time (in Unix format) 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 format) that the campaign was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix format) that the campaign was last updated.
  - getLastUpdatedDateTime
```
public Date getLastUpdatedDateTime()
```
    The date and time (in Unix format) that the campaign was last updated.
    
    Returns:
    
    The date and time (in Unix format) that the campaign was last updated.
  - withLastUpdatedDateTime
```
public Campaign withLastUpdatedDateTime(Date lastUpdatedDateTime)
```
    The date and time (in Unix format) that the campaign was last updated.
    
    Parameters:
    
    lastUpdatedDateTime - The date and time (in Unix format) that the campaign was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLatestCampaignUpdate
```
public void setLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate)
```
    Parameters:
    
    latestCampaignUpdate -
  - getLatestCampaignUpdate
```
public CampaignUpdateSummary getLatestCampaignUpdate()
```
    Returns:
  - withLatestCampaignUpdate
```
public Campaign withLatestCampaignUpdate(CampaignUpdateSummary latestCampaignUpdate)
```
    Parameters:
    
    latestCampaignUpdate -
    
    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 Campaign 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.

Did this page help you?

Class Campaign

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Campaign

Method Detail

setName

getName

withName

setCampaignArn

getCampaignArn

withCampaignArn

setSolutionVersionArn

getSolutionVersionArn

withSolutionVersionArn

setMinProvisionedTPS

getMinProvisionedTPS

withMinProvisionedTPS

setStatus

getStatus

withStatus

setFailureReason

getFailureReason

withFailureReason

setCreationDateTime

getCreationDateTime

withCreationDateTime

setLastUpdatedDateTime

getLastUpdatedDateTime

withLastUpdatedDateTime

setLatestCampaignUpdate

getLatestCampaignUpdate

withLatestCampaignUpdate

toString

equals

hashCode

clone

marshall