software.amazon.awssdk.services.computeoptimizer.model

Class RecommendationSummary

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.RecommendationSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RecommendationSummary.Builder,RecommendationSummary>

@Generated(value="software.amazon.awssdk:codegen")
public final class RecommendationSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RecommendationSummary.Builder,RecommendationSummary>

A summary of a recommendation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RecommendationSummary.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Web Services account ID of the recommendation summary.
static RecommendationSummary.Builder	builder()
CurrentPerformanceRiskRatings	currentPerformanceRiskRatings() An object that describes the performance risk ratings for a given resource type.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInferredWorkloadSavings() For responses, this returns true if the service returned a value for the InferredWorkloadSavings property.
boolean	hasSummaries() For responses, this returns true if the service returned a value for the Summaries property.
List<InferredWorkloadSaving>	inferredWorkloadSavings() An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes.
RecommendationSourceType	recommendationResourceType() The resource type that the recommendation summary applies to.
String	recommendationResourceTypeAsString() The resource type that the recommendation summary applies to.
SavingsOpportunity	savingsOpportunity() An object that describes the savings opportunity for a given resource type.
List<SdkField<?>>	sdkFields()
static Class<? extends RecommendationSummary.Builder>	serializableBuilderClass()
List<Summary>	summaries() An array of objects that describe a recommendation summary.
RecommendationSummary.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

hasSummaries

public final boolean hasSummaries()

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

summaries

public final List<Summary> summaries()

An array of objects that describe a recommendation summary.

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

Returns:

An array of objects that describe a recommendation summary.

recommendationResourceType

public final RecommendationSourceType recommendationResourceType()

The resource type that the recommendation summary applies to.

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

Returns:

The resource type that the recommendation summary applies to.

See Also:

RecommendationSourceType

recommendationResourceTypeAsString

public final String recommendationResourceTypeAsString()

The resource type that the recommendation summary applies to.

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

Returns:

The resource type that the recommendation summary applies to.

See Also:

RecommendationSourceType

accountId

public final String accountId()

The Amazon Web Services account ID of the recommendation summary.

Returns:

The Amazon Web Services account ID of the recommendation summary.

savingsOpportunity

public final SavingsOpportunity savingsOpportunity()

An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

Returns:

An object that describes the savings opportunity for a given resource type. Savings opportunity includes the estimated monthly savings amount and percentage.

currentPerformanceRiskRatings

public final CurrentPerformanceRiskRatings currentPerformanceRiskRatings()

An object that describes the performance risk ratings for a given resource type.

Returns:

An object that describes the performance risk ratings for a given resource type.

hasInferredWorkloadSavings

public final boolean hasInferredWorkloadSavings()

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

inferredWorkloadSavings

public final List<InferredWorkloadSaving> inferredWorkloadSavings()

An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top three savings opportunites for the instances running inferred workload types.

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

Returns:

An array of objects that describes the estimated monthly saving amounts for the instances running on the specified inferredWorkloadTypes. The array contains the top three savings opportunites for the instances running inferred workload types.

toBuilder

public RecommendationSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecommendationSummary.Builder,RecommendationSummary>

builder

public static RecommendationSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo