As of January 1, 2020 this library no longer supports Python 2 on the latest released version. Library versions released prior to that date will continue to be available. For more information please visit Python 2 support on Google Cloud.

Types for Google Cloud Bigquery Connection v1 API¶

class google.cloud.bigquery_connection_v1.types.AwsAccessRole(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Authentication method for Amazon Web Services (AWS) that uses Google owned Google service account to assume into customer’s AWS IAM Role.

iam_role_id¶

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Type: str

identity¶

A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user’s AWS IAM Role.

Type: str

class google.cloud.bigquery_connection_v1.types.AwsCrossAccountRole(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Authentication method for Amazon Web Services (AWS) that uses Google owned AWS IAM user’s access key to assume into customer’s AWS IAM Role.

iam_role_id¶

The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection.

Type: str

iam_user_id¶

Output only. Google-owned AWS IAM User for a Connection.

Type: str

external_id¶

Output only. A Google-generated id for representing Connection’s identity in AWS. External Id is also used for preventing the Confused Deputy Problem. See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html

Type: str

class google.cloud.bigquery_connection_v1.types.AwsProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Connection properties specific to Amazon Web Services (AWS).

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

cross_account_role¶

Authentication using Google owned AWS IAM user’s access key to assume into customer’s AWS IAM Role. Deprecated, do not use.

This field is a member of oneof authentication_method.

Type: google.cloud.bigquery_connection_v1.types.AwsCrossAccountRole

access_role¶

Authentication using Google owned service account to assume into customer’s AWS IAM Role.

This field is a member of oneof authentication_method.

Type: google.cloud.bigquery_connection_v1.types.AwsAccessRole

class google.cloud.bigquery_connection_v1.types.AzureProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Container for connection properties specific to Azure.

application¶

Output only. The name of the Azure Active Directory Application.

Type: str

client_id¶

Output only. The client id of the Azure Active Directory Application.

Type: str

object_id¶

Output only. The object id of the Azure Active Directory Application.

Type: str

customer_tenant_id¶

The id of customer’s directory that host the data.

Type: str

redirect_uri¶

The URL user will be redirected to after granting consent during connection setup.

Type: str

federated_application_client_id¶

The client ID of the user’s Azure Active Directory Application used for a federated connection.

Type: str

identity¶

Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user’s Azure Active Directory Application.

Type: str

class google.cloud.bigquery_connection_v1.types.CloudResourceProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Container for connection properties for delegation of access to GCP resources.

service_account_id¶

Output only. The account ID of the service created for the purpose of this connection.

The service account does not have any permissions associated with it when it is created. After creation, customers delegate permissions to the service account. When the connection is used in the context of an operation in BigQuery, the service account will be used to connect to the desired resources in GCP.

The account ID is in the form of:

<service-1234>@gcp-sa-bigquery-cloudresource.iam.gserviceaccount.com

Type: str

class google.cloud.bigquery_connection_v1.types.CloudSpannerProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Connection properties specific to Cloud Spanner.

database¶

Cloud Spanner database in the form `project/instance/database’

Type: str

use_parallelism¶

If parallelism should be used when reading from Cloud Spanner

Type: bool

max_parallelism¶

Allows setting max parallelism per query when executing on Spanner independent compute resources. If unspecified, default values of parallelism are chosen that are dependent on the Cloud Spanner instance configuration.

REQUIRES: use_parallelism must be set. REQUIRES: Either use_data_boost or use_serverless_analytics must be set.

Type: int

use_serverless_analytics¶

If the serverless analytics service should be used to read data from Cloud Spanner. Note: use_parallelism must be set when using serverless analytics.

Type: bool

use_data_boost¶

If set, the request will be executed via Spanner independent compute resources. REQUIRES: use_parallelism must be set.

NOTE: use_serverless_analytics will be deprecated. Prefer use_data_boost over use_serverless_analytics.

Type: bool

database_role¶

Optional. Cloud Spanner database role for fine-grained access control. The Cloud Spanner admin should have provisioned the database role with appropriate permissions, such as SELECT and INSERT. Other users should only use roles provided by their Cloud Spanner admins.

For more details, see [About fine-grained access control] (https://cloud.google.com/spanner/docs/fgac-about).

REQUIRES: The database role name must start with a letter, and can only contain letters, numbers, and underscores.

Type: str

class google.cloud.bigquery_connection_v1.types.CloudSqlCredential(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Credential info for the Cloud SQL.

username¶

The username for the credential.

Type: str

password¶

The password for the credential.

Type: str

class google.cloud.bigquery_connection_v1.types.CloudSqlProperties(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Connection properties specific to the Cloud SQL.

instance_id¶

Cloud SQL instance ID in the form project:location:instance.

Type: str

database¶

Database name.

Type: str

type_¶

Type of the Cloud SQL database.

Type: google.cloud.bigquery_connection_v1.types.CloudSqlProperties.DatabaseType

credential¶

Input only. Cloud SQL credential.

Type: google.cloud.bigquery_connection_v1.types.CloudSqlCredential

service_account_id¶

Output only. The account ID of the service used for the purpose of this connection.

When the connection is used in the context of an operation in BigQuery, this service account will serve as the identity being used for connecting to the CloudSQL instance specified in this connection.

Type: str

class DatabaseType(value)[source]¶

Bases: proto.enums.Enum

Supported Cloud SQL database types.

Values:

DATABASE_TYPE_UNSPECIFIED (0):: Unspecified database type.
POSTGRES (1):: Cloud SQL for PostgreSQL.
MYSQL (2):: Cloud SQL for MySQL.

class google.cloud.bigquery_connection_v1.types.Connection(mapping=None, *, ignore_unknown_fields=False, **kwargs)[source]¶

Bases: proto.message.Message

Configuration parameters to establish connection with an external data source, except the credential attributes.

This message has oneof fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

name¶

The resource name of the connection in the form of: projects/{project_id}/locations/{location_id}/connections/{connection_id}

Type: str

friendly_name¶

User provided display name for the connection.

Type: str

description¶

User provided description.

Type: str

cloud_sql¶

Cloud SQL properties.