Package software.amazon.awssdk.services.pinpoint.model

Interface ActivityResponse.Builder

All Superinterfaces:

CopyableBuilder<ActivityResponse.Builder,ActivityResponse>, SdkBuilder<ActivityResponse.Builder,ActivityResponse>

Enclosing class:

ActivityResponse

public static interface ActivityResponse.Builder
extends CopyableBuilder<ActivityResponse.Builder,ActivityResponse>

Method Summary

Modifier and Type	Method	Description
ActivityResponse.Builder	applicationId(String applicationId)	The ID of the application to which the campaign applies.
ActivityResponse.Builder	campaignId(String campaignId)	The ID of the campaign to which the activity applies.
ActivityResponse.Builder	end(String end)	The actual time the activity was marked CANCELLED or COMPLETED.
ActivityResponse.Builder	id(String id)	The unique activity ID.
ActivityResponse.Builder	result(String result)	Indicates whether the activity succeeded.
ActivityResponse.Builder	scheduledStart(String scheduledStart)	The scheduled start time for the activity in ISO 8601 format.
ActivityResponse.Builder	start(String start)	The actual start time of the activity in ISO 8601 format.
ActivityResponse.Builder	state(String state)	The state of the activity.
ActivityResponse.Builder	successfulEndpointCount(Integer successfulEndpointCount)	The total number of endpoints to which the campaign successfully delivered messages.
ActivityResponse.Builder	timezonesCompletedCount(Integer timezonesCompletedCount)	The total number of timezones completed.
ActivityResponse.Builder	timezonesTotalCount(Integer timezonesTotalCount)	The total number of unique timezones present in the segment.
ActivityResponse.Builder	totalEndpointCount(Integer totalEndpointCount)	The total number of endpoints to which the campaign attempts to deliver messages.
ActivityResponse.Builder	treatmentId(String treatmentId)	The ID of a variation of the campaign used for A/B testing.

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

copy

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

apply, build

Method Detail

applicationId

ActivityResponse.Builder applicationId(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.

campaignId

ActivityResponse.Builder campaignId(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.

end

ActivityResponse.Builder end(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.

id

ActivityResponse.Builder id(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.

result

ActivityResponse.Builder result(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.

scheduledStart

ActivityResponse.Builder scheduledStart(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.

start

ActivityResponse.Builder start(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.

state

ActivityResponse.Builder state(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.

successfulEndpointCount

ActivityResponse.Builder successfulEndpointCount(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.

timezonesCompletedCount

ActivityResponse.Builder timezonesCompletedCount(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.

timezonesTotalCount

ActivityResponse.Builder timezonesTotalCount(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.

totalEndpointCount

ActivityResponse.Builder totalEndpointCount(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.

treatmentId

ActivityResponse.Builder treatmentId(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.