Package org.apache.beam.sdk.io.snowflake

Class SnowflakeWriteConfiguration

java.lang.Object

org.apache.beam.sdk.io.snowflake.SnowflakeWriteConfiguration

All Implemented Interfaces:

Serializable

@DefaultSchema(AutoValueSchema.class)
public abstract class SnowflakeWriteConfiguration
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SnowflakeWriteConfiguration.Builder

Constructor Summary

Constructors

Constructor	Description
SnowflakeWriteConfiguration()

Method Summary

Modifier and Type	Method	Description
static SnowflakeWriteConfiguration.Builder	builder()
abstract String	getCreateDisposition()
abstract String	getDatabase()
abstract String	getDebugMode()
abstract Integer	getFlushRowLimit()
abstract Long	getFlushTimeLimitMillis()
abstract String	getOauthToken()
abstract String	getPassword()
abstract String	getPrivateKey()
abstract String	getPrivateKeyPassphrase()
abstract String	getQuotationMark()
abstract String	getRole()
abstract String	getSchema()
abstract String	getServerName()
abstract Integer	getShardsNumber()
abstract String	getSnowPipe()
abstract String	getStagingBucketName()
abstract String	getStorageIntegrationName()
abstract String	getTable()
abstract String	getUsername()
abstract String	getWarehouse()
abstract String	getWriteDisposition()
abstract SnowflakeWriteConfiguration.Builder	toBuilder()

Methods inherited from class java.lang.Object

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

Constructor Details

SnowflakeWriteConfiguration

public SnowflakeWriteConfiguration()

Method Details

getServerName

@SchemaFieldDescription("Snowflake server name.")
public abstract String getServerName()

getUsername

@SchemaFieldDescription("Snowflake username. Required for password and private key authentication.")
@Nullable
public abstract String getUsername()

getPassword

@SchemaFieldDescription("Snowflake password. Mutually exclusive with OAuth token and private key.")
@Nullable
public abstract String getPassword()

getOauthToken

@SchemaFieldDescription("Snowflake OAuth token. Mutually exclusive with password and private key.")
@Nullable
public abstract String getOauthToken()

getPrivateKey

@SchemaFieldDescription("Raw Snowflake private key. Mutually exclusive with password and OAuth token.")
@Nullable
public abstract String getPrivateKey()

getPrivateKeyPassphrase

@SchemaFieldDescription("Passphrase for the Snowflake private key.")
@Nullable
public abstract String getPrivateKeyPassphrase()

getDatabase

@SchemaFieldDescription("Snowflake database name.")
public abstract String getDatabase()

getSchema

@SchemaFieldDescription("Snowflake schema name.")
public abstract String getSchema()

getWarehouse

@SchemaFieldDescription("Snowflake warehouse name.")
@Nullable
public abstract String getWarehouse()

getRole

@SchemaFieldDescription("Snowflake role.")
@Nullable
public abstract String getRole()

getTable

@SchemaFieldDescription("Destination Snowflake table. Required for batch writes.")
@Nullable
public abstract String getTable()

getSnowPipe

@SchemaFieldDescription("Snowflake Snowpipe name. Required for streaming writes.")
@Nullable
public abstract String getSnowPipe()

getStagingBucketName

@SchemaFieldDescription("GCS path used to stage CSV files. The path must end with \'/\'.")
public abstract String getStagingBucketName()

getStorageIntegrationName

@SchemaFieldDescription("Snowflake storage integration name.")
public abstract String getStorageIntegrationName()

getCreateDisposition

@SchemaFieldDescription("Table creation behavior for batch writes. Supported values are CREATE_IF_NEEDED and CREATE_NEVER.")
@Nullable
public abstract String getCreateDisposition()

getWriteDisposition

@SchemaFieldDescription("Write behavior for batch writes. Supported values are APPEND, TRUNCATE, and EMPTY.")
@Nullable
public abstract String getWriteDisposition()

getQuotationMark

@SchemaFieldDescription("Quotation mark used when writing values to staged CSV files.")
@Nullable
public abstract String getQuotationMark()

getFlushRowLimit

@SchemaFieldDescription("Maximum number of rows to stage before flushing in streaming mode.")
@Nullable
public abstract Integer getFlushRowLimit()

getFlushTimeLimitMillis

@SchemaFieldDescription("Maximum time in milliseconds before flushing staged rows in streaming mode.")
@Nullable
public abstract Long getFlushTimeLimitMillis()

getShardsNumber

@SchemaFieldDescription("Number of output shards used when staging files.")
@Nullable
public abstract Integer getShardsNumber()

getDebugMode

@SchemaFieldDescription("Streaming log level. Supported values are ERROR and INFO.")
@Nullable
public abstract String getDebugMode()

builder

public static SnowflakeWriteConfiguration.Builder builder()

toBuilder

public abstract SnowflakeWriteConfiguration.Builder toBuilder()