MetricDefinition (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.rum.model.MetricDefinition

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MetricDefinition.Builder,MetricDefinition>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class MetricDefinition
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MetricDefinition.Builder,MetricDefinition>
```
A structure that displays the definition of one extended metric that RUM sends to CloudWatch or CloudWatch Evidently. For more information, see Additional metrics that you can send to CloudWatch and CloudWatch Evidently.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface MetricDefinition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`MetricDefinition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MetricDefinition.Builder`	`builder()`
`Map<String,String>`	`dimensionKeys()` This field is a map of field paths to dimension names.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`eventPattern()` The pattern that defines the metric.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasDimensionKeys()` For responses, this returns true if the service returned a value for the DimensionKeys property.
`int`	`hashCode()`
`String`	`metricDefinitionId()` The ID of this metric definition.
`String`	`name()` The name of the metric that is defined in this structure.
`String`	`namespace()` If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends MetricDefinition.Builder>`	`serializableBuilderClass()`
`MetricDefinition.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`unitLabel()` Use this field only if you are sending this metric to CloudWatch.
`String`	`valueKey()` The field within the event object that the metric value is sourced from.

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
  - hasDimensionKeys
```
public final boolean hasDimensionKeys()
```
    For responses, this returns true if the service returned a value for the DimensionKeys 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.
  - dimensionKeys
```
public final Map<String,String> dimensionKeys()
```
    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
    
    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 hasDimensionKeys() method.
    
    Returns:
    
    This field is a map of field paths to dimension names. It defines the dimensions to associate with this metric in CloudWatch The value of this field is used only if the metric destination is CloudWatch. If the metric destination is Evidently, the value of DimensionKeys is ignored.
  - eventPattern
```
public final String eventPattern()
```
    The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
    
    If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
    
    Returns:
    
    The pattern that defines the metric. RUM checks events that happen in a user's session against the pattern, and events that match the pattern are sent to the metric destination.
    
    If the metrics destination is CloudWatch and the event also matches a value in DimensionKeys, then the metric is published with the specified dimensions.
  - metricDefinitionId
```
public final String metricDefinitionId()
```
    The ID of this metric definition.
    
    Returns:
    
    The ID of this metric definition.
  - name
```
public final String name()
```
    The name of the metric that is defined in this structure.
    
    Returns:
    
    The name of the metric that is defined in this structure.
  - namespace
```
public final String namespace()
```
    If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
    
    Returns:
    
    If this metric definition is for a custom metric instead of an extended metric, this field displays the metric namespace that the custom metric is published to.
  - unitLabel
```
public final String unitLabel()
```
    Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
    
    Returns:
    
    Use this field only if you are sending this metric to CloudWatch. It defines the CloudWatch metric unit that this metric is measured in.
  - valueKey
```
public final String valueKey()
```
    The field within the event object that the metric value is sourced from.
    
    Returns:
    
    The field within the event object that the metric value is sourced from.
  - toBuilder
```
public MetricDefinition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<MetricDefinition.Builder,MetricDefinition>
  - builder
```
public static MetricDefinition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends MetricDefinition.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class MetricDefinition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasDimensionKeys

dimensionKeys

eventPattern

metricDefinitionId

name

namespace

unitLabel

valueKey

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields