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

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 class	FailureLabelFilterParameter.FailureLabel	Represents 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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY

Constructor Summary

Constructors

Constructor	Description
FailureLabelFilterParameter()

Method Summary

Modifier and Type	Method	Description
List<FailureLabelFilterParameter.FailureLabel>	convertFromString(String values)	Converts the given string to a valid value of this parameter.
FailureLabelFilterParameter.FailureLabel	convertStringToValue(String value)	Converts the given string to a valid value of this parameter.
String	convertValueToString(FailureLabelFilterParameter.FailureLabel 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.MessageQueryParameter

convertToString

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

FailureLabelFilterParameter

public FailureLabelFilterParameter()

Method Details

convertFromString

public List<FailureLabelFilterParameter.FailureLabel> convertFromString(String values)
                                                                 throws ConversionException

Description copied from class: MessageParameter

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

Overrides:

convertFromString in class MessageQueryParameter<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: MessageQueryParameter

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

Specified by:

convertStringToValue in class MessageQueryParameter<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: MessageQueryParameter

Converts the given value to its string representation.

Specified by:

convertValueToString in class MessageQueryParameter<FailureLabelFilterParameter.FailureLabel>

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<List<FailureLabelFilterParameter.FailureLabel>>

Returns:

escaped HTML string