software.amazon.kinesis.metrics

Class EndingMetricsScope

java.lang.Object

software.amazon.kinesis.metrics.DimensionTrackingMetricsScope

software.amazon.kinesis.metrics.EndingMetricsScope

All Implemented Interfaces:

MetricsScope

Direct Known Subclasses:

AccumulatingMetricsScope

public abstract class EndingMetricsScope
extends DimensionTrackingMetricsScope

Field Summary

Fields inherited from interface software.amazon.kinesis.metrics.MetricsScope

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
EndingMetricsScope()

Method Summary

Modifier and Type	Method and Description
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit) Adds a data point to this IMetricsScope.
void	addData(String name, double value, software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit, MetricsLevel level) Adds a data point to this IMetricsScope if given metrics level is enabled.
void	addDimension(String name, String value) Adds a dimension that applies to all metrics in this IMetricsScope.
void	end() Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.

Methods inherited from class software.amazon.kinesis.metrics.DimensionTrackingMetricsScope

getDimensions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EndingMetricsScope

public EndingMetricsScope()

Method Detail

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit)

Description copied from interface: MetricsScope

Adds a data point to this IMetricsScope. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Parameters:

name - data point name

value - data point value

unit - unit of data point

addData

public void addData(String name,
                    double value,
                    software.amazon.awssdk.services.cloudwatch.model.StandardUnit unit,
                    MetricsLevel level)

Description copied from interface: MetricsScope

Adds a data point to this IMetricsScope if given metrics level is enabled. Multiple calls against the same IMetricsScope with the same name parameter will result in accumulation.

Parameters:

name - data point name

value - data point value

unit - unit of data point

level - metrics level of this data point

addDimension

public void addDimension(String name,
                         String value)

Description copied from interface: MetricsScope

Adds a dimension that applies to all metrics in this IMetricsScope.

Specified by:

addDimension in interface MetricsScope

Overrides:

addDimension in class DimensionTrackingMetricsScope

Parameters:

name - dimension name

value - dimension value

end

public void end()

Description copied from interface: MetricsScope

Flushes the data from this IMetricsScope and causes future calls to addData and addDimension to fail.