com.amazonaws.services.kinesis.metrics.impl

Class DimensionTrackingMetricsScope

java.lang.Object

com.amazonaws.services.kinesis.metrics.impl.DimensionTrackingMetricsScope

All Implemented Interfaces:

IMetricsScope

Direct Known Subclasses:

EndingMetricsScope

public abstract class DimensionTrackingMetricsScope
extends Object
implements IMetricsScope

DimensionTrackingMetricsScope is where we provide functionality for dimensions. Dimensions allow the user to be able view their metrics based off of the parameters they specify. The following examples show how to add dimensions if they would like to view their all metrics pertaining to a particular stream or for a specific date. myScope.addDimension("StreamName", "myStreamName"); myScope.addDimension("Date", "Dec012013");

Field Summary

Fields inherited from interface com.amazonaws.services.kinesis.metrics.interfaces.IMetricsScope

METRICS_DIMENSIONS_ALL

Constructor Summary

Constructors

Constructor and Description
DimensionTrackingMetricsScope()

Method Summary

Modifier and Type	Method and Description
void	addDimension(String name, String value) Adds a dimension that applies to all metrics in this IMetricsScope.
protected Set<com.amazonaws.services.cloudwatch.model.Dimension>	getDimensions()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.services.kinesis.metrics.interfaces.IMetricsScope

addData, addData, end

Constructor Detail

DimensionTrackingMetricsScope

public DimensionTrackingMetricsScope()

Method Detail

addDimension

public void addDimension(String name,
                         String value)

Description copied from interface: IMetricsScope

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

Specified by:

addDimension in interface IMetricsScope

Parameters:

name - dimension name

value - dimension value

getDimensions

protected Set<com.amazonaws.services.cloudwatch.model.Dimension> getDimensions()

Returns:

a set of dimensions for an IMetricsScope