ActivityResponse (AWS Java SDK :: Services :: Amazon Pinpoint 2.21.9 API)

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

Nested Classes
Modifier and Type	Class and Description
`static interface`	`ActivityResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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)`
`Map<String,String>`	`executionMetrics()` A JSON object that contains metrics relating to the campaign execution for this campaign activity.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExecutionMetrics()` For responses, this returns true if the service returned a value for the ExecutionMetrics property.
`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()`
`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
clone, finalize, 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.
  - hasExecutionMetrics
```
public final boolean hasExecutionMetrics()
```
    For responses, this returns true if the service returned a value for the ExecutionMetrics property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - executionMetrics
```
public final Map<String,String> executionMetrics()
```
    A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExecutionMetrics() method.
    
    Returns:
    
    A JSON object that contains metrics relating to the campaign execution for this campaign activity. For information about the structure and contents of the results, see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.
  - toBuilder
```
public ActivityResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ActivityResponse.Builder,ActivityResponse>
  - 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)
```
    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

Class ActivityResponse

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

applicationId

campaignId

end

id

result

scheduledStart

start

state

successfulEndpointCount

timezonesCompletedCount

timezonesTotalCount

totalEndpointCount

treatmentId

hasExecutionMetrics

executionMetrics

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields