SnowflakeV2LinkedService Class

Package:

com.azure.resourcemanager.datafactory.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-datafactory:1.2.0

• java.lang.Object
• • com.azure.resourcemanager.datafactory.models.LinkedService
  • • com.azure.resourcemanager.datafactory.models.SnowflakeV2LinkedService

public final class SnowflakeV2LinkedService
extends LinkedService

Snowflake linked service.

Constructor Summary

Constructor	Description
SnowflakeV2LinkedService()	Creates an instance of SnowflakeV2LinkedService class.

Method Summary

Modifier and Type	Method and Description
Object	accountIdentifier() Get the accountIdentifier property: The account identifier of your Snowflake account, e.g.
SnowflakeAuthenticationType	authenticationType() Get the authenticationType property: The type used for authentication.
Object	clientId() Get the clientId property: The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
SecretBase	clientSecret() Get the clientSecret property: The Azure key vault secret reference of client secret for AADServicePrincipal authentication.
Object	database() Get the database property: The name of the Snowflake database.
String	encryptedCredential() Get the encryptedCredential property: The encrypted credential used for authentication.
static SnowflakeV2LinkedService	fromJson(JsonReader jsonReader) Reads an instance of SnowflakeV2LinkedService from the JsonReader.
Object	host() Get the host property: The host name of the Snowflake account.
SecretBase	password() Get the password property: The Azure key vault secret reference of password in connection string.
SecretBase	privateKey() Get the privateKey property: The Azure key vault secret reference of privateKey for KeyPair auth.
SecretBase	privateKeyPassphrase() Get the privateKeyPassphrase property: The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key.
Object	role() Get the role property: The default access control role to use in the Snowflake session.
Object	schema() Get the schema property: Schema name for connection.
Object	scope() Get the scope property: The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.
Object	tenantId() Get the tenantId property: The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
JsonWriter	toJson(JsonWriter jsonWriter)
String	type() Get the type property: Type of linked service.
Object	user() Get the user property: The name of the Snowflake user.
void	validate() Validates the instance.
Object	warehouse() Get the warehouse property: The name of the Snowflake warehouse.
SnowflakeV2LinkedService	withAccountIdentifier(Object accountIdentifier) Set the accountIdentifier property: The account identifier of your Snowflake account, e.g.
SnowflakeV2LinkedService	withAnnotations(List<Object> annotations) Set the annotations property: List of tags that can be used for describing the linked service.
SnowflakeV2LinkedService	withAuthenticationType(SnowflakeAuthenticationType authenticationType) Set the authenticationType property: The type used for authentication.
SnowflakeV2LinkedService	withClientId(Object clientId) Set the clientId property: The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
SnowflakeV2LinkedService	withClientSecret(SecretBase clientSecret) Set the clientSecret property: The Azure key vault secret reference of client secret for AADServicePrincipal authentication.
SnowflakeV2LinkedService	withConnectVia(IntegrationRuntimeReference connectVia) Set the connectVia property: The integration runtime reference.
SnowflakeV2LinkedService	withDatabase(Object database) Set the database property: The name of the Snowflake database.
SnowflakeV2LinkedService	withDescription(String description) Set the description property: Linked service description.
SnowflakeV2LinkedService	withEncryptedCredential(String encryptedCredential) Set the encryptedCredential property: The encrypted credential used for authentication.
SnowflakeV2LinkedService	withHost(Object host) Set the host property: The host name of the Snowflake account.
SnowflakeV2LinkedService	withParameters(Map<String,ParameterSpecification> parameters) Set the parameters property: Parameters for linked service.
SnowflakeV2LinkedService	withPassword(SecretBase password) Set the password property: The Azure key vault secret reference of password in connection string.
SnowflakeV2LinkedService	withPrivateKey(SecretBase privateKey) Set the privateKey property: The Azure key vault secret reference of privateKey for KeyPair auth.
SnowflakeV2LinkedService	withPrivateKeyPassphrase(SecretBase privateKeyPassphrase) Set the privateKeyPassphrase property: The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key.
SnowflakeV2LinkedService	withRole(Object role) Set the role property: The default access control role to use in the Snowflake session.
SnowflakeV2LinkedService	withSchema(Object schema) Set the schema property: Schema name for connection.
SnowflakeV2LinkedService	withScope(Object scope) Set the scope property: The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.
SnowflakeV2LinkedService	withTenantId(Object tenantId) Set the tenantId property: The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.
SnowflakeV2LinkedService	withUser(Object user) Set the user property: The name of the Snowflake user.
SnowflakeV2LinkedService	withVersion(String version) Set the version property: Version of the linked service.
SnowflakeV2LinkedService	withWarehouse(Object warehouse) Set the warehouse property: The name of the Snowflake warehouse.

