BigQueryOptions(
credentials: typing.Optional[google.auth.credentials.Credentials] = None,
project: typing.Optional[str] = None,
location: typing.Optional[str] = None,
bq_connection: typing.Optional[str] = None,
use_regional_endpoints: bool = False,
application_name: typing.Optional[str] = None,
kms_key_name: typing.Optional[str] = None,
)Encapsulates configuration for working with a session.
Properties
application_name
The application name to amend to the user-agent sent to Google APIs.
Recommended format is "appplication-name/major.minor.patch_version"
or "(gpn:PartnerName;)" for official Google partners.
bq_connection
Name of the BigQuery connection to use. Should be of the form <PROJECT_NUMBER/PROJECT_ID>.
You should either have the connection already created in the
location you have chosen, or you should have the Project IAM
Admin role to enable the service to create the connection for you if you
need it.
If this option isn't provided, or project or location aren't provided, session will use its default project/location/connection_id as default connection.
credentials
The OAuth2 Credentials to use for this client.
kms_key_name
Customer managed encryption key used to control encryption of the data-at-rest in BigQuery. This is of the format projects/PROJECT_ID/locations/LOCATION/keyRings/KEYRING/cryptoKeys/KEY
See https://cloud.google.com/bigquery/docs/customer-managed-encryption for more details.
Please make sure the project used for Bigquery DataFrames has "Cloud KMS CryptoKey Encrypter/Decrypter" role in the key's project, See https://cloud.google.com/bigquery/docs/customer-managed-encryption#assign_role for steps on how to ensure that.
location
Default location for job, datasets, and tables.
project
Google Cloud project ID to use for billing and as the default project.
use_regional_endpoints
Flag to connect to regional API endpoints.
Requires location to also be set. For example, set
location='asia-northeast1' and use_regional_endpoints=True to
connect to asia-northeast1-bigquery.googleapis.com.