Class ECSServiceProjectedMetric

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

Describes the projected metrics of an Amazon ECS service recommendation option.

To determine the performance difference between your current Amazon ECS service and the recommended option, compare the metric data of your service against its projected metric data.

See Also:

  • Method Details

    • name

      public final ECSServiceMetricName name()

      The name of the projected metric.

      The following metrics are available:

      • Cpu — The percentage of allocated compute units that are currently in use on the service tasks.

      • Memory — The percentage of memory that's currently in use on the service tasks.

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

      Returns:
      The name of the projected metric.

      The following metrics are available:

      • Cpu — The percentage of allocated compute units that are currently in use on the service tasks.

      • Memory — The percentage of memory that's currently in use on the service tasks.

      See Also:

    • nameAsString

      public final String nameAsString()

      The name of the projected metric.

      The following metrics are available:

      • Cpu — The percentage of allocated compute units that are currently in use on the service tasks.

      • Memory — The percentage of memory that's currently in use on the service tasks.

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

      Returns:
      The name of the projected metric.

      The following metrics are available:

      • Cpu — The percentage of allocated compute units that are currently in use on the service tasks.

      • Memory — The percentage of memory that's currently in use on the service tasks.

      See Also:

    • hasTimestamps

      public final boolean hasTimestamps()
      For responses, this returns true if the service returned a value for the Timestamps 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.

    • timestamps

      public final List<Instant> timestamps()

      The timestamps of the projected metric.

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

      Returns:
      The timestamps of the projected metric.

    • hasUpperBoundValues

      public final boolean hasUpperBoundValues()
      For responses, this returns true if the service returned a value for the UpperBoundValues 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.

    • upperBoundValues

      public final List<Double> upperBoundValues()

      The upper bound values for the projected metric.

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

      Returns:
      The upper bound values for the projected metric.

    • hasLowerBoundValues

      public final boolean hasLowerBoundValues()
      For responses, this returns true if the service returned a value for the LowerBoundValues 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.

    • lowerBoundValues

      public final List<Double> lowerBoundValues()

      The lower bound values for the projected metric.

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

      Returns:
      The lower bound values for the projected metric.

    • toBuilder

      public ECSServiceProjectedMetric.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<ECSServiceProjectedMetric.Builder,ECSServiceProjectedMetric>
      Returns:
      a builder for type T

    • builder

      public static ECSServiceProjectedMetric.Builder builder()

    • serializableBuilderClass

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