Methods inherited from LinkedService

additionalProperties annotations connectVia description fromJson parameters toJson type validate version withAdditionalProperties withAnnotations withConnectVia withDescription withParameters withVersion

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SnowflakeV2LinkedService

public SnowflakeV2LinkedService()

Creates an instance of SnowflakeV2LinkedService class.

Method Details

accountIdentifier

public Object accountIdentifier()

Get the accountIdentifier property: The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure.

Returns:

the accountIdentifier value.

authenticationType

public SnowflakeAuthenticationType authenticationType()

Get the authenticationType property: The type used for authentication. Type: string.

Returns:

the authenticationType value.

clientId

public Object clientId()

Get the clientId property: The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Returns:

the clientId value.

clientSecret

public SecretBase clientSecret()

Get the clientSecret property: The Azure key vault secret reference of client secret for AADServicePrincipal authentication.

Returns:

the clientSecret value.

database

public Object database()

Get the database property: The name of the Snowflake database.

Returns:

the database value.

encryptedCredential

public String encryptedCredential()

Get the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Returns:

the encryptedCredential value.

fromJson

public static SnowflakeV2LinkedService fromJson(JsonReader jsonReader)

Reads an instance of SnowflakeV2LinkedService from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SnowflakeV2LinkedService if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

host

public Object host()

Get the host property: The host name of the Snowflake account. Type: string (or Expression with resultType string).

Returns:

the host value.

password

public SecretBase password()

Get the password property: The Azure key vault secret reference of password in connection string.

Returns:

the password value.

privateKey

public SecretBase privateKey()

Get the privateKey property: The Azure key vault secret reference of privateKey for KeyPair auth.

Returns:

the privateKey value.

privateKeyPassphrase

public SecretBase privateKeyPassphrase()

Get the privateKeyPassphrase property: The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key.

Returns:

the privateKeyPassphrase value.

role

public Object role()

Get the role property: The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string).

Returns:

the role value.

schema

public Object schema()

Get the schema property: Schema name for connection. Type: string (or Expression with resultType string).

Returns:

the schema value.

scope

public Object scope()

Get the scope property: The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Returns:

the scope value.

tenantId

public Object tenantId()

Get the tenantId property: The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Returns:

the tenantId value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Overrides:

SnowflakeV2LinkedService.toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

type

public String type()

Get the type property: Type of linked service.

Overrides:

SnowflakeV2LinkedService.type()

Returns:

the type value.

user

public Object user()

Get the user property: The name of the Snowflake user.

Returns:

the user value.

validate

public void validate()

Validates the instance.

Overrides:

SnowflakeV2LinkedService.validate()

warehouse

public Object warehouse()

Get the warehouse property: The name of the Snowflake warehouse.

Returns:

the warehouse value.

withAccountIdentifier

public SnowflakeV2LinkedService withAccountIdentifier(Object accountIdentifier)

Set the accountIdentifier property: The account identifier of your Snowflake account, e.g. xy12345.east-us-2.azure.

Parameters:

accountIdentifier - the accountIdentifier value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withAnnotations

public SnowflakeV2LinkedService withAnnotations(List<Object> annotations)

Set the annotations property: List of tags that can be used for describing the linked service.

Overrides:

SnowflakeV2LinkedService.withAnnotations(List<Object> annotations)

Parameters:

annotations

withAuthenticationType

public SnowflakeV2LinkedService withAuthenticationType(SnowflakeAuthenticationType authenticationType)

