• Home
• airflow.providers.google
• airflow.providers.google.common
• airflow.providers.google.common.hooks
• airflow.providers.google.common.hooks.base_google

airflow.providers.google.common.hooks.base_google

This module contains a Google Cloud API base hook.

Module Contents

Classes

retry_if_temporary_quota	Retries if there was an exception for exceeding the temporary quote limit.
retry_if_operation_in_progress	Retries if there was an exception in case of operation in progress.
retry_if_temporary_refresh_credentials	Retries if there was an exception for refreshing credentials.
GoogleBaseHook	A base hook for Google cloud-related hooks.
GoogleBaseAsyncHook	GoogleBaseAsyncHook inherits from BaseHook class, run on the trigger worker.

Functions

is_soft_quota_exception(exception)	Check for quota violation errors.
is_operation_in_progress_exception(exception)	Handle operation in-progress exceptions.
is_refresh_credentials_exception(exception)	Handle refresh credentials exceptions.
get_field(extras, field_name)	Get field from extra, first checking short name, then for backcompat we check for prefixed name.

Attributes

log
INVALID_KEYS
INVALID_REASONS
PROVIDE_PROJECT_ID
T
RT

airflow.providers.google.common.hooks.base_google.log

airflow.providers.google.common.hooks.base_google.INVALID_KEYS = ['DefaultRequestsPerMinutePerProject', 'DefaultRequestsPerMinutePerUser',...

airflow.providers.google.common.hooks.base_google.INVALID_REASONS = ['userRateLimitExceeded']

airflow.providers.google.common.hooks.base_google.is_soft_quota_exception(exception)

Check for quota violation errors.

API for Google services does not have a standardized way to report quota violation errors.

The function has been adapted by trial and error to the following services: * Google Translate * Google Vision * Google Text-to-Speech * Google Speech-to-Text * Google Natural Language * Google Video Intelligence

airflow.providers.google.common.hooks.base_google.is_operation_in_progress_exception(exception)

Handle operation in-progress exceptions.

Some calls return 429 (too many requests!) or 409 errors (Conflict) in case of operation in progress.

• Google Cloud SQL

airflow.providers.google.common.hooks.base_google.is_refresh_credentials_exception(exception)

Handle refresh credentials exceptions.

Some calls return 502 (server error) in case a new token cannot be obtained.

• Google BigQuery

class airflow.providers.google.common.hooks.base_google.retry_if_temporary_quota

Bases: tenacity.retry_if_exception

Retries if there was an exception for exceeding the temporary quote limit.

class airflow.providers.google.common.hooks.base_google.retry_if_operation_in_progress

Bases: tenacity.retry_if_exception

Retries if there was an exception in case of operation in progress.

class airflow.providers.google.common.hooks.base_google.retry_if_temporary_refresh_credentials

Bases: tenacity.retry_if_exception

Retries if there was an exception for refreshing credentials.

airflow.providers.google.common.hooks.base_google.PROVIDE_PROJECT_ID: str

airflow.providers.google.common.hooks.base_google.T

airflow.providers.google.common.hooks.base_google.RT

airflow.providers.google.common.hooks.base_google.get_field(extras, field_name)

Get field from extra, first checking short name, then for backcompat we check for prefixed name.

class airflow.providers.google.common.hooks.base_google.GoogleBaseHook(gcp_conn_id='google_cloud_default', delegate_to=None, impersonation_chain=None)

Bases: airflow.hooks.base.BaseHook

A base hook for Google cloud-related hooks.

Google cloud has a shared REST API client that is built in the same way no matter which service you use. This class helps construct and authorize the credentials needed to then call googleapiclient.discovery.build() to actually discover and build a client for a Google cloud service.

The class also contains some miscellaneous helper functions.

All hook derived from this base hook use the ‘Google Cloud’ connection type. Three ways of authentication are supported:

Default credentials: Only the ‘Project Id’ is required. You’ll need to have set up default credentials, such as by the GOOGLE_APPLICATION_DEFAULT environment variable or from the metadata server on Google Compute Engine.

JSON key file: Specify ‘Project Id’, ‘Keyfile Path’ and ‘Scope’.

Legacy P12 key files are not supported.

JSON data provided in the UI: Specify ‘Keyfile JSON’.

Parameters

• gcp_conn_id (str) – The connection ID to use when fetching connection info.

• delegate_to (str | None) – The account to impersonate using domain-wide delegation of authority, if any. For this to work, the service account making the request must have domain-wide delegation enabled. The usage of this parameter should be limited only to Google Workspace (gsuite) and marketing platform operators and hooks. It is deprecated for usage by Google Cloud and Firebase operators and hooks, as well as transfer operators in other providers that involve Google cloud.

• impersonation_chain (str | Sequence[str] | None) – Optional service account to impersonate using short-term credentials, or chained list of accounts required to get the access_token of the last account in the list, which will be impersonated in the request. If set as a string, the account must grant the originating account the Service Account Token Creator IAM role. If set as a sequence, the identities from the list must grant Service Account Token Creator IAM role to the directly preceding identity, with first account from the list granting this role to the originating account.

property project_id: str

Returns project id.

Returns

id of the project

Return type

str

property num_retries: int

Returns num_retries from Connection.

Returns

the number of times each API request should be retried

Return type

int

property client_info: google.api_core.gapic_v1.client_info.ClientInfo

Return client information used to generate a user-agent for API calls.

It allows for better errors tracking.

This object is only used by the google-cloud-* libraries that are built specifically for the Google Cloud. It is not supported by The Google APIs Python Client that use Discovery based APIs.

property scopes: Sequence[str]

Return OAuth 2.0 scopes.

Returns

Returns the scope defined in the connection configuration, or the default scope

Return type

Sequence[str]

conn_name_attr = 'gcp_conn_id'

default_conn_name = 'google_cloud_default'

conn_type = 'google_cloud_platform'

hook_name = 'Google Cloud'

classmethod get_connection_form_widgets()

Return connection widgets to add to connection form.

classmethod get_ui_field_behaviour()

Return custom field behaviour.

get_credentials_and_project_id()

Return the Credentials object for Google API and the associated project_id.

get_credentials()

Return the Credentials object for Google API.

static quota_retry(*args, **kwargs)

Provide a mechanism to repeat requests in response to exceeding a temporary quota limit.

static operation_in_progress_retry(*args, **kwargs)

Provide a mechanism to repeat requests in response to operation in progress (HTTP 409) limit.

static refresh_credentials_retry(*args, **kwargs)

Provide a mechanism to repeat requests in response to a temporary refresh credential issue.

static fallback_to_default_project_id(func)

Provide fallback for Google Cloud project id. To be used as a decorator.

If the project is None it will be replaced with the project_id from the service account the Hook is authenticated with. Project id can be specified either via project_id kwarg or via first parameter in positional args.

Parameters

func (Callable[Ellipsis, RT]) – function to wrap

Returns

result of the function call

Return type

Callable[Ellipsis, RT]

static provide_gcp_credential_file(func)

Provide a Google Cloud credentials for Application Default Credentials (ADC) strategy support.

It is recommended to use provide_gcp_credential_file_as_context context manager to limit the scope when authorization data is available. Using context manager also makes it easier to use multiple connection in one function.

provide_gcp_credential_file_as_context()

Provide a Google Cloud credentials for Application Default Credentials (ADC) strategy support.

See:

Application Default Credentials (ADC) strategy.

It can be used to provide credentials for external programs (e.g. gcloud) that expect authorization file in GOOGLE_APPLICATION_CREDENTIALS environment variable.

provide_authorized_gcloud()

Provide a separate gcloud configuration with current credentials.

The gcloud tool allows you to login to Google Cloud only - gcloud auth login and for the needs of Application Default Credentials gcloud auth application-default login. In our case, we want all commands to use only the credentials from ADCm so we need to configure the credentials in gcloud manually.

static download_content_from_request(file_handle, request, chunk_size)

Download media resources.

Note that the Python file object is compatible with io.Base and can be used with this class also.

Parameters

• file_handle – io.Base or file object. The stream in which to write the downloaded bytes.

• request (dict) – googleapiclient.http.HttpRequest, the media request to perform in chunks.

• chunk_size (int) – int, File will be downloaded in chunks of this many bytes.

test_connection()

Test the Google cloud connectivity from UI.

class airflow.providers.google.common.hooks.base_google.GoogleBaseAsyncHook(**kwargs)

Bases: airflow.hooks.base.BaseHook

GoogleBaseAsyncHook inherits from BaseHook class, run on the trigger worker.

sync_hook_class: Any

async get_sync_hook()

Sync version of the Google Cloud Hook makes blocking calls in __init__; don’t inherit it.

async get_token(*, session=None)

Return a Token instance for use in [gcloud-aio](https://talkiq.github.io/gcloud-aio/) clients.

async service_file_as_context()

Provide a Google Cloud credentials for Application Default Credentials (ADC) strategy support.

This is the async equivalent of the non-async GoogleBaseHook’s provide_gcp_credential_file_as_context method.

Previous Next

Was this entry helpful?