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

Class MetricsFilterParameter

java.lang.Object

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

org.apache.flink.runtime.rest.messages.MessageQueryParameter<String>

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

public class MetricsFilterParameter
extends MessageQueryParameter<String>

MessageQueryParameter for filtering metrics provided by MetricStore.

See Also:

• AbstractMetricsHandler

Nested Class Summary

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

MessageParameter.MessageParameterRequisiteness

Constructor Summary

Constructors

Constructor	Description
MetricsFilterParameter()

Method Summary

Modifier and Type	Method	Description
String	convertStringToValue(String value)	Converts the given string to a valid value of this parameter.
String	convertValueToString(String 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

MetricsFilterParameter

public MetricsFilterParameter()

Method Details

convertStringToValue

public String convertStringToValue(String value)

Description copied from class: MessageQueryParameter

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

Specified by:

convertStringToValue in class MessageQueryParameter<String>

Parameters:

value - string representation of parameter value

Returns:

parameter value

convertValueToString

public String convertValueToString(String value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<String>

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<String>>

Returns:

escaped HTML string