GetDimensionKeyDetailsRequest (AWS SDK for Java

JavaScript is disabled on your browser.

AWS SDK for Java 1.x API Reference - 1.12.793

We announced the upcoming end-of-support for AWS SDK for Java (v1). We recommend that you migrate to AWS SDK for Java v2. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

com.amazonaws.services.pi.model

Class GetDimensionKeyDetailsRequest

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.pi.model.GetDimensionKeyDetailsRequest

All Implemented Interfaces:: HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetDimensionKeyDetailsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

GetDimensionKeyDetailsRequest ()

Constructors
Constructor and Description
`GetDimensionKeyDetailsRequest ()`

Method Summary

All Methods
Modifier and Type	Method and Description
`GetDimensionKeyDetailsRequest`	`clone ()` Creates a shallow clone of this object for all fields except the handler context.
`boolean`	`equals (Object obj)`
`String`	`getGroup ()` The name of the dimension group.
`String`	`getGroupIdentifier ()` The ID of the dimension group from which to retrieve dimension details.
`String`	`getIdentifier ()` The ID for a data source from which to gather dimension data.
`List<String>`	`getRequestedDimensions ()` A list of dimensions to retrieve the detail data for within the given dimension group.
`String`	`getServiceType ()` The Amazon Web Services service for which Performance Insights returns data.
`int`	`hashCode ()`
`void`	`setGroup (String group)` The name of the dimension group.
`void`	`setGroupIdentifier (String groupIdentifier)` The ID of the dimension group from which to retrieve dimension details.
`void`	`setIdentifier (String identifier)` The ID for a data source from which to gather dimension data.
`void`	`setRequestedDimensions (Collection<String> requestedDimensions)` A list of dimensions to retrieve the detail data for within the given dimension group.
`void`	`setServiceType (String serviceType)` The Amazon Web Services service for which Performance Insights returns data.
`String`	`toString ()` Returns a string representation of this object.
`GetDimensionKeyDetailsRequest`	`withGroup (String group)` The name of the dimension group.
`GetDimensionKeyDetailsRequest`	`withGroupIdentifier (String groupIdentifier)` The ID of the dimension group from which to retrieve dimension details.
`GetDimensionKeyDetailsRequest`	`withIdentifier (String identifier)` The ID for a data source from which to gather dimension data.
`GetDimensionKeyDetailsRequest`	`withRequestedDimensions (Collection<String> requestedDimensions)` A list of dimensions to retrieve the detail data for within the given dimension group.
`GetDimensionKeyDetailsRequest`	`withRequestedDimensions (String... requestedDimensions)` A list of dimensions to retrieve the detail data for within the given dimension group.
`GetDimensionKeyDetailsRequest`	`withServiceType (ServiceType serviceType)` The Amazon Web Services service for which Performance Insights returns data.
`GetDimensionKeyDetailsRequest`	`withServiceType (String serviceType)` The Amazon Web Services service for which Performance Insights returns data.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - GetDimensionKeyDetailsRequest
```
public GetDimensionKeyDetailsRequest()
```
- Method Detail
  - setServiceType
```
public void setServiceType(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.
    
    See Also:
    
    ServiceType
  - getServiceType
```
public String getServiceType()
```
    The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
    
    Returns:
    
    The Amazon Web Services service for which Performance Insights returns data. The only valid value is RDS.
    
    See Also:
    
    ServiceType
  - withServiceType
```
public GetDimensionKeyDetailsRequest withServiceType(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
  - withServiceType
```
public GetDimensionKeyDetailsRequest withServiceType(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:
    
    ServiceType
  - setIdentifier
```
public void setIdentifier(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.
  - getIdentifier
```
public String getIdentifier()
```
    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:
    
    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.
  - withIdentifier
```
public GetDimensionKeyDetailsRequest withIdentifier(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.
  - setGroup
```
public void setGroup(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.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.query (Amazon DocumentDB only)
    
    db.sql (Amazon RDS and Aurora only)
  - getGroup
```
public String getGroup()
```
    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.query (Amazon DocumentDB only)
    - db.sql (Amazon RDS and Aurora only)
    Returns:
    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.query (Amazon DocumentDB only)
    
    db.sql (Amazon RDS and Aurora only)
  - withGroup
```
public GetDimensionKeyDetailsRequest withGroup(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.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.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.
  - setGroupIdentifier
```
public void setGroupIdentifier(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.sql.id for dimension group db.sql (Aurora and RDS only)
    - db.query.id for dimension group db.query (DocumentDB only)
    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.sql.id for dimension group db.sql (Aurora and RDS only)
    
    db.query.id for dimension group db.query (DocumentDB only)
  - getGroupIdentifier
```
public String getGroupIdentifier()
```
    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.sql.id for dimension group db.sql (Aurora and RDS only)
    - db.query.id for dimension group db.query (DocumentDB only)
    Returns:
    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.sql.id for dimension group db.sql (Aurora and RDS only)
    
    db.query.id for dimension group db.query (DocumentDB only)
  - withGroupIdentifier
```
public GetDimensionKeyDetailsRequest withGroupIdentifier(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.sql.id for dimension group db.sql (Aurora and RDS only)
    - db.query.id for dimension group db.query (DocumentDB only)
    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.sql.id for dimension group db.sql (Aurora and RDS only)
    
    db.query.id for dimension group db.query (DocumentDB only)
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getRequestedDimensions
```
public List<String> getRequestedDimensions()
```
    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.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:
    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.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).
  - setRequestedDimensions
```
public void setRequestedDimensions(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.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.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).
  - withRequestedDimensions
```
public GetDimensionKeyDetailsRequest withRequestedDimensions(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.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).
    NOTE: This method appends the values to the existing list (if any). Use setRequestedDimensions(java.util.Collection) or withRequestedDimensions(java.util.Collection) if you want to override the existing values.
    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.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.
  - withRequestedDimensions
```
public GetDimensionKeyDetailsRequest withRequestedDimensions(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.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.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.
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetDimensionKeyDetailsRequest clone()
```
    Description copied from class: AmazonWebServiceRequest
    
    Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.
    
    Overrides:
    
    clone in class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Skip navigation links

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

AWS SDK for Java 1.x API Reference - 1.12.793

Class GetDimensionKeyDetailsRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

GetDimensionKeyDetailsRequest

Method Detail

setServiceType

getServiceType

withServiceType

withServiceType

setIdentifier

getIdentifier

withIdentifier

setGroup

getGroup

withGroup

setGroupIdentifier

getGroupIdentifier

withGroupIdentifier

getRequestedDimensions

setRequestedDimensions

withRequestedDimensions

withRequestedDimensions

toString

equals

hashCode

clone