software.amazon.awssdk.services.computeoptimizer.model

Class VolumeRecommendation

java.lang.Object

software.amazon.awssdk.services.computeoptimizer.model.VolumeRecommendation

All Implemented Interfaces:

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

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

Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	VolumeRecommendation.Builder

Method Summary

Modifier and Type	Method and Description
String	accountId() The Amazon Web Services account ID of the volume.
static VolumeRecommendation.Builder	builder()
VolumeConfiguration	currentConfiguration() An array of objects that describe the current configuration of the volume.
CurrentPerformanceRisk	currentPerformanceRisk() The risk of the current EBS volume not meeting the performance needs of its workloads.
String	currentPerformanceRiskAsString() The risk of the current EBS volume not meeting the performance needs of its workloads.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
EBSFinding	finding() The finding classification of the volume.
String	findingAsString() The finding classification of the volume.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasUtilizationMetrics() For responses, this returns true if the service returned a value for the UtilizationMetrics property.
boolean	hasVolumeRecommendationOptions() For responses, this returns true if the service returned a value for the VolumeRecommendationOptions property.
Instant	lastRefreshTimestamp() The timestamp of when the volume recommendation was last generated.
Double	lookBackPeriodInDays() The number of days for which utilization metrics were analyzed for the volume.
List<SdkField<?>>	sdkFields()
static Class<? extends VolumeRecommendation.Builder>	serializableBuilderClass()
List<Tag>	tags() A list of tags assigned to your Amazon EBS volume recommendations.
VolumeRecommendation.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<EBSUtilizationMetric>	utilizationMetrics() An array of objects that describe the utilization metrics of the volume.
String	volumeArn() The Amazon Resource Name (ARN) of the current volume.
List<VolumeRecommendationOption>	volumeRecommendationOptions() An array of objects that describe the recommendation options for the volume.

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

volumeArn

public final String volumeArn()

The Amazon Resource Name (ARN) of the current volume.

Returns:

The Amazon Resource Name (ARN) of the current volume.

accountId

public final String accountId()

The Amazon Web Services account ID of the volume.

Returns:

The Amazon Web Services account ID of the volume.

currentConfiguration

public final VolumeConfiguration currentConfiguration()

An array of objects that describe the current configuration of the volume.

Returns:

An array of objects that describe the current configuration of the volume.

finding

public final EBSFinding finding()

The finding classification of the volume.

Findings for volumes include:

• NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.

• Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.

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

Returns:

The finding classification of the volume.

Findings for volumes include:

• NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.

• Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.

See Also:

EBSFinding

findingAsString

public final String findingAsString()

The finding classification of the volume.

Findings for volumes include:

• NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.

• Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.

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

Returns:

The finding classification of the volume.

Findings for volumes include:

• NotOptimized —A volume is considered not optimized when Compute Optimizer identifies a recommendation that can provide better performance for your workload.

• Optimized —An volume is considered optimized when Compute Optimizer determines that the volume is correctly provisioned to run your workload based on the chosen volume type. For optimized resources, Compute Optimizer might recommend a new generation volume type.

See Also:

EBSFinding

hasUtilizationMetrics

public final boolean hasUtilizationMetrics()

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

utilizationMetrics

public final List<EBSUtilizationMetric> utilizationMetrics()

An array of objects that describe the utilization metrics of the volume.

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

Returns:

An array of objects that describe the utilization metrics of the volume.

lookBackPeriodInDays

public final Double lookBackPeriodInDays()

The number of days for which utilization metrics were analyzed for the volume.

Returns:

The number of days for which utilization metrics were analyzed for the volume.

hasVolumeRecommendationOptions

public final boolean hasVolumeRecommendationOptions()

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

volumeRecommendationOptions

public final List<VolumeRecommendationOption> volumeRecommendationOptions()

An array of objects that describe the recommendation options for the volume.

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

Returns:

An array of objects that describe the recommendation options for the volume.

lastRefreshTimestamp

public final Instant lastRefreshTimestamp()

The timestamp of when the volume recommendation was last generated.

Returns:

The timestamp of when the volume recommendation was last generated.

currentPerformanceRisk

public final CurrentPerformanceRisk currentPerformanceRisk()

The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.

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

Returns:

The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.

See Also:

CurrentPerformanceRisk

currentPerformanceRiskAsString

public final String currentPerformanceRiskAsString()

The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.

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

Returns:

The risk of the current EBS volume not meeting the performance needs of its workloads. The higher the risk, the more likely the current EBS volume doesn't have sufficient capacity.

See Also:

CurrentPerformanceRisk

hasTags

public final boolean hasTags()

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

tags

public final List<Tag> tags()

A list of tags assigned to your Amazon EBS volume recommendations.

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

Returns:

A list of tags assigned to your Amazon EBS volume recommendations.

toBuilder

public VolumeRecommendation.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<VolumeRecommendation.Builder,VolumeRecommendation>

builder

public static VolumeRecommendation.Builder builder()

serializableBuilderClass

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