airflow.providers.google.cloud.operators.functions

This module contains Google Cloud Functions operators.

Module Contents

airflow.providers.google.cloud.operators.functions._validate_available_memory_in_mb(value)[source]
airflow.providers.google.cloud.operators.functions._validate_max_instances(value)[source]
airflow.providers.google.cloud.operators.functions.CLOUD_FUNCTION_VALIDATION :List[Dict[str, Any]][source]
class airflow.providers.google.cloud.operators.functions.CloudFunctionDeployFunctionOperator(*, location: str, body: Dict, project_id: Optional[str] = None, gcp_conn_id: str = 'google_cloud_default', api_version: str = 'v1', zip_path: Optional[str] = None, validate_body: bool = True, impersonation_chain: Optional[Union[str, Sequence[str]]] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Creates a function in Google Cloud Functions. If a function with this name already exists, it will be updated.

See also

For more information on how to use this operator, take a look at the guide: CloudFunctionDeployFunctionOperator

Parameters

  • location (str) – Google Cloud region where the function should be created.

  • body (dict or google.cloud.functions.v1.CloudFunction) – Body of the Cloud Functions definition. The body must be a Cloud Functions dictionary as described in: https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions . Different API versions require different variants of the Cloud Functions dictionary.

  • project_id (str) – (Optional) Google Cloud project ID where the function should be created.

  • gcp_conn_id (str) – (Optional) The connection ID used to connect to Google Cloud. Default ‘google_cloud_default’.

  • api_version (str) – (Optional) API version used (for example v1 - default - or v1beta1).

  • zip_path (str) – Path to zip file containing source code of the function. If the path is set, the sourceUploadUrl should not be specified in the body or it should be empty. Then the zip file will be uploaded using the upload URL generated via generateUploadUrl from the Cloud Functions API.

  • validate_body (bool) – If set to False, body validation is not performed.

  • impersonation_chain (Union[str, Sequence[str]]) – 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 (templated).

template_fields = ['body', 'project_id', 'location', 'gcp_conn_id', 'api_version', 'impersonation_chain'][source]
_validate_inputs(self)[source]
_validate_all_body_fields(self)[source]
_create_new_function(self, hook)[source]
_update_function(self, hook)[source]
_check_if_function_exists(self, hook)[source]
_upload_source_code(self, hook)[source]
_set_airflow_version_label(self)[source]
execute(self, context)[source]
airflow.providers.google.cloud.operators.functions.GCF_SOURCE_ARCHIVE_URL = sourceArchiveUrl[source]
airflow.providers.google.cloud.operators.functions.GCF_SOURCE_UPLOAD_URL = sourceUploadUrl[source]
airflow.providers.google.cloud.operators.functions.SOURCE_REPOSITORY = sourceRepository[source]
airflow.providers.google.cloud.operators.functions.GCF_ZIP_PATH = zip_path[source]
class airflow.providers.google.cloud.operators.functions.ZipPathPreprocessor(body: dict, zip_path: Optional[str] = None)[source]

Pre-processes zip path parameter.

Responsible for checking if the zip path parameter is correctly specified in relation with source_code body fields. Non empty zip path parameter is special because it is mutually exclusive with sourceArchiveUrl and sourceRepository body fields. It is also mutually exclusive with non-empty sourceUploadUrl. The pre-process modifies sourceUploadUrl body field in special way when zip_path is not empty. An extra step is run when execute method is called and sourceUploadUrl field value is set in the body with the value returned by generateUploadUrl Cloud Function API method.

Parameters

  • body (dict) – Body passed to the create/update method calls.

  • zip_path (str) – (optional) Path to zip file containing source code of the function. If the path is set, the sourceUploadUrl should not be specified in the body or it should be empty. Then the zip file will be uploaded using the upload URL generated via generateUploadUrl from the Cloud Functions API.

upload_function :Optional[bool][source]
static _is_present_and_empty(dictionary, field)[source]
_verify_upload_url_and_no_zip_path(self)[source]
_verify_upload_url_and_zip_path(self)[source]
_verify_archive_url_and_zip_path(self)[source]
should_upload_function(self)[source]

Checks if function source should be uploaded.

Return type

bool

preprocess_body(self)[source]

Modifies sourceUploadUrl body field in special way when zip_path is not empty.

airflow.providers.google.cloud.operators.functions.FUNCTION_NAME_PATTERN = ^projects/[^/]+/locations/[^/]+/functions/[^/]+$[source]
airflow.providers.google.cloud.operators.functions.FUNCTION_NAME_COMPILED_PATTERN[source]
class airflow.providers.google.cloud.operators.functions.CloudFunctionDeleteFunctionOperator(*, name: str, gcp_conn_id: str = 'google_cloud_default', api_version: str = 'v1', impersonation_chain: Optional[Union[str, Sequence[str]]] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Deletes the specified function from Google Cloud Functions.

See also

For more information on how to use this operator, take a look at the guide: CloudFunctionDeleteFunctionOperator

Parameters

  • name (str) – A fully-qualified function name, matching the pattern: ^projects/[^/]+/locations/[^/]+/functions/[^/]+$

  • gcp_conn_id (str) – The connection ID to use to connect to Google Cloud.

  • api_version (str) – API version used (for example v1 or v1beta1).

  • impersonation_chain (Union[str, Sequence[str]]) – 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 (templated).

template_fields = ['name', 'gcp_conn_id', 'api_version', 'impersonation_chain'][source]
_validate_inputs(self)[source]
execute(self, context)[source]
class airflow.providers.google.cloud.operators.functions.CloudFunctionInvokeFunctionOperator(*, function_id: str, input_data: Dict, location: str, project_id: Optional[str] = None, gcp_conn_id: str = 'google_cloud_default', api_version: str = 'v1', impersonation_chain: Optional[Union[str, Sequence[str]]] = None, **kwargs)[source]

Bases: airflow.models.BaseOperator

Invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed.

See also

For more information on how to use this operator, take a look at the guide: CloudFunctionDeployFunctionOperator

Parameters

  • function_id (str) – ID of the function to be called

  • input_data (Dict) – Input to be passed to the function

  • location (str) – The location where the function is located.

  • project_id (str) – Optional, Google Cloud Project project_id where the function belongs. If set to None or missing, the default project_id from the Google Cloud connection is used.

  • impersonation_chain (Union[str, Sequence[str]]) – 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 (templated).

Returns

None

template_fields = ['function_id', 'input_data', 'location', 'project_id', 'impersonation_chain'][source]
execute(self, context: Dict)[source]

Was this entry helpful?