org.apache.flink.table.client.config

Enum ResultMode

java.lang.Object

java.lang.Enum<ResultMode>

org.apache.flink.table.client.config.ResultMode

All Implemented Interfaces:

Serializable, Comparable<ResultMode>, DescribedEnum

@PublicEvolving
public enum ResultMode
extends Enum<ResultMode>
implements DescribedEnum

The mode when display the result of the query in the sql client.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CHANGELOG
TABLE
TABLEAU

Method Summary

Modifier and Type	Method and Description
InlineElement	getDescription() Returns the description for the enum constant.
static ResultMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static ResultMode[]	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 Detail

TABLE

public static final ResultMode TABLE

CHANGELOG

public static final ResultMode CHANGELOG

TABLEAU

public static final ResultMode TABLEAU

Method Detail

values

public static ResultMode[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ResultMode c : ResultMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static ResultMode 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

getDescription

public InlineElement getDescription()

Description copied from interface: DescribedEnum

Returns the description for the enum constant.

If you want to include links or code blocks, use TextElement.wrap(InlineElement...) to wrap multiple inline elements into a single one.

Specified by:

getDescription in interface DescribedEnum