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

Class SubtaskIndexQueryParameter

java.lang.Object

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

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

org.apache.flink.runtime.rest.messages.SubtaskIndexQueryParameter

public class SubtaskIndexQueryParameter
extends MessageQueryParameter<Integer>

Query parameter specifying the index of a subtask.

Nested Class Summary

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

MessageParameter.MessageParameterRequisiteness

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
SubtaskIndexQueryParameter()

Method Summary

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

Field Details

KEY

public static final String KEY

See Also:

• Constant Field Values

Constructor Details

SubtaskIndexQueryParameter

public SubtaskIndexQueryParameter()

Method Details

convertStringToValue

public Integer 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<Integer>

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertValueToString

public String convertValueToString(Integer value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<Integer>

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

Returns:

escaped HTML string