Interface ApplicationDateRangeKpiResponse.Builder

All Superinterfaces:
Buildable, CopyableBuilder<ApplicationDateRangeKpiResponse.Builder,ApplicationDateRangeKpiResponse>, SdkBuilder<ApplicationDateRangeKpiResponse.Builder,ApplicationDateRangeKpiResponse>, SdkPojo
Enclosing class:
ApplicationDateRangeKpiResponse

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

    • applicationId

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

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

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

      This is a convenience method that creates an instance of the BaseKpiResult.Builder avoiding the need to create one manually via BaseKpiResult.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to kpiResult(BaseKpiResult).

      Parameters:
      kpiResult - a consumer that will call methods on BaseKpiResult.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • 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 Application 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 Application 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

      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.