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

Class JobsFilterQueryParameter

java.lang.Object

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

org.apache.flink.runtime.rest.messages.MessageQueryParameter<org.apache.flink.api.common.JobID>

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

public class JobsFilterQueryParameter
extends MessageQueryParameter<org.apache.flink.api.common.JobID>

MessageQueryParameter for selecting jobs when aggregating metrics.

Nested Class Summary

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

MessageParameter.MessageParameterRequisiteness

Method Summary

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

Method Details

convertStringToValue

public org.apache.flink.api.common.JobID 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<org.apache.flink.api.common.JobID>

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertValueToString

public String convertValueToString(org.apache.flink.api.common.JobID value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<org.apache.flink.api.common.JobID>

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<org.apache.flink.api.common.JobID>>

Returns:

escaped HTML string