Class Metric
- java.lang.Object
-
- software.amazon.awssdk.services.autoscaling.model.Metric
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Metric.Builder,Metric>
@Generated("software.amazon.awssdk:codegen") public final class Metric extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Metric.Builder,Metric>
Represents a specific metric.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
Metric.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Metric.Builder
builder()
List<MetricDimension>
dimensions()
The dimensions for the metric.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property.int
hashCode()
String
metricName()
The name of the metric.String
namespace()
The namespace of the metric.List<SdkField<?>>
sdkFields()
static Class<? extends Metric.Builder>
serializableBuilderClass()
Metric.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
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
-
namespace
public final String namespace()
The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
- Returns:
- The namespace of the metric. For more information, see the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
-
metricName
public final String metricName()
The name of the metric.
- Returns:
- The name of the metric.
-
hasDimensions
public final boolean hasDimensions()
For responses, this returns true if the service returned a value for the Dimensions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
dimensions
public final List<MetricDimension> dimensions()
The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
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
hasDimensions()
method.- Returns:
- The dimensions for the metric. For the list of available dimensions, see the Amazon Web Services
documentation available from the table in Amazon Web Services services that publish CloudWatch metrics in the Amazon CloudWatch User
Guide.
Conditional: If you published your metric with dimensions, you must specify the same dimensions in your scaling policy.
-
toBuilder
public Metric.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<Metric.Builder,Metric>
-
builder
public static Metric.Builder builder()
-
serializableBuilderClass
public static Class<? extends Metric.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-