Package software.amazon.awssdk.services.computeoptimizer.model

Class Summary

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.Summary

All Implemented Interfaces:

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

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

The summary of a recommendation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Summary.Builder

Method Summary

Modifier and Type	Method	Description
static Summary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasReasonCodeSummaries()	For responses, this returns true if the service returned a value for the ReasonCodeSummaries property.
Finding	name()	The finding classification of the recommendation.
String	nameAsString()	The finding classification of the recommendation.
List<ReasonCodeSummary>	reasonCodeSummaries()	An array of objects that summarize a finding reason code.
List<SdkField<?>>	sdkFields()
static Class<? extends Summary.Builder>	serializableBuilderClass()
Summary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Double	value()	The value of the recommendation summary.

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

name

public final Finding name()

The finding classification of the recommendation.

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

Returns:

The finding classification of the recommendation.

See Also:

Finding

nameAsString

public final String nameAsString()

The finding classification of the recommendation.

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

Returns:

The finding classification of the recommendation.

See Also:

Finding

value

public final Double value()

The value of the recommendation summary.

Returns:

The value of the recommendation summary.

hasReasonCodeSummaries

public final boolean hasReasonCodeSummaries()

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

reasonCodeSummaries

public final List<ReasonCodeSummary> reasonCodeSummaries()

An array of objects that summarize a finding reason code.

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

Returns:

An array of objects that summarize a finding reason code.

toBuilder

public Summary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Summary.Builder,Summary>

builder

public static Summary.Builder builder()

serializableBuilderClass

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