Class FailureLabelFilterParameter
- java.lang.Object
-
- org.apache.flink.runtime.rest.messages.MessageParameter<List<X>>
-
- org.apache.flink.runtime.rest.messages.MessageQueryParameter<FailureLabelFilterParameter.FailureLabel>
-
- org.apache.flink.runtime.rest.messages.job.FailureLabelFilterParameter
-
public class FailureLabelFilterParameter extends MessageQueryParameter<FailureLabelFilterParameter.FailureLabel>
Specifies a collections of failure labels, filtering the exceptions returned for JobExceptionsHandler.- See Also:
JobExceptionsHandler
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFailureLabelFilterParameter.FailureLabelRepresents a failure label consisting of a KV pair of strings.-
Nested classes/interfaces inherited from class org.apache.flink.runtime.rest.messages.MessageParameter
MessageParameter.MessageParameterRequisiteness
-
-
Constructor Summary
Constructors Constructor Description FailureLabelFilterParameter()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<FailureLabelFilterParameter.FailureLabel>convertFromString(String values)Converts the given string to a valid value of this parameter.FailureLabelFilterParameter.FailureLabelconvertStringToValue(String value)Converts the given string to a valid value of this parameter.StringconvertValueToString(FailureLabelFilterParameter.FailureLabel 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
convertToString
-
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
public List<FailureLabelFilterParameter.FailureLabel> convertFromString(String values) throws ConversionException
Description copied from class:MessageParameterConverts the given string to a valid value of this parameter.- Overrides:
convertFromStringin classMessageQueryParameter<FailureLabelFilterParameter.FailureLabel>- Parameters:
values- string representation of parameter value- Returns:
- parameter value
- Throws:
ConversionException
-
convertStringToValue
public FailureLabelFilterParameter.FailureLabel convertStringToValue(String value) throws ConversionException
Description copied from class:MessageQueryParameterConverts the given string to a valid value of this parameter.- Specified by:
convertStringToValuein classMessageQueryParameter<FailureLabelFilterParameter.FailureLabel>- Parameters:
value- string representation of parameter value- Returns:
- parameter value
- Throws:
ConversionException
-
convertValueToString
public String convertValueToString(FailureLabelFilterParameter.FailureLabel value)
Description copied from class:MessageQueryParameterConverts the given value to its string representation.- Specified by:
convertValueToStringin classMessageQueryParameter<FailureLabelFilterParameter.FailureLabel>- 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<FailureLabelFilterParameter.FailureLabel>>- Returns:
- escaped HTML string
-
-