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

Class TableCreateOptions.Builder

java.lang.Object

io.github.flink.gcp.connector.bigtable.sink.TableCreateOptions.Builder

Enclosing class:

TableCreateOptions

@Public
public static final class TableCreateOptions.Builder
extends Object

Builder for TableCreateOptions.

Method Summary

Modifier and Type	Method	Description
TableCreateOptions	build()	Builds the options.
TableCreateOptions.Builder	columnFamily(String name)	Declares a column family without a garbage-collection rule, keeping Bigtable's default of collecting nothing.
TableCreateOptions.Builder	columnFamily(String name, ColumnFamilyType valueType, GcRule rule)	Declares a column family with an explicit value type and optional retention rule.
TableCreateOptions.Builder	columnFamily(String name, GcRule rule)	Declares a column family with the given garbage-collection rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

columnFamily

public TableCreateOptions.Builder columnFamily(String name)

Declares a column family without a garbage-collection rule, keeping Bigtable's default of collecting nothing.

Parameters:

name - the family name, non-blank

Returns:

this builder

columnFamily

public TableCreateOptions.Builder columnFamily(String name,
 GcRule rule)

Declares a column family with the given garbage-collection rule.

Parameters:

name - the family name, non-blank

rule - the rule to create the family with

Returns:

this builder

columnFamily

public TableCreateOptions.Builder columnFamily(String name,
 ColumnFamilyType valueType,
 @Nullable
 GcRule rule)

Declares a column family with an explicit value type and optional retention rule. Repeating a family name replaces both its type and rule.

Parameters:

name - the family name, non-blank

valueType - the value type, not null

rule - the garbage-collection rule, or null for no automatic collection

Returns:

this builder

build

public TableCreateOptions build()

Builds the options.

Returns:

the options

Throws:

IllegalStateException - if no column family was declared