org.apache.beam.sdk.io.snowflake

Class SnowflakeIO.DataSourceConfiguration

java.lang.Object

org.apache.beam.sdk.io.snowflake.SnowflakeIO.DataSourceConfiguration

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

SnowflakeIO

public abstract static class SnowflakeIO.DataSourceConfiguration
extends java.lang.Object
implements java.io.Serializable

A POJO describing a DataSource, providing all properties allowing to create a DataSource.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSourceConfiguration()

Method Summary

Modifier and Type	Method and Description
javax.sql.DataSource	buildDatasource() Builds SnowflakeBasicDataSource based on the current configuration.
static SnowflakeIO.DataSourceConfiguration	create()
static SnowflakeIO.DataSourceConfiguration	create(javax.sql.DataSource dataSource) Creates SnowflakeIO.DataSourceConfiguration from existing instance of DataSource.
abstract java.lang.String	getAuthenticator()
abstract ValueProvider<java.lang.String>	getDatabase()
abstract javax.sql.DataSource	getDataSource()
abstract java.lang.Integer	getLoginTimeout()
abstract ValueProvider<java.lang.String>	getOauthToken()
abstract ValueProvider<java.lang.String>	getPassword()
abstract java.lang.Integer	getPortNumber()
abstract java.security.PrivateKey	getPrivateKey()
abstract ValueProvider<java.lang.String>	getPrivateKeyPassphrase()
abstract ValueProvider<java.lang.String>	getRawPrivateKey()
abstract ValueProvider<java.lang.String>	getRole()
abstract ValueProvider<java.lang.String>	getSchema()
abstract ValueProvider<java.lang.String>	getServerName()
abstract java.lang.Boolean	getSsl()
abstract java.lang.String	getUrl()
abstract ValueProvider<java.lang.String>	getUsername()
abstract ValueProvider<java.lang.String>	getWarehouse()
SnowflakeIO.DataSourceConfiguration	withAuthenticator(java.lang.String authenticator) Sets authenticator for Snowflake.
SnowflakeIO.DataSourceConfiguration	withDatabase(java.lang.String database) Sets database to use.
SnowflakeIO.DataSourceConfiguration	withDatabase(ValueProvider<java.lang.String> database)
SnowflakeIO.DataSourceConfiguration	withKeyPairAuth(java.lang.String username, java.security.PrivateKey privateKey) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairPathAuth(java.lang.String username, java.lang.String privateKeyPath) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairPathAuth(java.lang.String username, java.lang.String privateKeyPath, java.lang.String privateKeyPassphrase) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairPathAuth(ValueProvider<java.lang.String> username, java.lang.String privateKeyPath) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairPathAuth(ValueProvider<java.lang.String> username, java.lang.String privateKeyPath, ValueProvider<java.lang.String> privateKeyPassphrase) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairRawAuth(java.lang.String username, java.lang.String rawPrivateKey) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairRawAuth(java.lang.String username, java.lang.String rawPrivateKey, java.lang.String privateKeyPassphrase) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairRawAuth(ValueProvider<java.lang.String> username, ValueProvider<java.lang.String> rawPrivateKey) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withKeyPairRawAuth(ValueProvider<java.lang.String> username, ValueProvider<java.lang.String> rawPrivateKey, ValueProvider<java.lang.String> privateKeyPassphrase) Sets key pair authentication.
SnowflakeIO.DataSourceConfiguration	withLoginTimeout(java.lang.Integer loginTimeout) Sets loginTimeout that will be used in SnowflakeBasicDataSource.setLoginTimeout(int).
SnowflakeIO.DataSourceConfiguration	withOAuth(java.lang.String token) Sets OAuth authentication.
SnowflakeIO.DataSourceConfiguration	withOAuth(ValueProvider<java.lang.String> token) Sets OAuth authentication.
SnowflakeIO.DataSourceConfiguration	withPortNumber(java.lang.Integer portNumber) Sets port number to use to connect to Snowflake.
SnowflakeIO.DataSourceConfiguration	withRole(java.lang.String role) Sets user's role to be used when running queries on Snowflake.
SnowflakeIO.DataSourceConfiguration	withRole(ValueProvider<java.lang.String> role) Sets user's role to be used when running queries on Snowflake.
SnowflakeIO.DataSourceConfiguration	withSchema(java.lang.String schema) Sets schema to use when connecting to Snowflake.
SnowflakeIO.DataSourceConfiguration	withSchema(ValueProvider<java.lang.String> schema)
SnowflakeIO.DataSourceConfiguration	withServerName(java.lang.String serverName) Sets the name of the Snowflake server.
SnowflakeIO.DataSourceConfiguration	withServerName(ValueProvider<java.lang.String> serverName)
SnowflakeIO.DataSourceConfiguration	withUrl(java.lang.String url) Sets URL of Snowflake server in following format: jdbc:snowflake://.snowflakecomputing.com
SnowflakeIO.DataSourceConfiguration	withUsernamePasswordAuth(java.lang.String username, java.lang.String password) Sets username/password authentication.
SnowflakeIO.DataSourceConfiguration	withUsernamePasswordAuth(ValueProvider<java.lang.String> username, ValueProvider<java.lang.String> password) Sets username/password authentication.
SnowflakeIO.DataSourceConfiguration	withWarehouse(java.lang.String warehouse) Sets Snowflake Warehouse to use.
SnowflakeIO.DataSourceConfiguration	withWarehouse(ValueProvider<java.lang.String> warehouse) Sets Snowflake Warehouse to use.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceConfiguration

