Class EBSUtilizationMetric

java.lang.Object
software.amazon.awssdk.services.computeoptimizer.model.EBSUtilizationMetric
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<EBSUtilizationMetric.Builder,EBSUtilizationMetric>
@Generated("software.amazon.awssdk:codegen") public final class EBSUtilizationMetric extends Object implements SdkPojo, Serializable, ToCopyableBuilder<EBSUtilizationMetric.Builder,EBSUtilizationMetric>

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:

  • Method Details

    • name

      public final 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

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

      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:

    • nameAsString

      public final String nameAsString()

      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

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

      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:

    • statistic

      public final MetricStatistic statistic()

      The statistic of the utilization metric.

      The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

      The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

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

      Returns:
      The statistic of the utilization metric.

      The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

      The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

      See Also:

    • statisticAsString

      public final String statisticAsString()

      The statistic of the utilization metric.

      The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

      The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

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

      Returns:
      The statistic of the utilization metric.

      The Compute Optimizer API, Command Line Interface (CLI), and SDKs return utilization metrics using only the Maximum statistic, which is the highest value observed during the specified period.

      The Compute Optimizer console displays graphs for some utilization metrics using the Average statistic, which is the value of Sum / SampleCount during the specified period. For more information, see Viewing resource recommendations in the Compute Optimizer User Guide. You can also get averaged utilization metric data for your resources using Amazon CloudWatch. For more information, see the Amazon CloudWatch User Guide.

      See Also:

    • value

      public final Double value()

      The value of the utilization metric.

      Returns:
      The value of the utilization metric.

    • toBuilder

      public EBSUtilizationMetric.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<EBSUtilizationMetric.Builder,EBSUtilizationMetric>
      Returns:
      a builder for type T

    • builder

      public static EBSUtilizationMetric.Builder builder()

    • serializableBuilderClass

      public static Class<? extends EBSUtilizationMetric.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.