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

Class MessageQueryParameter<X>

java.lang.Object

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

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

Direct Known Subclasses:

AccumulatorsIncludeSerializedValueQueryParameter, AllowNonRestoredStateQueryParameter, FailureLabelFilterParameter, FetchResultsRowFormatQueryParameter, FlameGraphTypeQueryParameter, JobsFilterQueryParameter, MetricsAggregationParameter, MetricsFilterParameter, ParallelismQueryParameter, RescalingParallelismQueryParameter, StringQueryParameter, SubtaskIndexQueryParameter, SubtasksFilterQueryParameter, TaskManagersFilterQueryParameter, TerminationModeQueryParameter, UpperLimitExceptionParameter

public abstract class MessageQueryParameter<X>
extends MessageParameter<List<X>>

This class represents query parameters of a request. For example, the URL "/jobs?state=running" has a "state" query parameter, with "running" being its value string representation.

Query parameters may both occur multiple times or be of the form "key=value1,value2,value3". If a query parameter is specified multiple times the individual values are concatenated with , and passed as a single value to convertToString(List).

Nested Class Summary

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

MessageParameter.MessageParameterRequisiteness

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageQueryParameter(String key, MessageParameter.MessageParameterRequisiteness requisiteness)

Method Summary

Modifier and Type	Method	Description
List<X>	convertFromString(String values)	Converts the given string to a valid value of this parameter.
abstract X	convertStringToValue(String value)	Converts the given string to a valid value of this parameter.
String	convertToString(List<X> values)	Converts the given value to its string representation.
abstract String	convertValueToString(X value)	Converts the given value to its string representation.

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

getDescription, 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 Detail

MessageQueryParameter

protected MessageQueryParameter(String key,
                                MessageParameter.MessageParameterRequisiteness requisiteness)

Method Detail

convertFromString

public List<X> convertFromString(String values)
                          throws ConversionException

Description copied from class: MessageParameter

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

Specified by:

convertFromString in class MessageParameter<List<X>>

Parameters:

values - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertStringToValue

public abstract X convertStringToValue(String value)
                                throws ConversionException

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

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertToString

public String convertToString(List<X> values)

Description copied from class: MessageParameter

Converts the given value to its string representation.

Specified by:

convertToString in class MessageParameter<List<X>>

Parameters:

values - parameter value

Returns:

string representation of typed value

convertValueToString

public abstract String convertValueToString(X value)

Converts the given value to its string representation.

Parameters:

value - parameter value

Returns:

string representation of typed value