Campaign (AWS Java SDK :: Services :: Personalize 2.9.26 API)

java.lang.Object
- software.amazon.awssdk.services.personalize.model.Campaign

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Campaign.Builder,Campaign>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Campaign
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Campaign.Builder,Campaign>
```
Describes a deployed solution version, otherwise known as a campaign. For more information on campaigns, see CreateCampaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Campaign.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Campaign.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static Campaign.Builder`	`builder()`
`String`	`campaignArn()` The Amazon Resource Name (ARN) of the campaign.
`Instant`	`creationDateTime()` The date and time (in Unix format) that the campaign was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`failureReason()` If a campaign fails, the reason behind the failure.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`lastUpdatedDateTime()` The date and time (in Unix format) that the campaign was last updated.
`CampaignUpdateSummary`	`latestCampaignUpdate()` Returns the value of the LatestCampaignUpdate property for this object.
`Integer`	`minProvisionedTPS()` Specifies the requested minimum provisioned transactions (recommendations) per second.
`String`	`name()` The name of the campaign.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Campaign.Builder>`	`serializableBuilderClass()`
`String`	`solutionVersionArn()` The Amazon Resource Name (ARN) of a specific version of the solution.
`String`	`status()` The status of the campaign.
`Campaign.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - name
```
public String name()
```
    The name of the campaign.
    
    Returns:
    
    The name of the campaign.
  - campaignArn
```
public String campaignArn()
```
    The Amazon Resource Name (ARN) of the campaign.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the campaign.
  - solutionVersionArn
```
public String solutionVersionArn()
```
    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.
  - minProvisionedTPS
```
public Integer minProvisionedTPS()
```
    Specifies the requested minimum provisioned transactions (recommendations) per second.
    
    Returns:
    
    Specifies the requested minimum provisioned transactions (recommendations) per second.
  - status
```
public 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
    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
  - failureReason
```
public String failureReason()
```
    If a campaign fails, the reason behind the failure.
    
    Returns:
    
    If a campaign fails, the reason behind the failure.
  - creationDateTime
```
public Instant creationDateTime()
```
    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.
  - lastUpdatedDateTime
```
public Instant lastUpdatedDateTime()
```
    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.
  - latestCampaignUpdate
```
public CampaignUpdateSummary latestCampaignUpdate()
```
    Returns the value of the LatestCampaignUpdate property for this object.
    
    Returns:
    
    The value of the LatestCampaignUpdate property for this object.
  - toBuilder
```
public Campaign.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Campaign.Builder,Campaign>
  - builder
```
public static Campaign.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Campaign.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Campaign

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

name

campaignArn

solutionVersionArn

minProvisionedTPS

status

failureReason

creationDateTime

lastUpdatedDateTime

latestCampaignUpdate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields