Package software.amazon.awssdk.services.costoptimizationhub.model

Class ListRecommendationSummariesRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.costoptimizationhub.model.CostOptimizationHubRequest

software.amazon.awssdk.services.costoptimizationhub.model.ListRecommendationSummariesRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListRecommendationSummariesRequest.Builder,ListRecommendationSummariesRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListRecommendationSummariesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static ListRecommendationSummariesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Filter	filter()	Returns the value of the Filter property for this object.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
String	groupBy()	The grouping of recommendations by a dimension.
int	hashCode()
boolean	hasMetrics()	For responses, this returns true if the service returned a value for the Metrics property.
Integer	maxResults()	The maximum number of recommendations to be returned for the request.
List<SummaryMetrics>	metrics()	Additional metrics to be returned for the request.
List<String>	metricsAsStrings()	Additional metrics to be returned for the request.
String	nextToken()	The token to retrieve the next set of results.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListRecommendationSummariesRequest.Builder>	serializableBuilderClass()
ListRecommendationSummariesRequest.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

filter

public final Filter filter()

Returns the value of the Filter property for this object.

Returns:

The value of the Filter property for this object.

groupBy

public final String groupBy()

The grouping of recommendations by a dimension.

Returns:

The grouping of recommendations by a dimension.

maxResults

public final Integer maxResults()

The maximum number of recommendations to be returned for the request.

Returns:

The maximum number of recommendations to be returned for the request.

metrics

public final List<SummaryMetrics> metrics()

Additional metrics to be returned for the request. The only valid value is savingsPercentage.

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

Returns:

Additional metrics to be returned for the request. The only valid value is savingsPercentage .

hasMetrics

public final boolean hasMetrics()

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

metricsAsStrings

public final List<String> metricsAsStrings()

Additional metrics to be returned for the request. The only valid value is savingsPercentage.

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

Returns:

Additional metrics to be returned for the request. The only valid value is savingsPercentage .

nextToken

public final String nextToken()

The token to retrieve the next set of results.

Returns:

The token to retrieve the next set of results.

toBuilder

public ListRecommendationSummariesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListRecommendationSummariesRequest.Builder,ListRecommendationSummariesRequest>

Specified by:

toBuilder in class CostOptimizationHubRequest

builder

public static ListRecommendationSummariesRequest.Builder builder()

serializableBuilderClass

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