Class JobsFilterQueryParameter
- java.lang.Object
-
- org.apache.flink.runtime.rest.messages.MessageParameter<List<X>>
-
- org.apache.flink.runtime.rest.messages.MessageQueryParameter<org.apache.flink.api.common.JobID>
-
- org.apache.flink.runtime.rest.messages.job.metrics.JobsFilterQueryParameter
-
public class JobsFilterQueryParameter extends MessageQueryParameter<org.apache.flink.api.common.JobID>
MessageQueryParameterfor selecting jobs when aggregating metrics.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.messages.MessageParameter
MessageParameter.MessageParameterRequisiteness
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.apache.flink.api.common.JobIDconvertStringToValue(String value)Converts the given string to a valid value of this parameter.StringconvertValueToString(org.apache.flink.api.common.JobID value)Converts the given value to its string representation.StringgetDescription()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
-
-
-
-
Method Detail
-
convertStringToValue
public org.apache.flink.api.common.JobID convertStringToValue(String value) throws ConversionException
Description copied from class:MessageQueryParameterConverts the given string to a valid value of this parameter.- Specified by:
convertStringToValuein classMessageQueryParameter<org.apache.flink.api.common.JobID>- Parameters:
value- string representation of parameter value- Returns:
- parameter value
- Throws:
ConversionException
-
convertValueToString
public String convertValueToString(org.apache.flink.api.common.JobID value)
Description copied from class:MessageQueryParameterConverts the given value to its string representation.- Specified by:
convertValueToStringin classMessageQueryParameter<org.apache.flink.api.common.JobID>- Parameters:
value- parameter value- Returns:
- string representation of typed value
-
getDescription
public String getDescription()
Description copied from class:MessageParameterReturns a description for REST API HTML documentation.- Specified by:
getDescriptionin classMessageParameter<List<org.apache.flink.api.common.JobID>>- Returns:
- escaped HTML string
-
-