Package software.amazon.awssdk.services.pi.model

Class GetResourceMetricsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.pi.model.PiResponse

software.amazon.awssdk.services.pi.model.GetResourceMetricsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetResourceMetricsResponse.Builder,GetResourceMetricsResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetResourceMetricsResponse
extends PiResponse
implements ToCopyableBuilder<GetResourceMetricsResponse.Builder,GetResourceMetricsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetResourceMetricsResponse.Builder

Method Summary

Modifier and Type	Method	Description
Instant	alignedEndTime()	The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds).
Instant	alignedStartTime()	The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds).
static GetResourceMetricsResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricList()	For responses, this returns true if the service returned a value for the MetricList property.
String	identifier()	An immutable identifier for a data source that is unique for an Amazon Web Services Region.
List<MetricKeyDataPoints>	metricList()	An array of metric results, where each array element contains all of the data points for a particular dimension.
String	nextToken()	An optional pagination token provided by a previous request.
List<SdkField<?>>	sdkFields()
static Class<? extends GetResourceMetricsResponse.Builder>	serializableBuilderClass()
GetResourceMetricsResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.pi.model.PiResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

alignedStartTime

public final Instant alignedStartTime()

The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

Returns:

The start time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedStartTime will be less than or equal to the value of the user-specified StartTime.

alignedEndTime

public final Instant alignedEndTime()

The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

Returns:

The end time for the returned metrics, after alignment to a granular boundary (as specified by PeriodInSeconds). AlignedEndTime will be greater than or equal to the value of the user-specified Endtime.

identifier

public final String identifier()

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

Returns:

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. In the console, the identifier is shown as ResourceID. When you call DescribeDBInstances, the identifier is returned as DbiResourceId.

hasMetricList

public final boolean hasMetricList()

For responses, this returns true if the service returned a value for the MetricList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

metricList

public final List<MetricKeyDataPoints> metricList()

An array of metric results, where each array element contains all of the data points for a particular dimension.

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

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetricList() method.

Returns:

An array of metric results, where each array element contains all of the data points for a particular dimension.

nextToken

public final 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 GetResourceMetricsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetResourceMetricsResponse.Builder,GetResourceMetricsResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetResourceMetricsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

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

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo