software.amazon.awssdk.services.pinpoint.model

Class ActivityResponse

java.lang.Object

software.amazon.awssdk.services.pinpoint.model.ActivityResponse

All Implemented Interfaces:

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

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

Activity definition

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActivityResponse.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The ID of the application to which the campaign applies.
static ActivityResponse.Builder	builder()
String	campaignId() The ID of the campaign to which the activity applies.
String	end() The actual time the activity was marked CANCELLED or COMPLETED.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique activity ID.
String	result() Indicates whether the activity succeeded.
String	scheduledStart() The scheduled start time for the activity in ISO 8601 format.
List<SdkField<?>>	sdkFields()
static Class<? extends ActivityResponse.Builder>	serializableBuilderClass()
String	start() The actual start time of the activity in ISO 8601 format.
String	state() The state of the activity.
Integer	successfulEndpointCount() The total number of endpoints to which the campaign successfully delivered messages.
Integer	timezonesCompletedCount() The total number of timezones completed.
Integer	timezonesTotalCount() The total number of unique timezones present in the segment.
ActivityResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	totalEndpointCount() The total number of endpoints to which the campaign attempts to deliver messages.
String	treatmentId() The ID of a variation of the campaign used for A/B testing.

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

applicationId

public String applicationId()

The ID of the application to which the campaign applies.

Returns:

The ID of the application to which the campaign applies.

campaignId

public String campaignId()

The ID of the campaign to which the activity applies.

Returns:

The ID of the campaign to which the activity applies.

end

public String end()

The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.

Returns:

The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.

id

public String id()

The unique activity ID.

Returns:

The unique activity ID.

result

public String result()

Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL

Returns:

Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL

scheduledStart

public String scheduledStart()

The scheduled start time for the activity in ISO 8601 format.

Returns:

The scheduled start time for the activity in ISO 8601 format.

start

public String start()

The actual start time of the activity in ISO 8601 format.

Returns:

The actual start time of the activity in ISO 8601 format.

state

public String state()

The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

Returns:

The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

successfulEndpointCount

public Integer successfulEndpointCount()

The total number of endpoints to which the campaign successfully delivered messages.

Returns:

The total number of endpoints to which the campaign successfully delivered messages.

timezonesCompletedCount

public Integer timezonesCompletedCount()

The total number of timezones completed.

Returns:

The total number of timezones completed.

timezonesTotalCount

public Integer timezonesTotalCount()

The total number of unique timezones present in the segment.

Returns:

The total number of unique timezones present in the segment.

totalEndpointCount

public Integer totalEndpointCount()

The total number of endpoints to which the campaign attempts to deliver messages.

Returns:

The total number of endpoints to which the campaign attempts to deliver messages.

treatmentId

public String treatmentId()

The ID of a variation of the campaign used for A/B testing.

Returns:

The ID of a variation of the campaign used for A/B testing.

toBuilder

public ActivityResponse.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<ActivityResponse.Builder,ActivityResponse>

Returns:

a builder for type T

builder

public static ActivityResponse.Builder builder()

serializableBuilderClass

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.