public DataSourceConfiguration()

Method Detail

getUrl

@Nullable
public abstract java.lang.String getUrl()

getUsername

@Nullable
public abstract ValueProvider<java.lang.String> getUsername()

getPassword

@Nullable
public abstract ValueProvider<java.lang.String> getPassword()

getPrivateKey

@Nullable
public abstract java.security.PrivateKey getPrivateKey()

getRawPrivateKey

@Nullable
public abstract ValueProvider<java.lang.String> getRawPrivateKey()

getPrivateKeyPassphrase

@Nullable
public abstract ValueProvider<java.lang.String> getPrivateKeyPassphrase()

getOauthToken

@Nullable
public abstract ValueProvider<java.lang.String> getOauthToken()

getDatabase

@Nullable
public abstract ValueProvider<java.lang.String> getDatabase()

getWarehouse

@Nullable
public abstract ValueProvider<java.lang.String> getWarehouse()

getSchema

@Nullable
public abstract ValueProvider<java.lang.String> getSchema()

getServerName

@Nullable
public abstract ValueProvider<java.lang.String> getServerName()

getPortNumber

@Nullable
public abstract java.lang.Integer getPortNumber()

getRole

@Nullable
public abstract ValueProvider<java.lang.String> getRole()

getAuthenticator

@Nullable
public abstract java.lang.String getAuthenticator()

getLoginTimeout

@Nullable
public abstract java.lang.Integer getLoginTimeout()

getSsl

@Nullable
public abstract java.lang.Boolean getSsl()

getDataSource

@Nullable
public abstract javax.sql.DataSource getDataSource()

create

public static SnowflakeIO.DataSourceConfiguration create()

create

public static SnowflakeIO.DataSourceConfiguration create(javax.sql.DataSource dataSource)

Creates SnowflakeIO.DataSourceConfiguration from existing instance of DataSource.

Parameters:

dataSource - - an instance of DataSource.

withUsernamePasswordAuth

public SnowflakeIO.DataSourceConfiguration withUsernamePasswordAuth(java.lang.String username,
                                                                    java.lang.String password)

Sets username/password authentication.

Parameters:

username - - Snowflake username.

password - - Password for provided Snowflake username.

withUsernamePasswordAuth

public SnowflakeIO.DataSourceConfiguration withUsernamePasswordAuth(ValueProvider<java.lang.String> username,
                                                                    ValueProvider<java.lang.String> password)

Sets username/password authentication.

Parameters:

username - - Snowflake username.

password - - Password for provided Snowflake username.

withOAuth

public SnowflakeIO.DataSourceConfiguration withOAuth(java.lang.String token)

Sets OAuth authentication.

Parameters:

token - - OAuth token.

withOAuth

public SnowflakeIO.DataSourceConfiguration withOAuth(ValueProvider<java.lang.String> token)

Sets OAuth authentication.

Parameters:

token - - OAuth token.

withKeyPairAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairAuth(java.lang.String username,
                                                           java.security.PrivateKey privateKey)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

privateKey - - Private key.

withKeyPairPathAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairPathAuth(ValueProvider<java.lang.String> username,
                                                               java.lang.String privateKeyPath,
                                                               ValueProvider<java.lang.String> privateKeyPassphrase)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

privateKeyPath - - Private key path.

privateKeyPassphrase - - Passphrase for provided private key.

withKeyPairPathAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairPathAuth(ValueProvider<java.lang.String> username,
                                                               java.lang.String privateKeyPath)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

