Class ActivityResponse
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ActivityResponse.Builder,
ActivityResponse>
Provides information about an activity that was performed by a campaign.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
The unique identifier for the application that the campaign applies to.static ActivityResponse.Builder
builder()
final String
The unique identifier for the campaign that the activity applies to.final String
end()
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.A JSON object that contains metrics relating to the campaign execution for this campaign activity.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the ExecutionMetrics property.final int
hashCode()
final String
id()
The unique identifier for the activity.final String
result()
Specifies whether the activity succeeded.final String
The scheduled start time, in ISO 8601 format, for the activity.static Class
<? extends ActivityResponse.Builder> final String
start()
The actual start time, in ISO 8601 format, of the activity.final String
state()
The current status of the activity.final Integer
The total number of endpoints that the campaign successfully delivered messages to.final Integer
The total number of time zones that were completed.final Integer
The total number of unique time zones that are in the segment for the campaign.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
The total number of endpoints that the campaign attempted to deliver messages to.final String
The unique identifier for the campaign treatment that the activity applies to.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
The unique identifier for the campaign that the activity applies to.
- Returns:
- The unique identifier for the campaign that the activity applies to.
-
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
The unique identifier for the activity.
- Returns:
- The unique identifier for the activity.
-
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
The scheduled start time, in ISO 8601 format, for the activity.
- Returns:
- The scheduled start time, in ISO 8601 format, for the activity.
-
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
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
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
The total number of time zones that were completed.
- Returns:
- The total number of time zones that were completed.
-
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
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
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<ActivityResponse.Builder,
ActivityResponse> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-