Interface DescribeDimensionKeysRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>, PiRequest.Builder, SdkBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeDimensionKeysRequest
public static interface DescribeDimensionKeysRequest.Builder extends PiRequest.Builder, SdkPojo, CopyableBuilder<DescribeDimensionKeysRequest.Builder,DescribeDimensionKeysRequest>

  • Method Details

    • serviceType

      DescribeDimensionKeysRequest.Builder serviceType(String serviceType)

      The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

      • RDS

      • DOCDB

      Parameters:
      serviceType - The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

      • RDS

      • DOCDB

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

    • serviceType

      DescribeDimensionKeysRequest.Builder serviceType(ServiceType serviceType)

      The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

      • RDS

      • DOCDB

      Parameters:
      serviceType - The Amazon Web Services service for which Performance Insights will return metrics. Valid values are as follows:

      • RDS

      • DOCDB

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

    • identifier

      DescribeDimensionKeysRequest.Builder identifier(String identifier)

      An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

      To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

      Parameters:
      identifier - An immutable, Amazon Web Services Region-unique identifier for a data source. Performance Insights gathers metrics from this data source.

      To use an Amazon RDS instance as a data source, you specify its DbiResourceId value. For example, specify db-FAIHNTYBKTGAUSUZQYPDS2GW4A.

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

    • startTime

      DescribeDimensionKeysRequest.Builder startTime(Instant startTime)

      The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

      The value for StartTime must be earlier than the value for EndTime.

      Parameters:
      startTime - The date and time specifying the beginning of the requested time series data. You must specify a StartTime within the past 7 days. The value specified is inclusive, which means that data points equal to or greater than StartTime are returned.

      The value for StartTime must be earlier than the value for EndTime.

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

    • endTime

      DescribeDimensionKeysRequest.Builder endTime(Instant endTime)

      The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

      The value for EndTime must be later than the value for StartTime.

      Parameters:
      endTime - The date and time specifying the end of the requested time series data. The value specified is exclusive, which means that data points less than (but not equal to) EndTime are returned.

      The value for EndTime must be later than the value for StartTime.

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

    • metric

      DescribeDimensionKeysRequest.Builder metric(String metric)

      The name of a Performance Insights metric to be measured.

      Valid values for Metric are:

      • db.load.avg - A scaled representation of the number of active sessions for the database engine.

      • db.sampledload.avg - The raw number of active sessions for the database engine.

      If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

      Parameters:
      metric - The name of a Performance Insights metric to be measured.

      Valid values for Metric are:

      • db.load.avg - A scaled representation of the number of active sessions for the database engine.

      • db.sampledload.avg - The raw number of active sessions for the database engine.

      If the number of active sessions is less than an internal Performance Insights threshold, db.load.avg and db.sampledload.avg are the same value. If the number of active sessions is greater than the internal threshold, Performance Insights samples the active sessions, with db.load.avg showing the scaled values, db.sampledload.avg showing the raw values, and db.sampledload.avg less than db.load.avg. For most use cases, you can query db.load.avg only.

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

    • periodInSeconds

      DescribeDimensionKeysRequest.Builder periodInSeconds(Integer periodInSeconds)

      The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

      • 1 (one second)

      • 60 (one minute)

      • 300 (five minutes)

      • 3600 (one hour)

      • 86400 (twenty-four hours)

      If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

      Parameters:
      periodInSeconds - The granularity, in seconds, of the data points returned from Performance Insights. A period can be as short as one second, or as long as one day (86400 seconds). Valid values are:

      • 1 (one second)

      • 60 (one minute)

      • 300 (five minutes)

      • 3600 (one hour)

      • 86400 (twenty-four hours)

      If you don't specify PeriodInSeconds, then Performance Insights chooses a value for you, with a goal of returning roughly 100-200 data points in the response.

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

    • groupBy

      DescribeDimensionKeysRequest.Builder groupBy(DimensionGroup groupBy)

      A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

      Parameters:
      groupBy - A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupBy

      default DescribeDimensionKeysRequest.Builder groupBy(Consumer<DimensionGroup.Builder> groupBy)

      A specification for how to aggregate the data points from a query result. You must specify a valid dimension group. Performance Insights returns all dimensions within this group, unless you provide the names of specific dimensions within this group. You can also request that Performance Insights return a limited number of values for a dimension.

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

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

      Parameters:
      groupBy - a consumer that will call methods on DimensionGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • additionalMetrics

      DescribeDimensionKeysRequest.Builder additionalMetrics(Collection<String> additionalMetrics)

      Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

      Parameters:
      additionalMetrics - Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • additionalMetrics

      DescribeDimensionKeysRequest.Builder additionalMetrics(String... additionalMetrics)

      Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.

      Parameters:
      additionalMetrics - Additional metrics for the top N dimension keys. If the specified dimension group in the GroupBy parameter is db.sql_tokenized, you can specify per-SQL metrics to get the values for the top N SQL digests. The response syntax is as follows: "AdditionalMetrics" : { "string" : "string" }.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionBy

      DescribeDimensionKeysRequest.Builder partitionBy(DimensionGroup partitionBy)

      For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

      Parameters:
      partitionBy - For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • partitionBy

      default DescribeDimensionKeysRequest.Builder partitionBy(Consumer<DimensionGroup.Builder> partitionBy)

      For each dimension specified in GroupBy, specify a secondary dimension to further subdivide the partition keys in the response.

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

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

      Parameters:
      partitionBy - a consumer that will call methods on DimensionGroup.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • filter

      DescribeDimensionKeysRequest.Builder filter(Map<String,String> filter)

      One or more filters to apply in the request. Restrictions:

      • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

      • A single filter for any other dimension in this dimension group.

      The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

      Parameters:
      filter - One or more filters to apply in the request. Restrictions:

      • Any number of filters by the same dimension, as specified in the GroupBy or Partition parameters.

      • A single filter for any other dimension in this dimension group.

      The db.sql.db_id filter isn't available for RDS for SQL Server DB instances.

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

    • maxResults

      DescribeDimensionKeysRequest.Builder maxResults(Integer maxResults)

      The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.

      Parameters:
      maxResults - The maximum number of items to return in the response. If more items exist than the specified MaxRecords value, a pagination token is included in the response so that the remaining results can be retrieved.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      DescribeDimensionKeysRequest.Builder nextToken(String nextToken)

      An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.

      Parameters:
      nextToken - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the token, up to the value specified by MaxRecords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

      DescribeDimensionKeysRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      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.