Package org.apache.flink.table.api.config

Enum TableConfigOptions.ColumnExpansionStrategy

java.lang.Object

java.lang.Enum<TableConfigOptions.ColumnExpansionStrategy>

org.apache.flink.table.api.config.TableConfigOptions.ColumnExpansionStrategy

All Implemented Interfaces:

Serializable, Comparable<TableConfigOptions.ColumnExpansionStrategy>, java.lang.constant.Constable, DescribedEnum

Enclosing class:

TableConfigOptions

@PublicEvolving
public static enum TableConfigOptions.ColumnExpansionStrategy
extends Enum<TableConfigOptions.ColumnExpansionStrategy>
implements DescribedEnum

Strategy to expand columns in SELECT * queries.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
EXCLUDE_ALIASED_VIRTUAL_METADATA_COLUMNS
EXCLUDE_DEFAULT_VIRTUAL_METADATA_COLUMNS

Method Summary

Modifier and Type	Method	Description
InlineElement	getDescription()	Returns the description for the enum constant.
static TableConfigOptions.ColumnExpansionStrategy	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TableConfigOptions.ColumnExpansionStrategy[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXCLUDE_ALIASED_VIRTUAL_METADATA_COLUMNS

public static final TableConfigOptions.ColumnExpansionStrategy EXCLUDE_ALIASED_VIRTUAL_METADATA_COLUMNS

EXCLUDE_DEFAULT_VIRTUAL_METADATA_COLUMNS

public static final TableConfigOptions.ColumnExpansionStrategy EXCLUDE_DEFAULT_VIRTUAL_METADATA_COLUMNS

Method Details

values

public static TableConfigOptions.ColumnExpansionStrategy[] 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 TableConfigOptions.ColumnExpansionStrategy 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

@Internal
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