Package org.apache.flink.runtime.rest.messages.job.metrics

Class MetricCollectionResponseBody

java.lang.Object

org.apache.flink.runtime.rest.messages.job.metrics.MetricCollectionResponseBody

All Implemented Interfaces:

ResponseBody

public final class MetricCollectionResponseBody
extends Object
implements ResponseBody

Response type for a collection of metrics.

As JSON this type will be represented as an array of metrics, i.e., the field metrics will not show up. For example, a collection with a single metric will be represented as follows:

 [{"id": "metricName", "value": "1"}]
 

See Also:

MetricCollectionResponseBody.Serializer, MetricCollectionResponseBody.Deserializer, MetricStore

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MetricCollectionResponseBody.Deserializer	JSON deserializer for MetricCollectionResponseBody.
static class	MetricCollectionResponseBody.Serializer	JSON serializer for MetricCollectionResponseBody.

Constructor Summary

Constructors

Constructor	Description
MetricCollectionResponseBody(Collection<Metric> metrics)

Method Summary

Modifier and Type	Method	Description
Collection<Metric>	getMetrics()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricCollectionResponseBody

public MetricCollectionResponseBody(Collection<Metric> metrics)

Method Detail

getMetrics

public Collection<Metric> getMetrics()