Package io.deltastream.flink.connector.snowflake.sink

Class SnowflakeSinkBuilder<IN>

java.lang.Object

io.deltastream.flink.connector.snowflake.sink.SnowflakeSinkBuilder<IN>

Type Parameters:

IN - type of the events produced by Flink

@PublicEvolving
public class SnowflakeSinkBuilder<IN>
extends Object

Builder for constructing a SnowflakeSink with appropriate configurations.

Constructor Summary

Constructors

Constructor	Description
SnowflakeSinkBuilder()

Method Summary

Modifier and Type	Method	Description
SnowflakeSinkBuilder<IN>	bufferTimeMillis(long bufferTimeMillis)	Sets the maximum time, in milliseconds, to buffer incoming elements.
SnowflakeSink<IN>	build(String appId)	Creates a SnowflakeSink with provided configuration.
SnowflakeSinkBuilder<IN>	database(String database)	Set the database name to sink to in Snowflake.
SnowflakeSinkBuilder<IN>	deliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee)	Sets the DeliveryGuarantee to provide for writing to Snowflake.
SnowflakeSinkBuilder<IN>	keyPassphrase(String connectionKeyPassphrase)	Set the private key password for the private key in privateKey(String).
SnowflakeSinkBuilder<IN>	onErrorOption(net.snowflake.ingest.streaming.OpenChannelRequest.OnErrorOption option)	Set the option for handling errors within a Snowflake ingest channel.
SnowflakeSinkBuilder<IN>	privateKey(String connectionPrivateKey)	Set the private key to connect with to the Snowflake service.
SnowflakeSinkBuilder<IN>	role(String connectionRole)	Set the role as to connect to the Snowflake service.
SnowflakeSinkBuilder<IN>	schema(String schema)	Set the schema name to sink to in Snowflake.
SnowflakeSinkBuilder<IN>	serializationSchema(SnowflakeRowSerializationSchema<IN> serializationSchema)	Sets the serialization schema that provides serialization from SnowflakeSinkBuilder to Map row as documented above and by the Snowflake service.
SnowflakeSinkBuilder<IN>	table(String table)	Set the table name to sink to in Snowflake.
SnowflakeSinkBuilder<IN>	url(String connectionUrl)	Set the connection URL for connecting to the Snowflake service.
SnowflakeSinkBuilder<IN>	user(String connectionUser)	Set the user connecting to the Snowflake service.

Methods inherited from class java.lang.Object

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

Constructor Detail

SnowflakeSinkBuilder

public SnowflakeSinkBuilder()

Method Detail

url

public SnowflakeSinkBuilder<IN> url(String connectionUrl)

Set the connection URL for connecting to the Snowflake service.

Parameters:

connectionUrl - String

Returns:

this

user

public SnowflakeSinkBuilder<IN> user(String connectionUser)

Set the user connecting to the Snowflake service.

Parameters:

connectionUser - String

Returns:

this

role

public SnowflakeSinkBuilder<IN> role(String connectionRole)

Set the role as to connect to the Snowflake service.

Parameters:

connectionRole - String

Returns:

this

privateKey

public SnowflakeSinkBuilder<IN> privateKey(String connectionPrivateKey)

Set the private key to connect with to the Snowflake service. The private key must only include the key content without any header, footer, or newline feeds.

Parameters:

connectionPrivateKey - String

Returns:

this

keyPassphrase

public SnowflakeSinkBuilder<IN> keyPassphrase(String connectionKeyPassphrase)

Set the private key password for the private key in privateKey(String).

Parameters:

connectionKeyPassphrase - String

Returns:

this

database

public SnowflakeSinkBuilder<IN> database(String database)

Set the database name to sink to in Snowflake.

Parameters:

database - String

Returns:

this

schema

public SnowflakeSinkBuilder<IN> schema(String schema)

Set the schema name to sink to in Snowflake.

Parameters:

schema - String

Returns:

this

table

public SnowflakeSinkBuilder<IN> table(String table)

Set the table name to sink to in Snowflake.

Parameters:

table - String

Returns:

this

onErrorOption

public SnowflakeSinkBuilder<IN> onErrorOption(net.snowflake.ingest.streaming.OpenChannelRequest.OnErrorOption option)

Set the option for handling errors within a Snowflake ingest channel.

Parameters:

option - OpenChannelRequest.OnErrorOption

Returns:

this

bufferTimeMillis

public SnowflakeSinkBuilder<IN> bufferTimeMillis(long bufferTimeMillis)

Sets the maximum time, in milliseconds, to buffer incoming elements.

Parameters:

bufferTimeMillis - long

Returns:

this

deliveryGuarantee

public SnowflakeSinkBuilder<IN> deliveryGuarantee(org.apache.flink.connector.base.DeliveryGuarantee deliveryGuarantee)

Sets the DeliveryGuarantee to provide for writing to Snowflake.

Parameters:

deliveryGuarantee - DeliveryGuarantee

Returns:

this

serializationSchema

public SnowflakeSinkBuilder<IN> serializationSchema(SnowflakeRowSerializationSchema<IN> serializationSchema)

Sets the serialization schema that provides serialization from SnowflakeSinkBuilder to Map row as documented above and by the Snowflake service.

Parameters:

serializationSchema - SnowflakeRowSerializationSchema

Returns:

this

build

public SnowflakeSink<IN> build(String appId)

Creates a SnowflakeSink with provided configuration.

Returns:

SnowflakeSink