EBSUtilizationMetric (AWS SDK for Java

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

All Implemented Interfaces:

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

Compare the utilization metric data of your resource against its projected utilization metric data to determine the performance difference between your current resource and the recommended option.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

EBSUtilizationMetric()

Constructors
Constructor and Description
`EBSUtilizationMetric()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`EBSUtilizationMetric`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getName()` The name of the utilization metric.
`String`	`getStatistic()` The statistic of the utilization metric.
`Double`	`getValue()` The value of the utilization metric.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setName(String name)` The name of the utilization metric.
`void`	`setStatistic(String statistic)` The statistic of the utilization metric.
`void`	`setValue(Double value)` The value of the utilization metric.
`String`	`toString()` Returns a string representation of this object.
`EBSUtilizationMetric`	`withName(EBSMetricName name)` The name of the utilization metric.
`EBSUtilizationMetric`	`withName(String name)` The name of the utilization metric.
`EBSUtilizationMetric`	`withStatistic(MetricStatistic statistic)` The statistic of the utilization metric.
`EBSUtilizationMetric`	`withStatistic(String statistic)` The statistic of the utilization metric.
`EBSUtilizationMetric`	`withValue(Double value)` The value of the utilization metric.

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

- Constructor Detail
  - EBSUtilizationMetric
```
public EBSUtilizationMetric()
```
- Method Detail
  - setName
```
public void setName(String name)
```
    The name of the utilization metric.
    
    The following utilization metrics are available:
    - VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
      
      Unit: Count
    - VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
      
      Unit: Count
    - VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
      
      Unit: Bytes
    - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
      
      Unit: Bytes
    Parameters:
    name - The name of the utilization metric.
    
    The following utilization metrics are available:
    
    VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
    
    Unit: Count
    
    VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
    
    Unit: Count
    
    VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
    
    Unit: Bytes
    
    VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
    
    Unit: Bytes
    See Also:
    
    EBSMetricName
  - getName
```
public String getName()
```
    The name of the utilization metric.
    
    The following utilization metrics are available:
    - VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
      
      Unit: Count
    - VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
      
      Unit: Count
    - VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
      
      Unit: Bytes
    - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
      
      Unit: Bytes
    Returns:
    The name of the utilization metric.
    
    The following utilization metrics are available:
    
    VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
    
    Unit: Count
    
    VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
    
    Unit: Count
    
    VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
    
    Unit: Bytes
    
    VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
    
    Unit: Bytes
    See Also:
    
    EBSMetricName
  - withName
```
public EBSUtilizationMetric withName(String name)
```
    The name of the utilization metric.
    
    The following utilization metrics are available:
    - VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
      
      Unit: Count
    - VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
      
      Unit: Count
    - VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
      
      Unit: Bytes
    - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
      
      Unit: Bytes
    Parameters:
    name - The name of the utilization metric.
    
    The following utilization metrics are available:
    
    VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
    
    Unit: Count
    
    VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
    
    Unit: Count
    
    VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
    
    Unit: Bytes
    
    VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
    
    Unit: Bytes
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EBSMetricName
  - withName
```
public EBSUtilizationMetric withName(EBSMetricName name)
```
    The name of the utilization metric.
    
    The following utilization metrics are available:
    - VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
      
      Unit: Count
    - VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
      
      Unit: Count
    - VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
      
      Unit: Bytes
    - VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
      
      Unit: Bytes
    Parameters:
    name - The name of the utilization metric.
    
    The following utilization metrics are available:
    
    VolumeReadOpsPerSecond - The completed read operations per second from the volume in a specified period of time.
    
    Unit: Count
    
    VolumeWriteOpsPerSecond - The completed write operations per second to the volume in a specified period of time.
    
    Unit: Count
    
    VolumeReadBytesPerSecond - The bytes read per second from the volume in a specified period of time.
    
    Unit: Bytes
    
    VolumeWriteBytesPerSecond - The bytes written to the volume in a specified period of time.
    
    Unit: Bytes
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    EBSMetricName
  - setStatistic
```
public void setStatistic(String statistic)
```
    The statistic of the utilization metric.
    
    The following statistics are available:
    - Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Parameters:
    statistic - The statistic of the utilization metric.
    
    The following statistics are available:
    
    Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    See Also:
    
    MetricStatistic
  - getStatistic
```
public String getStatistic()
```
    The statistic of the utilization metric.
    
    The following statistics are available:
    - Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Returns:
    The statistic of the utilization metric.
    
    The following statistics are available:
    
    Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    See Also:
    
    MetricStatistic
  - withStatistic
```
public EBSUtilizationMetric withStatistic(String statistic)
```
    The statistic of the utilization metric.
    
    The following statistics are available:
    - Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Parameters:
    statistic - The statistic of the utilization metric.
    
    The following statistics are available:
    
    Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - withStatistic
```
public EBSUtilizationMetric withStatistic(MetricStatistic statistic)
```
    The statistic of the utilization metric.
    
    The following statistics are available:
    - Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    - Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Parameters:
    statistic - The statistic of the utilization metric.
    
    The following statistics are available:
    
    Average - This is the value of Sum / SampleCount during the specified period, or the average value observed during the specified period.
    
    Maximum - The highest value observed during the specified period. Use this value to determine high volumes of activity for your application.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    MetricStatistic
  - setValue
```
public void setValue(Double value)
```
    The value of the utilization metric.
    
    Parameters:
    
    value - The value of the utilization metric.
  - getValue
```
public Double getValue()
```
    The value of the utilization metric.
    
    Returns:
    
    The value of the utilization metric.
  - withValue
```
public EBSUtilizationMetric withValue(Double value)
```
    The value of the utilization metric.
    
    Parameters:
    
    value - The value of the utilization metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 EBSUtilizationMetric 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 EBSUtilizationMetric

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EBSUtilizationMetric

Method Detail

setName

getName

withName

withName

setStatistic

getStatistic

withStatistic

withStatistic

setValue

getValue

withValue

toString

equals

hashCode

clone

marshall