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

Class FlameGraphTypeQueryParameter

java.lang.Object

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

org.apache.flink.runtime.rest.messages.MessageQueryParameter<FlameGraphTypeQueryParameter.Type>

org.apache.flink.runtime.rest.messages.FlameGraphTypeQueryParameter

public class FlameGraphTypeQueryParameter
extends MessageQueryParameter<FlameGraphTypeQueryParameter.Type>

Flame Graph type query parameter.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FlameGraphTypeQueryParameter.Type	Flame Graph type.

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
FlameGraphTypeQueryParameter()

Method Summary

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

FlameGraphTypeQueryParameter

public FlameGraphTypeQueryParameter()

Method Details

convertStringToValue

public FlameGraphTypeQueryParameter.Type 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<FlameGraphTypeQueryParameter.Type>

Parameters:

value - string representation of parameter value

Returns:

parameter value

convertValueToString

public String convertValueToString(FlameGraphTypeQueryParameter.Type value)

Description copied from class: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<FlameGraphTypeQueryParameter.Type>

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<FlameGraphTypeQueryParameter.Type>>

Returns:

escaped HTML string