Interface GetJourneyDateRangeKpiRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>, PinpointRequest.Builder, SdkBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
GetJourneyDateRangeKpiRequest

public static interface GetJourneyDateRangeKpiRequest.Builder extends PinpointRequest.Builder, SdkPojo, CopyableBuilder<GetJourneyDateRangeKpiRequest.Builder,GetJourneyDateRangeKpiRequest>
  • Method Details

    • applicationId

      GetJourneyDateRangeKpiRequest.Builder applicationId(String applicationId)

      The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

      Parameters:
      applicationId - The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • endTime

      The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.

      Parameters:
      endTime - The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • journeyId

      The unique identifier for the journey.

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

      The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.

      Parameters:
      kpiName - The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • nextToken

      The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      Parameters:
      nextToken - The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • pageSize

      The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

      Parameters:
      pageSize - The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • startTime

      The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.

      Parameters:
      startTime - The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • overrideConfiguration

      GetJourneyDateRangeKpiRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.
    • overrideConfiguration

      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.