Interface ActivityResponse.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<ActivityResponse.Builder,
,ActivityResponse> SdkBuilder<ActivityResponse.Builder,
,ActivityResponse> SdkPojo
- Enclosing class:
ActivityResponse
-
Method Summary
Modifier and TypeMethodDescriptionapplicationId
(String applicationId) The unique identifier for the application that the campaign applies to.campaignId
(String campaignId) The unique identifier for the campaign that the activity applies to.The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.executionMetrics
(Map<String, String> executionMetrics) A JSON object that contains metrics relating to the campaign execution for this campaign activity.The unique identifier for the activity.Specifies whether the activity succeeded.scheduledStart
(String scheduledStart) The scheduled start time, in ISO 8601 format, for the activity.The actual start time, in ISO 8601 format, of the activity.The current status of the activity.successfulEndpointCount
(Integer successfulEndpointCount) The total number of endpoints that the campaign successfully delivered messages to.timezonesCompletedCount
(Integer timezonesCompletedCount) The total number of time zones that were completed.timezonesTotalCount
(Integer timezonesTotalCount) The total number of unique time zones that are in the segment for the campaign.totalEndpointCount
(Integer totalEndpointCount) The total number of endpoints that the campaign attempted to deliver messages to.treatmentId
(String treatmentId) The unique identifier for the campaign treatment that the activity applies to.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-
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.
-