MetricTransformation (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.logs.model.MetricTransformation

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricTransformation
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Indicates how to transform ingested log events to metric data in a CloudWatch metric.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricTransformation()

Constructors
Constructor and Description
`MetricTransformation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricTransformation`	`addDimensionsEntry(String key, String value)` Add a single Dimensions entry
`MetricTransformation`	`clearDimensionsEntries()` Removes all the entries added into Dimensions.
`MetricTransformation`	`clone()`
`boolean`	`equals(Object obj)`
`Double`	`getDefaultValue()` (Optional) The value to emit when a filter pattern does not match a log event.
`Map<String,String>`	`getDimensions()` The fields to use as dimensions for the metric.
`String`	`getMetricName()` The name of the CloudWatch metric.
`String`	`getMetricNamespace()` A custom namespace to contain your metric in CloudWatch.
`String`	`getMetricValue()` The value to publish to the CloudWatch metric when a filter pattern matches a log event.
`String`	`getUnit()` The unit to assign to the metric.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultValue(Double defaultValue)` (Optional) The value to emit when a filter pattern does not match a log event.
`void`	`setDimensions(Map<String,String> dimensions)` The fields to use as dimensions for the metric.
`void`	`setMetricName(String metricName)` The name of the CloudWatch metric.
`void`	`setMetricNamespace(String metricNamespace)` A custom namespace to contain your metric in CloudWatch.
`void`	`setMetricValue(String metricValue)` The value to publish to the CloudWatch metric when a filter pattern matches a log event.
`void`	`setUnit(String unit)` The unit to assign to the metric.
`String`	`toString()` Returns a string representation of this object.
`MetricTransformation`	`withDefaultValue(Double defaultValue)` (Optional) The value to emit when a filter pattern does not match a log event.
`MetricTransformation`	`withDimensions(Map<String,String> dimensions)` The fields to use as dimensions for the metric.
`MetricTransformation`	`withMetricName(String metricName)` The name of the CloudWatch metric.
`MetricTransformation`	`withMetricNamespace(String metricNamespace)` A custom namespace to contain your metric in CloudWatch.
`MetricTransformation`	`withMetricValue(String metricValue)` The value to publish to the CloudWatch metric when a filter pattern matches a log event.
`MetricTransformation`	`withUnit(StandardUnit unit)` The unit to assign to the metric.
`MetricTransformation`	`withUnit(String unit)` The unit to assign to the metric.

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

- Constructor Detail
  - MetricTransformation
```
public MetricTransformation()
```
- Method Detail
  - setMetricName
```
public void setMetricName(String metricName)
```
    The name of the CloudWatch metric.
    
    Parameters:
    
    metricName - The name of the CloudWatch metric.
  - getMetricName
```
public String getMetricName()
```
    The name of the CloudWatch metric.
    
    Returns:
    
    The name of the CloudWatch metric.
  - withMetricName
```
public MetricTransformation withMetricName(String metricName)
```
    The name of the CloudWatch metric.
    
    Parameters:
    
    metricName - The name of the CloudWatch metric.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricNamespace
```
public void setMetricNamespace(String metricNamespace)
```
    A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
    
    Parameters:
    
    metricNamespace - A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
  - getMetricNamespace
```
public String getMetricNamespace()
```
    A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
    
    Returns:
    
    A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
  - withMetricNamespace
```
public MetricTransformation withMetricNamespace(String metricNamespace)
```
    A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
    
    Parameters:
    
    metricNamespace - A custom namespace to contain your metric in CloudWatch. Use namespaces to group together metrics that are similar. For more information, see Namespaces.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricValue
```
public void setMetricValue(String metricValue)
```
    The value to publish to the CloudWatch metric when a filter pattern matches a log event.
    
    Parameters:
    
    metricValue - The value to publish to the CloudWatch metric when a filter pattern matches a log event.
  - getMetricValue
```
public String getMetricValue()
```
    The value to publish to the CloudWatch metric when a filter pattern matches a log event.
    
    Returns:
    
    The value to publish to the CloudWatch metric when a filter pattern matches a log event.
  - withMetricValue
```
public MetricTransformation withMetricValue(String metricValue)
```
    The value to publish to the CloudWatch metric when a filter pattern matches a log event.
    
    Parameters:
    
    metricValue - The value to publish to the CloudWatch metric when a filter pattern matches a log event.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultValue
```
public void setDefaultValue(Double defaultValue)
```
    (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
    
    Parameters:
    
    defaultValue - (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
  - getDefaultValue
```
public Double getDefaultValue()
```
    (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
    
    Returns:
    
    (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
  - withDefaultValue
```
public MetricTransformation withDefaultValue(Double defaultValue)
```
    (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
    
    Parameters:
    
    defaultValue - (Optional) The value to emit when a filter pattern does not match a log event. This value can be null.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getDimensions
```
public Map<String,String> getDimensions()
```
    The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
    
    Returns:
    
    The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
  - setDimensions
```
public void setDimensions(Map<String,String> dimensions)
```
    The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
    
    Parameters:
    
    dimensions - The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
  - withDimensions
```
public MetricTransformation withDimensions(Map<String,String> dimensions)
```
    The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
    
    Parameters:
    
    dimensions - The fields to use as dimensions for the metric. One metric filter can include as many as three dimensions.
    
    Metrics extracted from log events are charged as custom metrics. To prevent unexpected high charges, do not specify high-cardinality fields such as IPAddress or requestID as dimensions. Each different value found for a dimension is treated as a separate metric and accrues charges as a separate custom metric.
    
    To help prevent accidental high charges, Amazon disables a metric filter if it generates 1000 different name/value pairs for the dimensions that you have specified within a certain amount of time.
    
    You can also set up a billing alarm to alert you if your charges are higher than expected. For more information, see Creating a Billing Alarm to Monitor Your Estimated Amazon Web Services Charges.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addDimensionsEntry
```
public MetricTransformation addDimensionsEntry(String key,
                                               String value)
```
    Add a single Dimensions entry
    
    See Also:
    
    withDimensions(java.util.Map<java.lang.String, java.lang.String>)
  - clearDimensionsEntries
```
public MetricTransformation clearDimensionsEntries()
```
    Removes all the entries added into Dimensions.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUnit
```
public void setUnit(String unit)
```
    The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Parameters:
    
    unit - The unit to assign to the metric. If you omit this, the unit is set as None.
    
    See Also:
    
    StandardUnit
  - getUnit
```
public String getUnit()
```
    The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Returns:
    
    The unit to assign to the metric. If you omit this, the unit is set as None.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricTransformation withUnit(String unit)
```
    The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Parameters:
    
    unit - The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - withUnit
```
public MetricTransformation withUnit(StandardUnit unit)
```
    The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Parameters:
    
    unit - The unit to assign to the metric. If you omit this, the unit is set as None.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    StandardUnit
  - 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 MetricTransformation 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.

Did this page help you?

Class MetricTransformation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricTransformation

Method Detail

setMetricName

getMetricName

withMetricName

setMetricNamespace

getMetricNamespace

withMetricNamespace

setMetricValue

getMetricValue

withMetricValue

setDefaultValue

getDefaultValue

withDefaultValue

getDimensions

setDimensions

withDimensions

addDimensionsEntry

clearDimensionsEntries

setUnit

getUnit

withUnit

withUnit

toString

equals

hashCode

clone

marshall