VolumeRecommendation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.computeoptimizer.model.VolumeRecommendation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class VolumeRecommendation
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Describes an Amazon Elastic Block Store (Amazon EBS) volume recommendation.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VolumeRecommendation()

Constructors
Constructor and Description
`VolumeRecommendation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`VolumeRecommendation`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getAccountId()` The Amazon Web Services account ID of the volume.
`VolumeConfiguration`	`getCurrentConfiguration()` An array of objects that describe the current configuration of the volume.
`String`	`getCurrentPerformanceRisk()` The risk of the current EBS volume not meeting the performance needs of its workloads.
`String`	`getFinding()` The finding classification of the volume.
`Date`	`getLastRefreshTimestamp()` The timestamp of when the volume recommendation was last generated.
`Double`	`getLookBackPeriodInDays()` The number of days for which utilization metrics were analyzed for the volume.
`List<EBSUtilizationMetric>`	`getUtilizationMetrics()` An array of objects that describe the utilization metrics of the volume.
`String`	`getVolumeArn()` The Amazon Resource Name (ARN) of the current volume.
`List<VolumeRecommendationOption>`	`getVolumeRecommendationOptions()` An array of objects that describe the recommendation options for the volume.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccountId(String accountId)` The Amazon Web Services account ID of the volume.
`void`	`setCurrentConfiguration(VolumeConfiguration currentConfiguration)` An array of objects that describe the current configuration of the volume.
`void`	`setCurrentPerformanceRisk(String currentPerformanceRisk)` The risk of the current EBS volume not meeting the performance needs of its workloads.
`void`	`setFinding(String finding)` The finding classification of the volume.
`void`	`setLastRefreshTimestamp(Date lastRefreshTimestamp)` The timestamp of when the volume recommendation was last generated.
`void`	`setLookBackPeriodInDays(Double lookBackPeriodInDays)` The number of days for which utilization metrics were analyzed for the volume.
`void`	`setUtilizationMetrics(Collection<EBSUtilizationMetric> utilizationMetrics)` An array of objects that describe the utilization metrics of the volume.
`void`	`setVolumeArn(String volumeArn)` The Amazon Resource Name (ARN) of the current volume.
`void`	`setVolumeRecommendationOptions(Collection<VolumeRecommendationOption> volumeRecommendationOptions)` An array of objects that describe the recommendation options for the volume.
`String`	`toString()` Returns a string representation of this object.
`VolumeRecommendation`	`withAccountId(String accountId)` The Amazon Web Services account ID of the volume.
`VolumeRecommendation`	`withCurrentConfiguration(VolumeConfiguration currentConfiguration)` An array of objects that describe the current configuration of the volume.
`VolumeRecommendation`	`withCurrentPerformanceRisk(CurrentPerformanceRisk currentPerformanceRisk)` The risk of the current EBS volume not meeting the performance needs of its workloads.
`VolumeRecommendation`	`withCurrentPerformanceRisk(String currentPerformanceRisk)` The risk of the current EBS volume not meeting the performance needs of its workloads.
`VolumeRecommendation`	`withFinding(EBSFinding finding)` The finding classification of the volume.
`VolumeRecommendation`	`withFinding(String finding)` The finding classification of the volume.
`VolumeRecommendation`	`withLastRefreshTimestamp(Date lastRefreshTimestamp)` The timestamp of when the volume recommendation was last generated.
`VolumeRecommendation`	`withLookBackPeriodInDays(Double lookBackPeriodInDays)` The number of days for which utilization metrics were analyzed for the volume.
`VolumeRecommendation`	`withUtilizationMetrics(Collection<EBSUtilizationMetric> utilizationMetrics)` An array of objects that describe the utilization metrics of the volume.
`VolumeRecommendation`	`withUtilizationMetrics(EBSUtilizationMetric... utilizationMetrics)` An array of objects that describe the utilization metrics of the volume.
`VolumeRecommendation`	`withVolumeArn(String volumeArn)` The Amazon Resource Name (ARN) of the current volume.
`VolumeRecommendation`	`withVolumeRecommendationOptions(Collection<VolumeRecommendationOption> volumeRecommendationOptions)` An array of objects that describe the recommendation options for the volume.
`VolumeRecommendation`	`withVolumeRecommendationOptions(VolumeRecommendationOption... volumeRecommendationOptions)` An array of objects that describe the recommendation options for the volume.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VolumeRecommendation
```
public VolumeRecommendation()
```
- Method Detail
  - setVolumeArn
```
public void setVolumeArn(String volumeArn)
```
    The Amazon Resource Name (ARN) of the current volume.
    
    Parameters:
    
    volumeArn - The Amazon Resource Name (ARN) of the current volume.
  - getVolumeArn
```
public String getVolumeArn()
```
    The Amazon Resource Name (ARN) of the current volume.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the current volume.
  - withVolumeArn
```
public VolumeRecommendation withVolumeArn(String volumeArn)
```
    The Amazon Resource Name (ARN) of the current volume.
    
    Parameters:
    
    volumeArn - The Amazon Resource Name (ARN) of the current volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccountId
```
public void setAccountId(String accountId)
```
    The Amazon Web Services account ID of the volume.
    
    Parameters:
    
    accountId - The Amazon Web Services account ID of the volume.
  - getAccountId
```
public String getAccountId()
```
    The Amazon Web Services account ID of the volume.
    
    Returns:
    
    The Amazon Web Services account ID of the volume.
  - withAccountId
```
public VolumeRecommendation withAccountId(String accountId)
```
    The Amazon Web Services account ID of the volume.
    
    Parameters:
    
    accountId - The Amazon Web Services account ID of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentConfiguration
```
public void setCurrentConfiguration(VolumeConfiguration currentConfiguration)
```
    An array of objects that describe the current configuration of the volume.
    
    Parameters:
    
    currentConfiguration - An array of objects that describe the current configuration of the volume.
  - getCurrentConfiguration
```
public VolumeConfiguration getCurrentConfiguration()
```
    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.
  - withCurrentConfiguration
```
public VolumeRecommendation withCurrentConfiguration(VolumeConfiguration currentConfiguration)
```
    An array of objects that describe the current configuration of the volume.
    
    Parameters:
    
    currentConfiguration - An array of objects that describe the current configuration of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFinding
```
public void setFinding(String 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.
    Parameters:
    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.
    See Also:
    
    EBSFinding
  - getFinding
```
public String getFinding()
```
    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.
    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
  - withFinding
```
public VolumeRecommendation withFinding(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EBSFinding
  - withFinding
```
public VolumeRecommendation withFinding(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EBSFinding
  - getUtilizationMetrics
```
public List<EBSUtilizationMetric> getUtilizationMetrics()
```
    An array of objects that describe the utilization metrics of the volume.
    
    Returns:
    
    An array of objects that describe the utilization metrics of the volume.
  - setUtilizationMetrics
```
public void setUtilizationMetrics(Collection<EBSUtilizationMetric> utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the volume.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the volume.
  - withUtilizationMetrics
```
public VolumeRecommendation withUtilizationMetrics(EBSUtilizationMetric... utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the volume.
    
    NOTE: This method appends the values to the existing list (if any). Use setUtilizationMetrics(java.util.Collection) or withUtilizationMetrics(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withUtilizationMetrics
```
public VolumeRecommendation withUtilizationMetrics(Collection<EBSUtilizationMetric> utilizationMetrics)
```
    An array of objects that describe the utilization metrics of the volume.
    
    Parameters:
    
    utilizationMetrics - An array of objects that describe the utilization metrics of the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLookBackPeriodInDays
```
public void setLookBackPeriodInDays(Double lookBackPeriodInDays)
```
    The number of days for which utilization metrics were analyzed for the volume.
    
    Parameters:
    
    lookBackPeriodInDays - The number of days for which utilization metrics were analyzed for the volume.
  - getLookBackPeriodInDays
```
public Double getLookBackPeriodInDays()
```
    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.
  - withLookBackPeriodInDays
```
public VolumeRecommendation withLookBackPeriodInDays(Double lookBackPeriodInDays)
```
    The number of days for which utilization metrics were analyzed for the volume.
    
    Parameters:
    
    lookBackPeriodInDays - The number of days for which utilization metrics were analyzed for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getVolumeRecommendationOptions
```
public List<VolumeRecommendationOption> getVolumeRecommendationOptions()
```
    An array of objects that describe the recommendation options for the volume.
    
    Returns:
    
    An array of objects that describe the recommendation options for the volume.
  - setVolumeRecommendationOptions
```
public void setVolumeRecommendationOptions(Collection<VolumeRecommendationOption> volumeRecommendationOptions)
```
    An array of objects that describe the recommendation options for the volume.
    
    Parameters:
    
    volumeRecommendationOptions - An array of objects that describe the recommendation options for the volume.
  - withVolumeRecommendationOptions
```
public VolumeRecommendation withVolumeRecommendationOptions(VolumeRecommendationOption... volumeRecommendationOptions)
```
    An array of objects that describe the recommendation options for the volume.
    
    NOTE: This method appends the values to the existing list (if any). Use setVolumeRecommendationOptions(java.util.Collection) or withVolumeRecommendationOptions(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    volumeRecommendationOptions - An array of objects that describe the recommendation options for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withVolumeRecommendationOptions
```
public VolumeRecommendation withVolumeRecommendationOptions(Collection<VolumeRecommendationOption> volumeRecommendationOptions)
```
    An array of objects that describe the recommendation options for the volume.
    
    Parameters:
    
    volumeRecommendationOptions - An array of objects that describe the recommendation options for the volume.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastRefreshTimestamp
```
public void setLastRefreshTimestamp(Date lastRefreshTimestamp)
```
    The timestamp of when the volume recommendation was last generated.
    
    Parameters:
    
    lastRefreshTimestamp - The timestamp of when the volume recommendation was last generated.
  - getLastRefreshTimestamp
```
public Date getLastRefreshTimestamp()
```
    The timestamp of when the volume recommendation was last generated.
    
    Returns:
    
    The timestamp of when the volume recommendation was last generated.
  - withLastRefreshTimestamp
```
public VolumeRecommendation withLastRefreshTimestamp(Date lastRefreshTimestamp)
```
    The timestamp of when the volume recommendation was last generated.
    
    Parameters:
    
    lastRefreshTimestamp - The timestamp of when the volume recommendation was last generated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCurrentPerformanceRisk
```
public void setCurrentPerformanceRisk(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    CurrentPerformanceRisk
  - getCurrentPerformanceRisk
```
public String getCurrentPerformanceRisk()
```
    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.
    
    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
  - withCurrentPerformanceRisk
```
public VolumeRecommendation withCurrentPerformanceRisk(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrentPerformanceRisk
  - withCurrentPerformanceRisk
```
public VolumeRecommendation withCurrentPerformanceRisk(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CurrentPerformanceRisk
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public VolumeRecommendation clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class VolumeRecommendation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VolumeRecommendation

Method Detail

setVolumeArn

getVolumeArn

withVolumeArn

setAccountId

getAccountId

withAccountId

setCurrentConfiguration

getCurrentConfiguration

withCurrentConfiguration

setFinding

getFinding

withFinding

withFinding

getUtilizationMetrics

setUtilizationMetrics

withUtilizationMetrics

withUtilizationMetrics

setLookBackPeriodInDays

getLookBackPeriodInDays

withLookBackPeriodInDays

getVolumeRecommendationOptions

setVolumeRecommendationOptions

withVolumeRecommendationOptions

withVolumeRecommendationOptions

setLastRefreshTimestamp

getLastRefreshTimestamp

withLastRefreshTimestamp

setCurrentPerformanceRisk

getCurrentPerformanceRisk

withCurrentPerformanceRisk

withCurrentPerformanceRisk

toString

equals

hashCode

clone

marshall