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

Activity definition

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`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getApplicationId()` The ID of the application to which the campaign applies.
`String`	`getCampaignId()` The ID of the campaign to which the activity applies.
`String`	`getEnd()` The actual time the activity was marked CANCELLED or COMPLETED.
`String`	`getId()` The unique activity ID.
`String`	`getResult()` Indicates whether the activity succeeded.
`String`	`getScheduledStart()` The scheduled start time for the activity in ISO 8601 format.
`String`	`getStart()` The actual start time of the activity in ISO 8601 format.
`String`	`getState()` The state of the activity.
`Integer`	`getSuccessfulEndpointCount()` The total number of endpoints to which the campaign successfully delivered messages.
`Integer`	`getTimezonesCompletedCount()` The total number of timezones completed.
`Integer`	`getTimezonesTotalCount()` The total number of unique timezones present in the segment.
`Integer`	`getTotalEndpointCount()` The total number of endpoints to which the campaign attempts to deliver messages.
`String`	`getTreatmentId()` The ID of a variation of the campaign used for A/B testing.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setApplicationId(String applicationId)` The ID of the application to which the campaign applies.
`void`	`setCampaignId(String campaignId)` The ID of the campaign to which the activity applies.
`void`	`setEnd(String end)` The actual time the activity was marked CANCELLED or COMPLETED.
`void`	`setId(String id)` The unique activity ID.
`void`	`setResult(String result)` Indicates whether the activity succeeded.
`void`	`setScheduledStart(String scheduledStart)` The scheduled start time for the activity in ISO 8601 format.
`void`	`setStart(String start)` The actual start time of the activity in ISO 8601 format.
`void`	`setState(String state)` The state of the activity.
`void`	`setSuccessfulEndpointCount(Integer successfulEndpointCount)` The total number of endpoints to which the campaign successfully delivered messages.
`void`	`setTimezonesCompletedCount(Integer timezonesCompletedCount)` The total number of timezones completed.
`void`	`setTimezonesTotalCount(Integer timezonesTotalCount)` The total number of unique timezones present in the segment.
`void`	`setTotalEndpointCount(Integer totalEndpointCount)` The total number of endpoints to which the campaign attempts to deliver messages.
`void`	`setTreatmentId(String treatmentId)` The ID of a variation of the campaign used for A/B testing.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`ActivityResponse`	`withApplicationId(String applicationId)` The ID of the application to which the campaign applies.
`ActivityResponse`	`withCampaignId(String campaignId)` The ID of the campaign to which the activity applies.
`ActivityResponse`	`withEnd(String end)` The actual time the activity was marked CANCELLED or COMPLETED.
`ActivityResponse`	`withId(String id)` The unique activity ID.
`ActivityResponse`	`withResult(String result)` Indicates whether the activity succeeded.
`ActivityResponse`	`withScheduledStart(String scheduledStart)` The scheduled start time for the activity in ISO 8601 format.
`ActivityResponse`	`withStart(String start)` The actual start time of the activity in ISO 8601 format.
`ActivityResponse`	`withState(String state)` The state of the activity.
`ActivityResponse`	`withSuccessfulEndpointCount(Integer successfulEndpointCount)` The total number of endpoints to which the campaign successfully delivered messages.
`ActivityResponse`	`withTimezonesCompletedCount(Integer timezonesCompletedCount)` The total number of timezones completed.
`ActivityResponse`	`withTimezonesTotalCount(Integer timezonesTotalCount)` The total number of unique timezones present in the segment.
`ActivityResponse`	`withTotalEndpointCount(Integer totalEndpointCount)` The total number of endpoints to which the campaign attempts to deliver messages.
`ActivityResponse`	`withTreatmentId(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

- Constructor Detail
  - ActivityResponse
```
public ActivityResponse()
```
- Method Detail
  - setApplicationId
```
public void setApplicationId(String applicationId)
```
    The ID of the application to which the campaign applies.
    
    Parameters:
    
    applicationId - The ID of the application to which the campaign applies.
  - getApplicationId
```
public String getApplicationId()
```
    The ID of the application to which the campaign applies.
    
    Returns:
    
    The ID of the application to which the campaign applies.
  - withApplicationId
```
public ActivityResponse withApplicationId(String applicationId)
```
    The ID of the application to which the campaign applies.
    
    Parameters:
    
    applicationId - The ID of the application to which the campaign applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCampaignId
```
public void setCampaignId(String campaignId)
```
    The ID of the campaign to which the activity applies.
    
    Parameters:
    
    campaignId - The ID of the campaign to which the activity applies.
  - getCampaignId
```
public String getCampaignId()
```
    The ID of the campaign to which the activity applies.
    
    Returns:
    
    The ID of the campaign to which the activity applies.
  - withCampaignId
```
public ActivityResponse withCampaignId(String campaignId)
```
    The ID of the campaign to which the activity applies.
    
    Parameters:
    
    campaignId - The ID of the campaign to which the activity applies.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEnd
```
public void setEnd(String end)
```
    The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
    
    Parameters:
    
    end - The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
  - getEnd
```
public String getEnd()
```
    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.
  - withEnd
```
public ActivityResponse withEnd(String end)
```
    The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
    
    Parameters:
    
    end - The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setId
```
public void setId(String id)
```
    The unique activity ID.
    
    Parameters:
    
    id - The unique activity ID.
  - getId
```
public String getId()
```
    The unique activity ID.
    
    Returns:
    
    The unique activity ID.
  - withId
```
public ActivityResponse withId(String id)
```
    The unique activity ID.
    
    Parameters:
    
    id - The unique activity ID.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setResult
```
public void setResult(String result)
```
    Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
    
    Parameters:
    
    result - Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
  - getResult
```
public String getResult()
```
    Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
    
    Returns:
    
    Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
  - withResult
```
public ActivityResponse withResult(String result)
```
    Indicates whether the activity succeeded. Valid values: SUCCESS, FAIL
    
    Parameters:
    
    result - Indicates whether the activity succeeded. Valid values: SUCCESS, 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 for the activity in ISO 8601 format.
    
    Parameters:
    
    scheduledStart - The scheduled start time for the activity in ISO 8601 format.
  - getScheduledStart
```
public String getScheduledStart()
```
    The scheduled start time for the activity in ISO 8601 format.
    
    Returns:
    
    The scheduled start time for the activity in ISO 8601 format.
  - withScheduledStart
```
public ActivityResponse withScheduledStart(String scheduledStart)
```
    The scheduled start time for the activity in ISO 8601 format.
    
    Parameters:
    
    scheduledStart - The scheduled start time for the activity in ISO 8601 format.
    
    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 of the activity in ISO 8601 format.
    
    Parameters:
    
    start - The actual start time of the activity in ISO 8601 format.
  - getStart
```
public String getStart()
```
    The actual start time of the activity in ISO 8601 format.
    
    Returns:
    
    The actual start time of the activity in ISO 8601 format.
  - withStart
```
public ActivityResponse withStart(String start)
```
    The actual start time of the activity in ISO 8601 format.
    
    Parameters:
    
    start - The actual start time of the activity in ISO 8601 format.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
    
    Parameters:
    
    state - The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
  - getState
```
public String getState()
```
    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
  - withState
```
public ActivityResponse withState(String state)
```
    The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED
    
    Parameters:
    
    state - The state of the activity. Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, 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 to which the campaign successfully delivered messages.
    
    Parameters:
    
    successfulEndpointCount - The total number of endpoints to which the campaign successfully delivered messages.
  - getSuccessfulEndpointCount
```
public Integer getSuccessfulEndpointCount()
```
    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.
  - withSuccessfulEndpointCount
```
public ActivityResponse withSuccessfulEndpointCount(Integer successfulEndpointCount)
```
    The total number of endpoints to which the campaign successfully delivered messages.
    
    Parameters:
    
    successfulEndpointCount - The total number of endpoints to which the campaign successfully delivered messages.
    
    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 timezones completed.
    
    Parameters:
    
    timezonesCompletedCount - The total number of timezones completed.
  - getTimezonesCompletedCount
```
public Integer getTimezonesCompletedCount()
```
    The total number of timezones completed.
    
    Returns:
    
    The total number of timezones completed.
  - withTimezonesCompletedCount
```
public ActivityResponse withTimezonesCompletedCount(Integer timezonesCompletedCount)
```
    The total number of timezones completed.
    
    Parameters:
    
    timezonesCompletedCount - The total number of timezones 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 timezones present in the segment.
    
    Parameters:
    
    timezonesTotalCount - The total number of unique timezones present in the segment.
  - getTimezonesTotalCount
```
public Integer getTimezonesTotalCount()
```
    The total number of unique timezones present in the segment.
    
    Returns:
    
    The total number of unique timezones present in the segment.
  - withTimezonesTotalCount
```
public ActivityResponse withTimezonesTotalCount(Integer timezonesTotalCount)
```
    The total number of unique timezones present in the segment.
    
    Parameters:
    
    timezonesTotalCount - The total number of unique timezones present in the segment.
    
    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 to which the campaign attempts to deliver messages.
    
    Parameters:
    
    totalEndpointCount - The total number of endpoints to which the campaign attempts to deliver messages.
  - getTotalEndpointCount
```
public Integer getTotalEndpointCount()
```
    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.
  - withTotalEndpointCount
```
public ActivityResponse withTotalEndpointCount(Integer totalEndpointCount)
```
    The total number of endpoints to which the campaign attempts to deliver messages.
    
    Parameters:
    
    totalEndpointCount - The total number of endpoints to which the campaign attempts to deliver messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTreatmentId
```
public void setTreatmentId(String treatmentId)
```
    The ID of a variation of the campaign used for A/B testing.
    
    Parameters:
    
    treatmentId - The ID of a variation of the campaign used for A/B testing.
  - getTreatmentId
```
public String getTreatmentId()
```
    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.
  - withTreatmentId
```
public ActivityResponse withTreatmentId(String treatmentId)
```
    The ID of a variation of the campaign used for A/B testing.
    
    Parameters:
    
    treatmentId - The ID of a variation of the campaign used for A/B testing.
    
    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; useful for testing and debugging.
    
    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.

Did this page help you?

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

toString

equals

hashCode

clone

marshall