Package software.amazon.awssdk.services.resiliencehub.model

Class ListMetricsRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.resiliencehub.model.ResiliencehubRequest

software.amazon.awssdk.services.resiliencehub.model.ListMetricsRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListMetricsRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListMetricsRequest.Builder	builder()
List<Condition>	conditions()	Indicates the list of all the conditions that were applied on the metrics.
String	dataSource()	Indicates the data source of the metrics.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
List<Field>	fields()	Indicates the list of fields in the data source.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasConditions()	For responses, this returns true if the service returned a value for the Conditions property.
boolean	hasFields()	For responses, this returns true if the service returned a value for the Fields property.
int	hashCode()
boolean	hasSorts()	For responses, this returns true if the service returned a value for the Sorts property.
Integer	maxResults()	Maximum number of results to include in the response.
String	nextToken()	Null, or the token from a previous call to get the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListMetricsRequest.Builder>	serializableBuilderClass()
List<Sort>	sorts()	(Optional) Indicates the order in which you want to sort the fields in the metrics.
ListMetricsRequest.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

hasConditions

public final boolean hasConditions()

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

conditions

public final List<Condition> conditions()

Indicates the list of all the conditions that were applied on the metrics.

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

Returns:

Indicates the list of all the conditions that were applied on the metrics.

dataSource

public final String dataSource()

Indicates the data source of the metrics.

Returns:

Indicates the data source of the metrics.

hasFields

public final boolean hasFields()

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

fields

public final List<Field> fields()

Indicates the list of fields in the data source.

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

Returns:

Indicates the list of fields in the data source.

maxResults

public final Integer maxResults()

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

Returns:

Maximum number of results to include in the response. If more results exist than the specified MaxResults value, a token is included in the response so that the remaining results can be retrieved.

nextToken

public final String nextToken()

Null, or the token from a previous call to get the next set of results.

Returns:

Null, or the token from a previous call to get the next set of results.

hasSorts

public final boolean hasSorts()

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

sorts

public final List<Sort> sorts()

(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.

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

Returns:

(Optional) Indicates the order in which you want to sort the fields in the metrics. By default, the fields are sorted in the ascending order.

toBuilder

public ListMetricsRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListMetricsRequest.Builder,ListMetricsRequest>

Specified by:

toBuilder in class ResiliencehubRequest

builder

public static ListMetricsRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ListMetricsRequest.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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo