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>

Provides information about an activity that was performed by a campaign.

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 unique identifier for the application that the campaign applies to.
static ActivityResponse.Builder	builder()
String	campaignId() The unique identifier for the campaign that the activity applies to.
String	end() The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	id() The unique identifier for the activity.
String	result() Specifies whether the activity succeeded.
String	scheduledStart() The scheduled start time, in ISO 8601 format, for the activity.
List<SdkField<?>>	sdkFields()
static Class<? extends ActivityResponse.Builder>	serializableBuilderClass()
String	start() The actual start time, in ISO 8601 format, of the activity.
String	state() The current status of the activity.
Integer	successfulEndpointCount() The total number of endpoints that the campaign successfully delivered messages to.
Integer	timezonesCompletedCount() The total number of time zones that were completed.
Integer	timezonesTotalCount() The total number of unique time zones that are in the segment for the campaign.
ActivityResponse.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
Integer	totalEndpointCount() The total number of endpoints that the campaign attempted to deliver messages to.
String	treatmentId() The unique identifier for the campaign treatment that the activity applies to.

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

The unique identifier for the application that the campaign applies to.

Returns:

The unique identifier for the application that the campaign applies to.

campaignId

public final String campaignId()

The unique identifier for the campaign that the activity applies to.

Returns:

The unique identifier for the campaign that the activity applies to.

end

public final String end()

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

Returns:

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

id

public final String id()

The unique identifier for the activity.

Returns:

The unique identifier for the activity.

result

public final String result()

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

Returns:

Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.

scheduledStart

public final String scheduledStart()

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

Returns:

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

start

public final String start()

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

Returns:

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

state

public final String state()

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

Returns:

The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.

successfulEndpointCount

public final Integer successfulEndpointCount()

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

Returns:

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

timezonesCompletedCount

public final Integer timezonesCompletedCount()

The total number of time zones that were completed.

Returns:

The total number of time zones that were completed.

timezonesTotalCount

public final Integer timezonesTotalCount()

The total number of unique time zones that are in the segment for the campaign.

Returns:

The total number of unique time zones that are in the segment for the campaign.

totalEndpointCount

public final Integer totalEndpointCount()

The total number of endpoints that the campaign attempted to deliver messages to.

Returns:

The total number of endpoints that the campaign attempted to deliver messages to.

treatmentId

public final String treatmentId()

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

Returns:

The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.

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 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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

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