Package software.amazon.awssdk.services.pinpoint.model

Class CampaignState

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.CampaignState

All Implemented Interfaces:

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

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

Provides information about the status of a campaign.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CampaignState.Builder

Method Summary

Modifier and Type	Method	Description
static CampaignState.Builder	builder()
CampaignStatus	campaignStatus()	The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
String	campaignStatusAsString()	The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CampaignState.Builder>	serializableBuilderClass()
CampaignState.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

campaignStatus

public final CampaignStatus campaignStatus()

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

If the service returns an enum value that is not available in the current SDK version, campaignStatus will return CampaignStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from campaignStatusAsString().

Returns:

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

See Also:

CampaignStatus

campaignStatusAsString

public final String campaignStatusAsString()

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

If the service returns an enum value that is not available in the current SDK version, campaignStatus will return CampaignStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from campaignStatusAsString().

Returns:

The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign.

If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.

See Also:

CampaignStatus

toBuilder

public CampaignState.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignState.Builder,CampaignState>

builder

public static CampaignState.Builder builder()

serializableBuilderClass

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