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

Class JobVertexIdPathParameter

java.lang.Object

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

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

org.apache.flink.runtime.rest.messages.JobVertexIdPathParameter

public class JobVertexIdPathParameter
extends MessagePathParameter<JobVertexID>

Path parameter specifying a JobVertexID.

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

Method Summary

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

JobVertexIdPathParameter

public JobVertexIdPathParameter()

Method Details

convertFromString

protected JobVertexID convertFromString(String value)
                                 throws ConversionException

Description copied from class: MessageParameter

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

Specified by:

convertFromString in class MessageParameter<JobVertexID>

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertToString

protected String convertToString(JobVertexID value)

Description copied from class: MessageParameter

Converts the given value to its string representation.

Specified by:

convertToString in class MessageParameter<JobVertexID>

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

Returns:

escaped HTML string