ActivityResponse (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.pinpoint.model.ActivityResponse

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ActivityResponse
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Provides information about an activity that was performed by a campaign.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ActivityResponse()

Constructors
Constructor and Description
`ActivityResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ActivityResponse`	`addExecutionMetricsEntry(String key, String value)` Add a single ExecutionMetrics entry
`ActivityResponse`	`clearExecutionMetricsEntries()` Removes all the entries added into ExecutionMetrics.
`ActivityResponse`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The unique identifier for the application that the campaign applies to.
`String`	`getCampaignId()` The unique identifier for the campaign that the activity applies to.
`String`	`getEnd()` The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
`Map<String,String>`	`getExecutionMetrics()` A JSON object that contains metrics relating to the campaign execution for this campaign activity.
`String`	`getId()` The unique identifier for the activity.
`String`	`getResult()` Specifies whether the activity succeeded.
`String`	`getScheduledStart()` The scheduled start time, in ISO 8601 format, for the activity.
`String`	`getStart()` The actual start time, in ISO 8601 format, of the activity.
`String`	`getState()` The current status of the activity.
`Integer`	`getSuccessfulEndpointCount()` The total number of endpoints that the campaign successfully delivered messages to.
`Integer`	`getTimezonesCompletedCount()` The total number of time zones that were completed.
`Integer`	`getTimezonesTotalCount()` The total number of unique time zones that are in the segment for the campaign.
`Integer`	`getTotalEndpointCount()` The total number of endpoints that the campaign attempted to deliver messages to.
`String`	`getTreatmentId()` The unique identifier for the campaign treatment that the activity applies to.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplicationId(String applicationId)` The unique identifier for the application that the campaign applies to.
`void`	`setCampaignId(String campaignId)` The unique identifier for the campaign that the activity applies to.
`void`	`setEnd(String end)` The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
`void`	`setExecutionMetrics(Map<String,String> executionMetrics)` A JSON object that contains metrics relating to the campaign execution for this campaign activity.
`void`	`setId(String id)` The unique identifier for the activity.
`void`	`setResult(String result)` Specifies whether the activity succeeded.
`void`	`setScheduledStart(String scheduledStart)` The scheduled start time, in ISO 8601 format, for the activity.
`void`	`setStart(String start)` The actual start time, in ISO 8601 format, of the activity.
`void`	`setState(String state)` The current status of the activity.
`void`	`setSuccessfulEndpointCount(Integer successfulEndpointCount)` The total number of endpoints that the campaign successfully delivered messages to.
`void`	`setTimezonesCompletedCount(Integer timezonesCompletedCount)` The total number of time zones that were completed.
`void`	`setTimezonesTotalCount(Integer timezonesTotalCount)` The total number of unique time zones that are in the segment for the campaign.
`void`	`setTotalEndpointCount(Integer totalEndpointCount)` The total number of endpoints that the campaign attempted to deliver messages to.
`void`	`setTreatmentId(String treatmentId)` The unique identifier for the campaign treatment that the activity applies to.
`String`	`toString()` Returns a string representation of this object.
`ActivityResponse`	`withApplicationId(String applicationId)` The unique identifier for the application that the campaign applies to.
`ActivityResponse`	`withCampaignId(String campaignId)` The unique identifier for the campaign that the activity applies to.
`ActivityResponse`	`withEnd(String end)` The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
`ActivityResponse`	`withExecutionMetrics(Map<String,String> executionMetrics)` A JSON object that contains metrics relating to the campaign execution for this campaign activity.
`ActivityResponse`	`withId(String id)` The unique identifier for the activity.
`ActivityResponse`	`withResult(String result)` Specifies whether the activity succeeded.
`ActivityResponse`	`withScheduledStart(String scheduledStart)` The scheduled start time, in ISO 8601 format, for the activity.
`ActivityResponse`	`withStart(String start)` The actual start time, in ISO 8601 format, of the activity.
`ActivityResponse`	`withState(String state)` The current status of the activity.
`ActivityResponse`	`withSuccessfulEndpointCount(Integer successfulEndpointCount)` The total number of endpoints that the campaign successfully delivered messages to.
`ActivityResponse`	`withTimezonesCompletedCount(Integer timezonesCompletedCount)` The total number of time zones that were completed.
`ActivityResponse`	`withTimezonesTotalCount(Integer timezonesTotalCount)` The total number of unique time zones that are in the segment for the campaign.
`ActivityResponse`	`withTotalEndpointCount(Integer totalEndpointCount)` The total number of endpoints that the campaign attempted to deliver messages to.
`ActivityResponse`	`withTreatmentId(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

- Constructor Detail
  - ActivityResponse
```
public ActivityResponse()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The unique identifier for the application that the campaign applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the campaign applies to.
  - getApplicationId
```
public String getApplicationId()
```
    The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    The unique identifier for the application that the campaign applies to.
  - withApplicationId
```
public ActivityResponse withApplicationId(String applicationId)
```
    The unique identifier for the application that the campaign applies to.
    
    Parameters:
    
    applicationId - The unique identifier for the application that the campaign applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    The unique identifier for the campaign that the activity applies to.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign that the activity applies to.
  - getCampaignId
```
public String getCampaignId()
```
    The unique identifier for the campaign that the activity applies to.
    
    Returns:
    
    The unique identifier for the campaign that the activity applies to.
  - withCampaignId
```
public ActivityResponse withCampaignId(String campaignId)
```
    The unique identifier for the campaign that the activity applies to.
    
    Parameters:
    
    campaignId - The unique identifier for the campaign that the activity applies to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnd
```
public void setEnd(String end)
```
    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
    
    Parameters:
    
    end - The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
  - getEnd
```
public String getEnd()
```
    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.
  - withEnd
```
public ActivityResponse withEnd(String end)
```
    The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
    
    Parameters:
    
    end - The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique identifier for the activity.
    
    Parameters:
    
    id - The unique identifier for the activity.
  - getId
```
public String getId()
```
    The unique identifier for the activity.
    
    Returns:
    
    The unique identifier for the activity.
  - withId
```
public ActivityResponse withId(String id)
```
    The unique identifier for the activity.
    
    Parameters:
    
    id - The unique identifier for the activity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResult
```
public void setResult(String result)
```
    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
    
    Parameters:
    
    result - Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
  - getResult
```
public String getResult()
```
    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
    
    Returns:
    
    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
  - withResult
```
public ActivityResponse withResult(String result)
```
    Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
    
    Parameters:
    
    result - Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setScheduledStart
```
public void setScheduledStart(String scheduledStart)
```
    The scheduled start time, in ISO 8601 format, for the activity.
    
    Parameters:
    
    scheduledStart - The scheduled start time, in ISO 8601 format, for the activity.
  - getScheduledStart
```
public String getScheduledStart()
```
    The scheduled start time, in ISO 8601 format, for the activity.
    
    Returns:
    
    The scheduled start time, in ISO 8601 format, for the activity.
  - withScheduledStart
```
public ActivityResponse withScheduledStart(String scheduledStart)
```
    The scheduled start time, in ISO 8601 format, for the activity.
    
    Parameters:
    
    scheduledStart - The scheduled start time, in ISO 8601 format, for the activity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStart
```
public void setStart(String start)
```
    The actual start time, in ISO 8601 format, of the activity.
    
    Parameters:
    
    start - The actual start time, in ISO 8601 format, of the activity.
  - getStart
```
public String getStart()
```
    The actual start time, in ISO 8601 format, of the activity.
    
    Returns:
    
    The actual start time, in ISO 8601 format, of the activity.
  - withStart
```
public ActivityResponse withStart(String start)
```
    The actual start time, in ISO 8601 format, of the activity.
    
    Parameters:
    
    start - The actual start time, in ISO 8601 format, of the activity.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
    
    Parameters:
    
    state - The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
  - getState
```
public String getState()
```
    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.
  - withState
```
public ActivityResponse withState(String state)
```
    The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
    
    Parameters:
    
    state - The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSuccessfulEndpointCount
```
public void setSuccessfulEndpointCount(Integer successfulEndpointCount)
```
    The total number of endpoints that the campaign successfully delivered messages to.
    
    Parameters:
    
    successfulEndpointCount - The total number of endpoints that the campaign successfully delivered messages to.
  - getSuccessfulEndpointCount
```
public Integer getSuccessfulEndpointCount()
```
    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.
  - withSuccessfulEndpointCount
```
public ActivityResponse withSuccessfulEndpointCount(Integer successfulEndpointCount)
```
    The total number of endpoints that the campaign successfully delivered messages to.
    
    Parameters:
    
    successfulEndpointCount - The total number of endpoints that the campaign successfully delivered messages to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimezonesCompletedCount
```
public void setTimezonesCompletedCount(Integer timezonesCompletedCount)
```
    The total number of time zones that were completed.
    
    Parameters:
    
    timezonesCompletedCount - The total number of time zones that were completed.
  - getTimezonesCompletedCount
```
public Integer getTimezonesCompletedCount()
```
    The total number of time zones that were completed.
    
    Returns:
    
    The total number of time zones that were completed.
  - withTimezonesCompletedCount
```
public ActivityResponse withTimezonesCompletedCount(Integer timezonesCompletedCount)
```
    The total number of time zones that were completed.
    
    Parameters:
    
    timezonesCompletedCount - The total number of time zones that were completed.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTimezonesTotalCount
```
public void setTimezonesTotalCount(Integer timezonesTotalCount)
```
    The total number of unique time zones that are in the segment for the campaign.
    
    Parameters:
    
    timezonesTotalCount - The total number of unique time zones that are in the segment for the campaign.
  - getTimezonesTotalCount
```
public Integer getTimezonesTotalCount()
```
    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.
  - withTimezonesTotalCount
```
public ActivityResponse withTimezonesTotalCount(Integer timezonesTotalCount)
```
    The total number of unique time zones that are in the segment for the campaign.
    
    Parameters:
    
    timezonesTotalCount - The total number of unique time zones that are in the segment for the campaign.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalEndpointCount
```
public void setTotalEndpointCount(Integer totalEndpointCount)
```
    The total number of endpoints that the campaign attempted to deliver messages to.
    
    Parameters:
    
    totalEndpointCount - The total number of endpoints that the campaign attempted to deliver messages to.
  - getTotalEndpointCount
```
public Integer getTotalEndpointCount()
```
    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.
  - withTotalEndpointCount
```
public ActivityResponse withTotalEndpointCount(Integer totalEndpointCount)
```
    The total number of endpoints that the campaign attempted to deliver messages to.
    
    Parameters:
    
    totalEndpointCount - The total number of endpoints that the campaign attempted to deliver messages to.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentId
```
public void setTreatmentId(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.
    
    Parameters:
    
    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.
  - getTreatmentId
```
public String getTreatmentId()
```
    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.
  - withTreatmentId
```
public ActivityResponse withTreatmentId(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - getExecutionMetrics
```
public Map<String,String> getExecutionMetrics()
```
    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.
    
    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.
  - setExecutionMetrics
```
public void setExecutionMetrics(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.
    
    Parameters:
    
    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.
  - withExecutionMetrics
```
public ActivityResponse withExecutionMetrics(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addExecutionMetricsEntry
```
public ActivityResponse addExecutionMetricsEntry(String key,
                                                 String value)
```
    Add a single ExecutionMetrics entry
    
    See Also:
    
    withExecutionMetrics(java.util.Map<java.lang.String, java.lang.String>)
  - clearExecutionMetricsEntries
```
public ActivityResponse clearExecutionMetricsEntries()
```
    Removes all the entries added into ExecutionMetrics.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public ActivityResponse clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.779

Class ActivityResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ActivityResponse

Method Detail

setApplicationId

getApplicationId

withApplicationId

setCampaignId

getCampaignId

withCampaignId

setEnd

getEnd

withEnd

setId

getId

withId

setResult

getResult

withResult

setScheduledStart

getScheduledStart

withScheduledStart

setStart

getStart

withStart

setState

getState

withState

setSuccessfulEndpointCount

getSuccessfulEndpointCount

withSuccessfulEndpointCount

setTimezonesCompletedCount

getTimezonesCompletedCount

withTimezonesCompletedCount

setTimezonesTotalCount

getTimezonesTotalCount

withTimezonesTotalCount

setTotalEndpointCount

getTotalEndpointCount

withTotalEndpointCount

setTreatmentId

getTreatmentId

withTreatmentId

getExecutionMetrics

setExecutionMetrics

withExecutionMetrics

addExecutionMetricsEntry

clearExecutionMetricsEntries

toString

equals

hashCode

clone

marshall