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

Class CampaignSummary

java.lang.Object

software.amazon.awssdk.services.personalize.model.CampaignSummary

All Implemented Interfaces:

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

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

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

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CampaignSummary.Builder

Method Summary

Modifier and Type	Method	Description
static CampaignSummary.Builder	builder()
String	campaignArn()	The Amazon Resource Name (ARN) of the campaign.
Instant	creationDateTime()	The date and time (in Unix time) 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 time) that the campaign was last updated.
String	name()	The name of the campaign.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CampaignSummary.Builder>	serializableBuilderClass()
String	status()	The status of the campaign.
CampaignSummary.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.

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

creationDateTime

public final Instant creationDateTime()

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.

lastUpdatedDateTime

public final Instant lastUpdatedDateTime()

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.

failureReason

public final String failureReason()

If a campaign fails, the reason behind the failure.

Returns:

If a campaign fails, the reason behind the failure.

toBuilder

public CampaignSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignSummary.Builder,CampaignSummary>

builder

public static CampaignSummary.Builder builder()

serializableBuilderClass

public static Class<? extends CampaignSummary.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