Set the authenticationType property: The type used for authentication. Type: string.

Parameters:

authenticationType - the authenticationType value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withClientId

public SnowflakeV2LinkedService withClientId(Object clientId)

Set the clientId property: The client ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Parameters:

clientId - the clientId value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withClientSecret

public SnowflakeV2LinkedService withClientSecret(SecretBase clientSecret)

Set the clientSecret property: The Azure key vault secret reference of client secret for AADServicePrincipal authentication.

Parameters:

clientSecret - the clientSecret value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withConnectVia

public SnowflakeV2LinkedService withConnectVia(IntegrationRuntimeReference connectVia)

Set the connectVia property: The integration runtime reference.

Overrides:

SnowflakeV2LinkedService.withConnectVia(IntegrationRuntimeReference connectVia)

Parameters:

connectVia

withDatabase

public SnowflakeV2LinkedService withDatabase(Object database)

Set the database property: The name of the Snowflake database.

Parameters:

database - the database value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withDescription

public SnowflakeV2LinkedService withDescription(String description)

Set the description property: Linked service description.

Overrides:

SnowflakeV2LinkedService.withDescription(String description)

Parameters:

description

withEncryptedCredential

public SnowflakeV2LinkedService withEncryptedCredential(String encryptedCredential)

Set the encryptedCredential property: The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string.

Parameters:

encryptedCredential - the encryptedCredential value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withHost

public SnowflakeV2LinkedService withHost(Object host)

Set the host property: The host name of the Snowflake account. Type: string (or Expression with resultType string).

Parameters:

host - the host value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withParameters

public SnowflakeV2LinkedService withParameters(Map<String,ParameterSpecification> parameters)

Set the parameters property: Parameters for linked service.

Overrides:

SnowflakeV2LinkedService.withParameters(Map<String,ParameterSpecification> parameters)

Parameters:

parameters

withPassword

public SnowflakeV2LinkedService withPassword(SecretBase password)

Set the password property: The Azure key vault secret reference of password in connection string.

Parameters:

password - the password value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withPrivateKey

public SnowflakeV2LinkedService withPrivateKey(SecretBase privateKey)

Set the privateKey property: The Azure key vault secret reference of privateKey for KeyPair auth.

Parameters:

privateKey - the privateKey value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withPrivateKeyPassphrase

public SnowflakeV2LinkedService withPrivateKeyPassphrase(SecretBase privateKeyPassphrase)

Set the privateKeyPassphrase property: The Azure key vault secret reference of private key password for KeyPair auth with encrypted private key.

Parameters:

privateKeyPassphrase - the privateKeyPassphrase value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withRole

public SnowflakeV2LinkedService withRole(Object role)

Set the role property: The default access control role to use in the Snowflake session. Type: string (or Expression with resultType string).

Parameters:

role - the role value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withSchema

public SnowflakeV2LinkedService withSchema(Object schema)

Set the schema property: Schema name for connection. Type: string (or Expression with resultType string).

Parameters:

schema - the schema value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withScope

public SnowflakeV2LinkedService withScope(Object scope)

Set the scope property: The scope of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Parameters:

scope - the scope value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withTenantId

public SnowflakeV2LinkedService withTenantId(Object tenantId)

Set the tenantId property: The tenant ID of the application registered in Azure Active Directory for AADServicePrincipal authentication.

Parameters:

tenantId - the tenantId value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withUser

public SnowflakeV2LinkedService withUser(Object user)

Set the user property: The name of the Snowflake user.

Parameters:

user - the user value to set.

Returns:

the SnowflakeV2LinkedService object itself.

withVersion

public SnowflakeV2LinkedService withVersion(String version)

Set the version property: Version of the linked service.

Overrides:

SnowflakeV2LinkedService.withVersion(String version)

Parameters:

version

withWarehouse

public SnowflakeV2LinkedService withWarehouse(Object warehouse)

Set the warehouse property: The name of the Snowflake warehouse.

Parameters:

warehouse - the warehouse value to set.

Returns:

the SnowflakeV2LinkedService object itself.