MetricDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchrum.model.MetricDefinition

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricDefinition
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricDefinition()

Constructors
Constructor and Description
`MetricDefinition()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricDefinition`	`addDimensionKeysEntry(String key, String value)` Add a single DimensionKeys entry
`MetricDefinition`	`clearDimensionKeysEntries()` Removes all the entries added into DimensionKeys.
`MetricDefinition`	`clone()`
`boolean`	`equals(Object obj)`
`Map<String,String>`	`getDimensionKeys()` This field is a map of field paths to dimension names.
`String`	`getEventPattern()` The pattern that defines the metric.
`String`	`getMetricDefinitionId()` The ID of this metric definition.
`String`	`getName()` The name of the metric that is defined in this structure.
`String`	`getNamespace()` 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.
`String`	`getUnitLabel()` Use this field only if you are sending this metric to CloudWatch.
`String`	`getValueKey()` The field within the event object that the metric value is sourced from.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDimensionKeys(Map<String,String> dimensionKeys)` This field is a map of field paths to dimension names.
`void`	`setEventPattern(String eventPattern)` The pattern that defines the metric.
`void`	`setMetricDefinitionId(String metricDefinitionId)` The ID of this metric definition.
`void`	`setName(String name)` The name of the metric that is defined in this structure.
`void`	`setNamespace(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.
`void`	`setUnitLabel(String unitLabel)` Use this field only if you are sending this metric to CloudWatch.
`void`	`setValueKey(String valueKey)` The field within the event object that the metric value is sourced from.
`String`	`toString()` Returns a string representation of this object.
`MetricDefinition`	`withDimensionKeys(Map<String,String> dimensionKeys)` This field is a map of field paths to dimension names.
`MetricDefinition`	`withEventPattern(String eventPattern)` The pattern that defines the metric.
`MetricDefinition`	`withMetricDefinitionId(String metricDefinitionId)` The ID of this metric definition.
`MetricDefinition`	`withName(String name)` The name of the metric that is defined in this structure.
`MetricDefinition`	`withNamespace(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.
`MetricDefinition`	`withUnitLabel(String unitLabel)` Use this field only if you are sending this metric to CloudWatch.
`MetricDefinition`	`withValueKey(String valueKey)` The field within the event object that the metric value is sourced from.

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

- Constructor Detail
  - MetricDefinition
```
public MetricDefinition()
```
- Method Detail
  - getDimensionKeys
```
public Map<String,String> getDimensionKeys()
```
    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.
    
    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.
  - setDimensionKeys
```
public void setDimensionKeys(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.
    
    Parameters:
    
    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.
  - withDimensionKeys
```
public MetricDefinition withDimensionKeys(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDimensionKeysEntry
```
public MetricDefinition addDimensionKeysEntry(String key,
                                              String value)
```
    Add a single DimensionKeys entry
    
    See Also:
    
    withDimensionKeys(java.util.Map<java.lang.String, java.lang.String>)
  - clearDimensionKeysEntries
```
public MetricDefinition clearDimensionKeysEntries()
```
    Removes all the entries added into DimensionKeys.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventPattern
```
public void setEventPattern(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.
    
    Parameters:
    
    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.
  - getEventPattern
```
public String getEventPattern()
```
    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.
  - withEventPattern
```
public MetricDefinition withEventPattern(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricDefinitionId
```
public void setMetricDefinitionId(String metricDefinitionId)
```
    The ID of this metric definition.
    
    Parameters:
    
    metricDefinitionId - The ID of this metric definition.
  - getMetricDefinitionId
```
public String getMetricDefinitionId()
```
    The ID of this metric definition.
    
    Returns:
    
    The ID of this metric definition.
  - withMetricDefinitionId
```
public MetricDefinition withMetricDefinitionId(String metricDefinitionId)
```
    The ID of this metric definition.
    
    Parameters:
    
    metricDefinitionId - The ID of this metric definition.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setName
```
public void setName(String name)
```
    The name of the metric that is defined in this structure.
    
    Parameters:
    
    name - The name of the metric that is defined in this structure.
  - getName
```
public String getName()
```
    The name of the metric that is defined in this structure.
    
    Returns:
    
    The name of the metric that is defined in this structure.
  - withName
```
public MetricDefinition withName(String name)
```
    The name of the metric that is defined in this structure.
    
    Parameters:
    
    name - The name of the metric that is defined in this structure.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNamespace
```
public void setNamespace(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.
    
    Parameters:
    
    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.
  - getNamespace
```
public String getNamespace()
```
    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.
  - withNamespace
```
public MetricDefinition withNamespace(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnitLabel
```
public void setUnitLabel(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.
    
    Parameters:
    
    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.
  - getUnitLabel
```
public String getUnitLabel()
```
    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.
  - withUnitLabel
```
public MetricDefinition withUnitLabel(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueKey
```
public void setValueKey(String valueKey)
```
    The field within the event object that the metric value is sourced from.
    
    Parameters:
    
    valueKey - The field within the event object that the metric value is sourced from.
  - getValueKey
```
public String getValueKey()
```
    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.
  - withValueKey
```
public MetricDefinition withValueKey(String valueKey)
```
    The field within the event object that the metric value is sourced from.
    
    Parameters:
    
    valueKey - The field within the event object that the metric value is sourced from.
    
    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 MetricDefinition 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.

AWS SDK for Java 1.x API Reference - 1.12.773

Class MetricDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricDefinition

Method Detail

getDimensionKeys

setDimensionKeys

withDimensionKeys

addDimensionKeysEntry

clearDimensionKeysEntries

setEventPattern

getEventPattern

withEventPattern

setMetricDefinitionId

getMetricDefinitionId

withMetricDefinitionId

setName

getName

withName

setNamespace

getNamespace

withNamespace

setUnitLabel

getUnitLabel

withUnitLabel

setValueKey

getValueKey

withValueKey

toString

equals

hashCode

clone

marshall