software.amazon.awssdk.services.pi.model

Class ListAvailableResourceMetricsRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAvailableResourceMetricsRequest.Builder,ListAvailableResourceMetricsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAvailableResourceMetricsRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListAvailableResourceMetricsRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricTypes() For responses, this returns true if the service returned a value for the MetricTypes property.
String	identifier() An immutable identifier for a data source that is unique within an Amazon Web Services Region.
Integer	maxResults() The maximum number of items to return.
List<String>	metricTypes() The types of metrics to return in the response.
String	nextToken() An optional pagination token provided by a previous request.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAvailableResourceMetricsRequest.Builder>	serializableBuilderClass()
ServiceType	serviceType() The Amazon Web Services service for which Performance Insights returns metrics.
String	serviceTypeAsString() The Amazon Web Services service for which Performance Insights returns metrics.
ListAvailableResourceMetricsRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

overrideConfiguration

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

serviceType

public final ServiceType serviceType()

The Amazon Web Services service for which Performance Insights returns metrics.

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 Amazon Web Services service for which Performance Insights returns metrics.

See Also:

ServiceType

serviceTypeAsString

public final String serviceTypeAsString()

The Amazon Web Services service for which Performance Insights returns metrics.

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 Amazon Web Services service for which Performance Insights returns metrics.

See Also:

ServiceType

identifier

public final String identifier()

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

Returns:

An immutable identifier for a data source that is unique within an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use an Amazon RDS DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VWZ.

hasMetricTypes

public final boolean hasMetricTypes()

For responses, this returns true if the service returned a value for the MetricTypes 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.

metricTypes

public final List<String> metricTypes()

The types of metrics to return in the response. Valid values in the array include the following:

• os (OS counter metrics) - All engines

• db (DB load metrics) - All engines except for Amazon DocumentDB

• db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB

• db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

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 hasMetricTypes() method.

Returns:

The types of metrics to return in the response. Valid values in the array include the following:

• os (OS counter metrics) - All engines

• db (DB load metrics) - All engines except for Amazon DocumentDB

• db.sql.stats (per-SQL metrics) - All engines except for Amazon DocumentDB

• db.sql_tokenized.stats (per-SQL digest metrics) - All engines except for Amazon DocumentDB

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.

maxResults

public final Integer maxResults()

The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

Returns:

The maximum number of items to return. If the MaxRecords value is less than the number of existing items, the response includes a pagination token.

toBuilder

public ListAvailableResourceMetricsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAvailableResourceMetricsRequest.Builder,ListAvailableResourceMetricsRequest>

Specified by:

toBuilder in class PiRequest

builder

public static ListAvailableResourceMetricsRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo