Class CheckpointIdPathParameter
- java.lang.Object
-
- org.apache.flink.runtime.rest.messages.MessageParameter<X>
-
- org.apache.flink.runtime.rest.messages.MessagePathParameter<Long>
-
- org.apache.flink.runtime.rest.messages.checkpoints.CheckpointIdPathParameter
-
public class CheckpointIdPathParameter extends MessagePathParameter<Long>
Path parameter for the checkpoint id of typeLong
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.messages.MessageParameter
MessageParameter.MessageParameterRequisiteness
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
CheckpointIdPathParameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected Long
convertFromString(String value)
Converts the given string to a valid value of this parameter.protected String
convertToString(Long 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
-
-
-
-
Field Detail
-
KEY
public static final String KEY
- See Also:
- Constant Field Values
-
-
Method Detail
-
convertFromString
protected Long 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 classMessageParameter<Long>
- Parameters:
value
- string representation of parameter value- Returns:
- parameter value
- Throws:
ConversionException
-
convertToString
protected String convertToString(Long value)
Description copied from class:MessageParameter
Converts the given value to its string representation.- Specified by:
convertToString
in classMessageParameter<Long>
- 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 classMessageParameter<Long>
- Returns:
- escaped HTML string
-
-