software.amazon.awssdk.services.pinpoint.model

Class CampaignState

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<CampaignState.Builder,CampaignState>

@Generated(value="software.amazon.awssdk:codegen")
public class CampaignState
extends Object
implements StructuredPojo, ToCopyableBuilder<CampaignState.Builder,CampaignState>

State of the Campaign

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CampaignState.Builder

Method Summary

Modifier and Type	Method and Description
static CampaignState.Builder	builder()
CampaignStatus	campaignStatus() The status of the campaign, or the status of a treatment that belongs to an A/B test campaign.
String	campaignStatusAsString() The status of the campaign, or the status of a treatment that belongs to an A/B test campaign.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends CampaignState.Builder>	serializableBuilderClass()
CampaignState.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

campaignStatus

public CampaignStatus campaignStatus()

The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

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 status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

See Also:

CampaignStatus

campaignStatusAsString

public String campaignStatusAsString()

The status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

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 status of the campaign, or the status of a treatment that belongs to an A/B test campaign. Valid values: SCHEDULED, EXECUTING, PENDING_NEXT_RUN, COMPLETED, PAUSED

See Also:

CampaignStatus

toBuilder

public CampaignState.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CampaignState.Builder,CampaignState>

Returns:

a builder for type T

builder

public static CampaignState.Builder builder()

serializableBuilderClass

public static Class<? extends CampaignState.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

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.