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

Interface ActivityResponse.Builder

    • Method Detail

      • applicationId

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

      • campaignId

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

      • end

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

      • id

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

      • result

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

      • scheduledStart

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

      • start

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

      • state

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

      • successfulEndpointCount

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

      • timezonesCompletedCount

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

      • timezonesTotalCount

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

      • totalEndpointCount

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

      • treatmentId

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

      • executionMetrics

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