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

Class SubtaskAttemptPathParameter

java.lang.Object

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

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

org.apache.flink.runtime.rest.messages.job.SubtaskAttemptPathParameter

public class SubtaskAttemptPathParameter
extends MessagePathParameter<Integer>

Path parameter identifying subtask attempt.

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	The constant subtask attempt KEY.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	SubtaskAttemptPathParameter()	Instantiates a new Subtask attempt path parameter.

Method Summary

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

The constant subtask attempt KEY.

See Also:

• Constant Field Values

Constructor Details

SubtaskAttemptPathParameter

protected SubtaskAttemptPathParameter()

Instantiates a new Subtask attempt path parameter.

Method Details

convertFromString

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

Parameters:

value - string representation of parameter value

Returns:

parameter value

Throws:

ConversionException

convertToString

protected String convertToString(Integer value)

Description copied from class: MessageParameter

Converts the given value to its string representation.

Specified by:

convertToString in class MessageParameter<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<Integer>

Returns:

escaped HTML string