Package software.amazon.awssdk.services.personalize.model

Class Campaign

java.lang.Object

software.amazon.awssdk.services.personalize.model.Campaign

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Campaign.Builder,Campaign>

@Generated("software.amazon.awssdk:codegen")
public final class Campaign
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Campaign.Builder,Campaign>

An object that describes the deployment of a solution version. For more information on campaigns, see CreateCampaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Campaign.Builder

Method Summary

Modifier and Type	Method	Description
static Campaign.Builder	builder()
String	campaignArn()	The Amazon Resource Name (ARN) of the campaign.
CampaignConfig	campaignConfig()	The configuration details of a 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.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends Campaign.Builder>	serializableBuilderClass()
String	solutionVersionArn()	The Amazon Resource Name (ARN) of the solution version the campaign uses.
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 final String name()

The name of the campaign.

Returns:

The name of the campaign.

campaignArn

public final String campaignArn()

The Amazon Resource Name (ARN) of the campaign.

Returns:

The Amazon Resource Name (ARN) of the campaign.

solutionVersionArn

public final String solutionVersionArn()

The Amazon Resource Name (ARN) of the solution version the campaign uses.

Returns:

The Amazon Resource Name (ARN) of the solution version the campaign uses.

minProvisionedTPS

public final Integer 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.

Returns:

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.

campaignConfig

public final CampaignConfig campaignConfig()

The configuration details of a campaign.

Returns:

The configuration details of a campaign.

status

public final 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 final String failureReason()

If a campaign fails, the reason behind the failure.

Returns:

If a campaign fails, the reason behind the failure.

creationDateTime

public final 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 final 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 final 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 final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo