Interface GetDimensionKeyDetailsRequest.Builder

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

  • Method Details

    • serviceType

      GetDimensionKeyDetailsRequest.Builder serviceType(String serviceType)

      The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

      Parameters:
      serviceType - The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • serviceType

      GetDimensionKeyDetailsRequest.Builder serviceType(ServiceType serviceType)

      The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.

      Parameters:
      serviceType - The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • identifier

      GetDimensionKeyDetailsRequest.Builder identifier(String identifier)

      The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.

      Parameters:
      identifier - The ID for a data source from which to gather dimension data. This ID must be immutable and unique within an Amazon Web Services Region. When a DB instance is the data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • group

      GetDimensionKeyDetailsRequest.Builder group(String group)

      The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

      • db.execution_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot (Aurora only)

      • db.query (Amazon DocumentDB only)

      • db.sql (Amazon RDS and Aurora only)

      Parameters:
      group - The name of the dimension group. Performance Insights searches the specified group for the dimension group ID. The following group name values are valid:

      • db.execution_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot (Aurora only)

      • db.query (Amazon DocumentDB only)

      • db.sql (Amazon RDS and Aurora only)

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

    • groupIdentifier

      GetDimensionKeyDetailsRequest.Builder groupIdentifier(String groupIdentifier)

      The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

      • db.execution_plan.id for dimension group db.execution_plan (Aurora and RDS only)

      • db.sql.id for dimension group db.sql (Aurora and RDS only)

      • db.query.id for dimension group db.query (DocumentDB only)

      • For the dimension group db.lock_snapshot, the GroupIdentifier is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the GetResourceMetrics operation for a 1 second period.

      Parameters:
      groupIdentifier - The ID of the dimension group from which to retrieve dimension details. For dimension group db.sql, the group ID is db.sql.id. The following group ID values are valid:

      • db.execution_plan.id for dimension group db.execution_plan (Aurora and RDS only)

      • db.sql.id for dimension group db.sql (Aurora and RDS only)

      • db.query.id for dimension group db.query (DocumentDB only)

      • For the dimension group db.lock_snapshot, the GroupIdentifier is the epoch timestamp when Performance Insights captured the snapshot, in seconds. You can retrieve this value with the GetResourceMetrics operation for a 1 second period.

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

    • requestedDimensions

      GetDimensionKeyDetailsRequest.Builder requestedDimensions(Collection<String> requestedDimensions)

      A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

      • db.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)

      • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

      • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

      Parameters:
      requestedDimensions - A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

      • db.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)

      • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

      • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

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

    • requestedDimensions

      GetDimensionKeyDetailsRequest.Builder requestedDimensions(String... requestedDimensions)

      A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

      • db.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)

      • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

      • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

      Parameters:
      requestedDimensions - A list of dimensions to retrieve the detail data for within the given dimension group. If you don't specify this parameter, Performance Insights returns all dimension data within the specified dimension group. Specify dimension names for the following dimension groups:

      • db.execution_plan - Specify the dimension name db.execution_plan.raw_plan or the short dimension name raw_plan (Amazon RDS and Aurora only)

      • db.lock_snapshot - Specify the dimension name db.lock_snapshot.lock_trees or the short dimension name lock_trees. (Aurora only)

      • db.sql - Specify either the full dimension name db.sql.statement or the short dimension name statement (Aurora and RDS only).

      • db.query - Specify either the full dimension name db.query.statement or the short dimension name statement (DocumentDB only).

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

    • overrideConfiguration

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

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