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

Class TerminationModeQueryParameter

java.lang.Object

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

org.apache.flink.runtime.rest.messages.MessageQueryParameter<TerminationModeQueryParameter.TerminationMode>

org.apache.flink.runtime.rest.messages.TerminationModeQueryParameter

public class TerminationModeQueryParameter
extends MessageQueryParameter<TerminationModeQueryParameter.TerminationMode>

Termination mode query parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TerminationModeQueryParameter.TerminationMode	Termination mode.

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

MessageParameter.MessageParameterRequisiteness

Constructor Summary

Constructors

Constructor	Description
TerminationModeQueryParameter()

Method Summary

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

TerminationModeQueryParameter

public TerminationModeQueryParameter()

Method Details

convertStringToValue

public TerminationModeQueryParameter.TerminationMode 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<TerminationModeQueryParameter.TerminationMode>

Parameters:

value - string representation of parameter value

Returns:

parameter value

convertValueToString

public String convertValueToString(TerminationModeQueryParameter.TerminationMode value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<TerminationModeQueryParameter.TerminationMode>

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<TerminationModeQueryParameter.TerminationMode>>

Returns:

escaped HTML string