Package org.apache.flink.table.api

Enum ExplainFormat

java.lang.Object

java.lang.Enum<ExplainFormat>

org.apache.flink.table.api.ExplainFormat

All Implemented Interfaces:

Serializable, Comparable<ExplainFormat>

@PublicEvolving
public enum ExplainFormat
extends Enum<ExplainFormat>

Explain format categorizes the output format of explain result.

Enum Constant Summary

Enum Constants

Enum Constant	Description
TEXT	Explain a Explainable with plain text format.

Method Summary

Modifier and Type	Method	Description
static ExplainFormat	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ExplainFormat[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

public static final ExplainFormat TEXT

Explain a Explainable with plain text format.

Method Details

values

public static ExplainFormat[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ExplainFormat valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null