Package io.github.flink.gcp.connector.bigtable.sink

Enum CreateDisposition

java.lang.Object

java.lang.Enum<CreateDisposition>

io.github.flink.gcp.connector.bigtable.sink.CreateDisposition

All Implemented Interfaces:

Serializable, Comparable<CreateDisposition>, java.lang.constant.Constable

@Public
public enum CreateDisposition
extends Enum<CreateDisposition>

Whether the sink may create the destination table when it does not exist.

Unlike the Pub/Sub sink's disposition, CREATE_IF_NEEDED cannot stand alone: a Bigtable table's schema is its column families and their garbage-collection policies, which the sink cannot guess, so the disposition requires BigtableSinkBuilder.tableCreateOptions(TableCreateOptions) naming at least one family.

toString() returns the hyphenated spelling rather than the constant name, because that spelling is what a SQL WITH clause is written in: Flink resolves an enum ConfigOption by matching the configured value against toString(), case-insensitively and with no other normalization. Flink's own DeliveryGuarantee carries its option spelling the same way.

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
CREATE_IF_NEEDED	Create the destination table — or the column families it is missing — from TableCreateOptions when a mutation finds them absent.
CREATE_NEVER	Never create the table or a column family; writing to a missing one fails.

Method Summary

Modifier and Type	Method	Description
String	toString()
static CreateDisposition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CreateDisposition[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATE_IF_NEEDED

public static final CreateDisposition CREATE_IF_NEEDED

Create the destination table — or the column families it is missing — from TableCreateOptions when a mutation finds them absent.

CREATE_NEVER

public static final CreateDisposition CREATE_NEVER

Never create the table or a column family; writing to a missing one fails.

Method Details

values

public static CreateDisposition[] 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 CreateDisposition 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

toString

public String toString()

Overrides:

toString in class Enum<CreateDisposition>