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 Platform’ 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_DEFAULTenvironment 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’.
A private inner class for keeping all decorator methods.
Function decorator that provides a GOOGLE_APPLICATION_CREDENTIALS environment variable, pointing to file path of a JSON file of service account key.
Returns num_retries from Connection.
the number of times each API request should be retried
- Return type
Returns the Credentials object for Google API
Returns a valid access token from Google API Credentials
Returns an authorized HTTP object to be used to build a Google cloud service hook connection.
_get_field(self, f, default=None)¶
Fetches a field from extras, and returns it. This is some Airflow magic. The google_cloud_platform hook type adds custom UI elements to the hook page, which allow admins to specify service_account, key_path, etc. They get formatted as shown below.
Function decorator that intercepts HTTP Errors and raises AirflowException with more informative message.
Decorator that provides fallback for Google Cloud Platform project id. 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.
func – function to wrap
result of the function call