privateKeyPath - - Private key path.

withKeyPairPathAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairPathAuth(java.lang.String username,
                                                               java.lang.String privateKeyPath,
                                                               java.lang.String privateKeyPassphrase)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

privateKeyPath - - Private key path.

privateKeyPassphrase - - Passphrase for provided private key.

withKeyPairPathAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairPathAuth(java.lang.String username,
                                                               java.lang.String privateKeyPath)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

privateKeyPath - - Private key path.

withKeyPairRawAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairRawAuth(ValueProvider<java.lang.String> username,
                                                              ValueProvider<java.lang.String> rawPrivateKey,
                                                              ValueProvider<java.lang.String> privateKeyPassphrase)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

rawPrivateKey - - Raw private key.

privateKeyPassphrase - - Passphrase for provided private key.

withKeyPairRawAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairRawAuth(ValueProvider<java.lang.String> username,
                                                              ValueProvider<java.lang.String> rawPrivateKey)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

rawPrivateKey - - Raw private key.

withKeyPairRawAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairRawAuth(java.lang.String username,
                                                              java.lang.String rawPrivateKey,
                                                              java.lang.String privateKeyPassphrase)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

rawPrivateKey - - Raw private key.

privateKeyPassphrase - - Passphrase for provided private key.

withKeyPairRawAuth

public SnowflakeIO.DataSourceConfiguration withKeyPairRawAuth(java.lang.String username,
                                                              java.lang.String rawPrivateKey)

Sets key pair authentication.

Parameters:

username - - Snowflake username.

rawPrivateKey - - Raw private key.

withUrl

public SnowflakeIO.DataSourceConfiguration withUrl(java.lang.String url)

Sets URL of Snowflake server in following format: jdbc:snowflake://.snowflakecomputing.com

Either withUrl or withServerName is required.

Parameters:

url - String with URL of the Snowflake server.

withDatabase

public SnowflakeIO.DataSourceConfiguration withDatabase(java.lang.String database)

Sets database to use.

Parameters:

database - String with database name.

withDatabase

public SnowflakeIO.DataSourceConfiguration withDatabase(ValueProvider<java.lang.String> database)

withWarehouse

public SnowflakeIO.DataSourceConfiguration withWarehouse(ValueProvider<java.lang.String> warehouse)

Sets Snowflake Warehouse to use.

Parameters:

warehouse - ValueProvider with warehouse name.

withWarehouse

public SnowflakeIO.DataSourceConfiguration withWarehouse(java.lang.String warehouse)

Sets Snowflake Warehouse to use.

Parameters:

warehouse - String with warehouse name.

withSchema

public SnowflakeIO.DataSourceConfiguration withSchema(java.lang.String schema)

Sets schema to use when connecting to Snowflake.

Parameters:

schema - String with schema name.

withSchema

public SnowflakeIO.DataSourceConfiguration withSchema(ValueProvider<java.lang.String> schema)

withServerName

public SnowflakeIO.DataSourceConfiguration withServerName(java.lang.String serverName)

Sets the name of the Snowflake server. Following format is required: .snowflakecomputing.com

Either withServerName or withUrl is required.

Parameters:

serverName - String with server name.

withServerName

public SnowflakeIO.DataSourceConfiguration withServerName(ValueProvider<java.lang.String> serverName)

withPortNumber

public SnowflakeIO.DataSourceConfiguration withPortNumber(java.lang.Integer portNumber)

Sets port number to use to connect to Snowflake.

Parameters:

portNumber - Integer with port number.

withRole

public SnowflakeIO.DataSourceConfiguration withRole(ValueProvider<java.lang.String> role)

Sets user's role to be used when running queries on Snowflake.

Parameters:

role - ValueProvider with role name.

withRole

public SnowflakeIO.DataSourceConfiguration withRole(java.lang.String role)

Sets user's role to be used when running queries on Snowflake.

Parameters:

role - String with role name.

withAuthenticator

public SnowflakeIO.DataSourceConfiguration withAuthenticator(java.lang.String authenticator)

Sets authenticator for Snowflake.

Parameters:

authenticator - String with authenticator name.

withLoginTimeout

public SnowflakeIO.DataSourceConfiguration withLoginTimeout(java.lang.Integer loginTimeout)

Sets loginTimeout that will be used in SnowflakeBasicDataSource.setLoginTimeout(int).

Parameters:

loginTimeout - Integer with timeout value.

buildDatasource

public javax.sql.DataSource buildDatasource()

Builds SnowflakeBasicDataSource based on the current configuration.