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

Interface GetJourneyDateRangeKpiRequest.Builder

    • Method Detail

      • 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

        GetJourneyDateRangeKpiRequest.Builder endTime​(Instant 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

        GetJourneyDateRangeKpiRequest.Builder journeyId​(String 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

        GetJourneyDateRangeKpiRequest.Builder kpiName​(String 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

        GetJourneyDateRangeKpiRequest.Builder nextToken​(String 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

        GetJourneyDateRangeKpiRequest.Builder pageSize​(String 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

        GetJourneyDateRangeKpiRequest.Builder startTime​(Instant 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.