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

Interface JourneyRunExecutionActivityMetricsResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>, SdkBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>, SdkPojo
Enclosing class:
JourneyRunExecutionActivityMetricsResponse
public static interface JourneyRunExecutionActivityMetricsResponse.Builder extends SdkPojo, CopyableBuilder<JourneyRunExecutionActivityMetricsResponse.Builder,JourneyRunExecutionActivityMetricsResponse>

  • Method Details

    • activityType

      JourneyRunExecutionActivityMetricsResponse.Builder activityType(String activityType)

      The type of activity that the metric applies to. Possible values are:

      • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

      • HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

      • MESSAGE – For an email activity, which is an activity that sends an email message to participants.

      • MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

      • RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

      • WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

      Parameters:
      activityType - The type of activity that the metric applies to. Possible values are:

      • CONDITIONAL_SPLIT – For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey.

      • HOLDOUT – For a holdout activity, which is an activity that stops a journey for a specified percentage of participants.

      • MESSAGE – For an email activity, which is an activity that sends an email message to participants.

      • MULTI_CONDITIONAL_SPLIT – For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey.

      • RANDOM_SPLIT – For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey.

      • WAIT – For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • applicationId

      JourneyRunExecutionActivityMetricsResponse.Builder applicationId(String applicationId)

      The unique identifier for the application that the metric applies to.

      Parameters:
      applicationId - The unique identifier for the application that the metric applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • journeyActivityId

      JourneyRunExecutionActivityMetricsResponse.Builder journeyActivityId(String journeyActivityId)

      The unique identifier for the activity that the metric applies to.

      Parameters:
      journeyActivityId - The unique identifier for the activity that the metric applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • journeyId

      JourneyRunExecutionActivityMetricsResponse.Builder journeyId(String journeyId)

      The unique identifier for the journey that the metric applies to.

      Parameters:
      journeyId - The unique identifier for the journey that the metric applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastEvaluatedTime

      JourneyRunExecutionActivityMetricsResponse.Builder lastEvaluatedTime(String lastEvaluatedTime)

      The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.

      Parameters:
      lastEvaluatedTime - The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity for this journey run and updated the data for the metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metrics

      JourneyRunExecutionActivityMetricsResponse.Builder metrics(Map<String,String> metrics)

      A JSON object that contains the results of the query. For information about the structure and contents of the results, see see Standard Amazon Pinpoint analytics metrics in the Amazon Pinpoint Developer Guide.

      Parameters:
      metrics - A JSON object that contains the results of the query. For information about the structure and contents of the results, see 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.

    • runId

      JourneyRunExecutionActivityMetricsResponse.Builder runId(String runId)

      The unique identifier for the journey run that the metric applies to.

      Parameters:
      runId - The unique identifier for the journey run that the metric applies to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.