software.amazon.awssdk.services.pi.model

Class GetResourceMetricsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.pi.model.PiRequest

software.amazon.awssdk.services.pi.model.GetResourceMetricsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetResourceMetricsRequest
extends PiRequest
implements ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetResourceMetricsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static GetResourceMetricsRequest.Builder	builder()
Instant	endTime() The date and time specifiying the end of the requested time series data.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	identifier() An immutable, AWS Region-unique identifier for a data source.
Integer	maxResults() The maximum number of items to return in the response.
List<MetricQuery>	metricQueries() An array of one or more queries to perform.
String	nextToken() An optional pagination token provided by a previous request.
Integer	periodInSeconds() The granularity, in seconds, of the data points returned from Performance Insights.
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourceMetricsRequest.Builder>	serializableBuilderClass()
ServiceType	serviceType() The AWS service for which Performance Insights will return metrics.
String	serviceTypeAsString() The AWS service for which Performance Insights will return metrics.
Instant	startTime() The date and time specifying the beginning of the requested time series data.
GetResourceMetricsRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

serviceType

public ServiceType serviceType()

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

See Also:

ServiceType

serviceTypeAsString

public String serviceTypeAsString()

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

If the service returns an enum value that is not available in the current SDK version, serviceType will return ServiceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from serviceTypeAsString().

Returns:

The AWS service for which Performance Insights will return metrics. The only valid value for ServiceType is: RDS

See Also:

ServiceType

identifier

public String identifier()

An immutable, AWS 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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

Returns:

An immutable, AWS 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: db-FAIHNTYBKTGAUSUZQYPDS2GW4A

metricQueries

public List<MetricQuery> metricQueries()

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

Returns:

An array of one or more queries to perform. Each query must specify a Performance Insights metric, and can optionally specify aggregation and filtering criteria.

startTime

public Instant startTime()

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

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

Returns:

The date and time specifying the beginning of the requested time series data. You can't specify a StartTime that's earlier than 7 days ago. The value specified is inclusive - data points equal to or greater than StartTime will be returned.

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

endTime

public Instant endTime()

The date and time specifiying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

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

Returns:

The date and time specifiying the end of the requested time series data. The value specified is exclusive - data points less than (but not equal to) EndTime will be returned.

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

periodInSeconds

public 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 will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

Returns:

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 will choose a value for you, with a goal of returning roughly 100-200 data points in the response.

maxResults

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

Returns:

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.

nextToken

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

Returns:

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.

toBuilder

public GetResourceMetricsRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceMetricsRequest.Builder,GetResourceMetricsRequest>

Specified by:

toBuilder in class PiRequest

Returns:

a builder for type T

builder

public static GetResourceMetricsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends GetResourceMetricsRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.