Share via

GoogleBigQueryLinkedService Class

Google BigQuery service linked service.

All required parameters must be populated in order to send to server.

Constructor

GoogleBigQueryLinkedService(*, project: MutableMapping[str, Any], authentication_type: str | _models.GoogleBigQueryAuthenticationType, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, version: str | None = None, connect_via: _models.IntegrationRuntimeReference | None = None, description: str | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, additional_projects: MutableMapping[str, Any] | None = None, request_google_drive_scope: MutableMapping[str, Any] | None = None, refresh_token: _models.SecretBase | None = None, client_id: MutableMapping[str, Any] | None = None, client_secret: _models.SecretBase | None = None, email: MutableMapping[str, Any] | None = None, key_file_path: MutableMapping[str, Any] | None = None, trusted_cert_path: MutableMapping[str, Any] | None = None, use_system_trust_store: MutableMapping[str, Any] | None = None, encrypted_credential: str | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

Default value: None
version
str

Version of the linked service.

Default value: None
connect_via
IntegrationRuntimeReference

The integration runtime reference.

Default value: None
description
str

Linked service description.

Default value: None
parameters
dict[str, ParameterSpecification]

Parameters for linked service.

Default value: None
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.

Default value: None
project
<xref:JSON>

The default BigQuery project to query against. Type: string (or Expression with resultType string). Required.
additional_projects
<xref:JSON>

A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string).

Default value: None
request_google_drive_scope
<xref:JSON>

Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string).

Default value: None
authentication_type
str or GoogleBigQueryAuthenticationType

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Required. Known values are: "ServiceAuthentication" and "UserAuthentication".
refresh_token
SecretBase

The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.

Default value: None
client_id
<xref:JSON>

The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).

Default value: None
client_secret
SecretBase

The client secret of the google application used to acquire the refresh token.

Default value: None
email
<xref:JSON>

The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string).

Default value: None
key_file_path
<xref:JSON>

The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).

Default value: None
trusted_cert_path
<xref:JSON>

The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).

Default value: None
use_system_trust_store
<xref:JSON>

Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean).

Default value: None
encrypted_credential
str

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

Default value: None

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Type of linked service. Required.
version
str

Version of the linked service.
connect_via
IntegrationRuntimeReference

The integration runtime reference.
description
str

Linked service description.
parameters
dict[str, ParameterSpecification]

Parameters for linked service.
annotations
list[<xref:JSON>]

List of tags that can be used for describing the linked service.
project
<xref:JSON>

The default BigQuery project to query against. Type: string (or Expression with resultType string). Required.
additional_projects
<xref:JSON>

A comma-separated list of public BigQuery projects to access. Type: string (or Expression with resultType string).
request_google_drive_scope
<xref:JSON>

Whether to request access to Google Drive. Allowing Google Drive access enables support for federated tables that combine BigQuery data with data from Google Drive. The default value is false. Type: string (or Expression with resultType string).
authentication_type
str or GoogleBigQueryAuthenticationType

The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR. Required. Known values are: "ServiceAuthentication" and "UserAuthentication".
refresh_token
SecretBase

The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.
client_id
<xref:JSON>

The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).
client_secret
SecretBase

The client secret of the google application used to acquire the refresh token.
email
<xref:JSON>

The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
key_file_path
<xref:JSON>

The full path to the .p12 key file that is used to authenticate the service account email address and can only be used on self-hosted IR. Type: string (or Expression with resultType string).
trusted_cert_path
<xref:JSON>

The full path of the .pem file containing trusted CA certificates for verifying the server when connecting over SSL. This property can only be set when using SSL on self-hosted IR. The default value is the cacerts.pem file installed with the IR. Type: string (or Expression with resultType string).
use_system_trust_store
<xref:JSON>

Specifies whether to use a CA certificate from the system trust store or from a specified PEM file. The default value is false.Type: boolean (or Expression with resultType boolean).
encrypted_credential
str

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