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

Class MetricsAggregationParameter

java.lang.Object

org.apache.flink.runtime.rest.messages.MessageParameter<List<X>>

org.apache.flink.runtime.rest.messages.MessageQueryParameter<MetricsAggregationParameter.AggregationMode>

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

public class MetricsAggregationParameter
extends MessageQueryParameter<MetricsAggregationParameter.AggregationMode>

TODO: add javadoc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	MetricsAggregationParameter.AggregationMode	The available aggregations.

Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.messages.MessageParameter

MessageParameter.MessageParameterRequisiteness

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetricsAggregationParameter()

Method Summary

Modifier and Type	Method	Description
MetricsAggregationParameter.AggregationMode	convertStringToValue(String value)	Converts the given string to a valid value of this parameter.
String	convertValueToString(MetricsAggregationParameter.AggregationMode value)	Converts the given value to its string representation.
String	getDescription()	Returns a description for REST API HTML documentation.

Methods inherited from class org.apache.flink.runtime.rest.messages.MessageQueryParameter

convertFromString, convertToString

Methods inherited from class org.apache.flink.runtime.rest.messages.MessageParameter

getKey, getValue, isMandatory, isResolved, resolve, resolveFromString

Methods inherited from class java.lang.Object

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

Constructor Details

MetricsAggregationParameter

protected MetricsAggregationParameter()

Method Details

convertStringToValue

public MetricsAggregationParameter.AggregationMode convertStringToValue(String value)
                                                                 throws ConversionException

Description copied from class: MessageQueryParameter

Converts the given string to a valid value of this parameter.

Specified by:

convertStringToValue in class MessageQueryParameter<MetricsAggregationParameter.AggregationMode>

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertValueToString

public String convertValueToString(MetricsAggregationParameter.AggregationMode value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<MetricsAggregationParameter.AggregationMode>

Parameters:

value - parameter value

Returns:

string representation of typed value

getDescription

public String getDescription()

Description copied from class: MessageParameter

Returns a description for REST API HTML documentation.

Specified by:

getDescription in class MessageParameter<List<MetricsAggregationParameter.AggregationMode>>

Returns:

escaped HTML string