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

Interface JourneyDateRangeKpiResponse.Builder

    • Method Detail

      • applicationId

        JourneyDateRangeKpiResponse.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.

      • endTime

        JourneyDateRangeKpiResponse.Builder endTime​(Instant endTime)

        The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

        Parameters:
        endTime - The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • journeyId

        JourneyDateRangeKpiResponse.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.

      • kpiName

        JourneyDateRangeKpiResponse.Builder kpiName​(String kpiName)

        The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved 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. For a list of possible values, see the Amazon Pinpoint Developer Guide.

        Parameters:
        kpiName - The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved 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. For a list of possible values, see the Amazon Pinpoint Developer Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kpiResult

        JourneyDateRangeKpiResponse.Builder kpiResult​(BaseKpiResult kpiResult)

        An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.

        Parameters:
        kpiResult - An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • nextToken

        JourneyDateRangeKpiResponse.Builder nextToken​(String nextToken)

        The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.

        Parameters:
        nextToken - The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • startTime

        JourneyDateRangeKpiResponse.Builder startTime​(Instant startTime)

        The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.

        Parameters:
        startTime - The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
        Returns:
        Returns a reference to this object so that method calls can be chained together.