MetricDefinition (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatchevidently.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
```
This structure defines a metric that is being used to evaluate the variations during a launch or experiment.

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`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getEntityIdKey()` The entity, such as a user or session, that does an action that causes a metric value to be recorded.
`String`	`getEventPattern()` The EventBridge event pattern that defines how the metric is recorded.
`String`	`getName()` The name of the metric.
`String`	`getUnitLabel()` The label for the units that the metric is measuring.
`String`	`getValueKey()` The value that is tracked to produce the metric.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setEntityIdKey(String entityIdKey)` The entity, such as a user or session, that does an action that causes a metric value to be recorded.
`void`	`setEventPattern(String eventPattern)` The EventBridge event pattern that defines how the metric is recorded.
`void`	`setName(String name)` The name of the metric.
`void`	`setUnitLabel(String unitLabel)` The label for the units that the metric is measuring.
`void`	`setValueKey(String valueKey)` The value that is tracked to produce the metric.
`String`	`toString()` Returns a string representation of this object.
`MetricDefinition`	`withEntityIdKey(String entityIdKey)` The entity, such as a user or session, that does an action that causes a metric value to be recorded.
`MetricDefinition`	`withEventPattern(String eventPattern)` The EventBridge event pattern that defines how the metric is recorded.
`MetricDefinition`	`withName(String name)` The name of the metric.
`MetricDefinition`	`withUnitLabel(String unitLabel)` The label for the units that the metric is measuring.
`MetricDefinition`	`withValueKey(String valueKey)` The value that is tracked to produce the metric.

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

- Constructor Detail
  - MetricDefinition
```
public MetricDefinition()
```
- Method Detail
  - setEntityIdKey
```
public void setEntityIdKey(String entityIdKey)
```
    The entity, such as a user or session, that does an action that causes a metric value to be recorded.
    
    Parameters:
    
    entityIdKey - The entity, such as a user or session, that does an action that causes a metric value to be recorded.
  - getEntityIdKey
```
public String getEntityIdKey()
```
    The entity, such as a user or session, that does an action that causes a metric value to be recorded.
    
    Returns:
    
    The entity, such as a user or session, that does an action that causes a metric value to be recorded.
  - withEntityIdKey
```
public MetricDefinition withEntityIdKey(String entityIdKey)
```
    The entity, such as a user or session, that does an action that causes a metric value to be recorded.
    
    Parameters:
    
    entityIdKey - The entity, such as a user or session, that does an action that causes a metric value to be recorded.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEventPattern
```
public void setEventPattern(String eventPattern)
```
    The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Parameters:
    
    eventPattern - The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
  - getEventPattern
```
public String getEventPattern()
```
    The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
    
    This field's value will be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    Returns:
    
    The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
  - withEventPattern
```
public MetricDefinition withEventPattern(String eventPattern)
```
    The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
    
    This field's value must be valid JSON according to RFC 7159, including the opening and closing braces. For example: '{"key": "value"}'.
    
    The AWS SDK for Java performs a Base64 encoding on this field before sending this request to the AWS service. Users of the SDK should not perform Base64 encoding on this field.
    
    Parameters:
    
    eventPattern - The EventBridge event pattern that defines how the metric is recorded.
    
    For more information about EventBridge event patterns, see Amazon EventBridge event patterns.
    
    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.
    
    Parameters:
    
    name - The name of the metric.
  - getName
```
public String getName()
```
    The name of the metric.
    
    Returns:
    
    The name of the metric.
  - withName
```
public MetricDefinition withName(String name)
```
    The name of the metric.
    
    Parameters:
    
    name - The name of the metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnitLabel
```
public void setUnitLabel(String unitLabel)
```
    The label for the units that the metric is measuring.
    
    Parameters:
    
    unitLabel - The label for the units that the metric is measuring.
  - getUnitLabel
```
public String getUnitLabel()
```
    The label for the units that the metric is measuring.
    
    Returns:
    
    The label for the units that the metric is measuring.
  - withUnitLabel
```
public MetricDefinition withUnitLabel(String unitLabel)
```
    The label for the units that the metric is measuring.
    
    Parameters:
    
    unitLabel - The label for the units that the metric is measuring.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueKey
```
public void setValueKey(String valueKey)
```
    The value that is tracked to produce the metric.
    
    Parameters:
    
    valueKey - The value that is tracked to produce the metric.
  - getValueKey
```
public String getValueKey()
```
    The value that is tracked to produce the metric.
    
    Returns:
    
    The value that is tracked to produce the metric.
  - withValueKey
```
public MetricDefinition withValueKey(String valueKey)
```
    The value that is tracked to produce the metric.
    
    Parameters:
    
    valueKey - The value that is tracked to produce the metric.
    
    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.772

Class MetricDefinition

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricDefinition

Method Detail

setEntityIdKey

getEntityIdKey

withEntityIdKey

setEventPattern

getEventPattern

withEventPattern

setName

getName

withName

setUnitLabel

getUnitLabel

withUnitLabel

setValueKey

getValueKey

withValueKey

toString

equals

hashCode

clone

marshall