Package org.apache.flink.table.gateway.rest.message.session

Class SessionHandleIdPathParameter

java.lang.Object

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

org.apache.flink.runtime.rest.messages.MessagePathParameter<SessionHandle>

org.apache.flink.table.gateway.rest.message.session.SessionHandleIdPathParameter

public class SessionHandleIdPathParameter
extends MessagePathParameter<SessionHandle>

MessagePathParameter that parse the SessionHandle.

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 String	KEY

Constructor Summary

Constructors

Constructor	Description
SessionHandleIdPathParameter()

Method Summary

Modifier and Type	Method	Description
protected SessionHandle	convertFromString(String sessionHandleId)	Converts the given string to a valid value of this parameter.
protected String	convertToString(SessionHandle sessionHandle)	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.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 Detail

KEY

public static final String KEY

See Also:

Constant Field Values

Constructor Detail

SessionHandleIdPathParameter

public SessionHandleIdPathParameter()

Method Detail

convertFromString

protected SessionHandle convertFromString(String sessionHandleId)

Description copied from class: MessageParameter

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

Specified by:

convertFromString in class MessageParameter<SessionHandle>

Parameters:

sessionHandleId - string representation of parameter value

Returns:

parameter value

convertToString

protected String convertToString(SessionHandle sessionHandle)

Description copied from class: MessageParameter

Converts the given value to its string representation.

Specified by:

convertToString in class MessageParameter<SessionHandle>

Parameters:

sessionHandle - 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<SessionHandle>

Returns:

escaped HTML string