org.apache.flink.runtime.rest.messages

类 MessageQueryParameter<X>

java.lang.Object

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

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

直接已知子类:

AccumulatorsIncludeSerializedValueQueryParameter, FlameGraphTypeQueryParameter, JobsFilterQueryParameter, MetricsAggregationParameter, MetricsFilterParameter, RescalingParallelismQueryParameter, 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).

嵌套类概要

从类继承的嵌套类/接口 org.apache.flink.runtime.rest.messages.MessageParameter

MessageParameter.MessageParameterRequisiteness

构造器概要

构造器

限定符	构造器和说明
protected	MessageQueryParameter(String key, MessageParameter.MessageParameterRequisiteness requisiteness)

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 org.apache.flink.runtime.rest.messages.MessageParameter

getDescription, getKey, getValue, isMandatory, isResolved, resolve, resolveFromString

从类继承的方法 java.lang.Object

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

构造器详细资料

MessageQueryParameter

protected MessageQueryParameter(String key,
                                MessageParameter.MessageParameterRequisiteness requisiteness)

方法详细资料

convertFromString

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

从类复制的说明: MessageParameter

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

指定者:

convertFromString 在类中 MessageParameter<List<X>>

参数:

values - string representation of parameter value

返回:

parameter value

抛出:

ConversionException

convertStringToValue

public abstract X convertStringToValue(String value)
                                throws ConversionException

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

参数:

value - string representation of parameter value

返回:

parameter value

抛出:

ConversionException

convertToString

public String convertToString(List<X> values)

从类复制的说明: MessageParameter

Converts the given value to its string representation.

指定者:

convertToString 在类中 MessageParameter<List<X>>

参数:

values - parameter value

返回:

string representation of typed value

convertValueToString

public abstract String convertValueToString(X value)

Converts the given value to its string representation.

参数:

value - parameter value

返回:

string representation of typed value