SamWheating commented on a change in pull request #18945: URL: https://github.com/apache/airflow/pull/18945#discussion_r728442051
########## File path: airflow/providers/google/cloud/operators/dataproc_metastore.py ########## @@ -0,0 +1,1046 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +"""This module contains Google Dataproc Metastore operators.""" + +from time import sleep +from typing import Dict, Optional, Sequence, Tuple, Union + +from google.api_core.retry import Retry, exponential_sleep_generator +from google.cloud.metastore_v1 import MetadataExport, MetadataManagementActivity +from google.cloud.metastore_v1.types import Backup, MetadataImport, Service +from google.cloud.metastore_v1.types.metastore import DatabaseDumpSpec, Restore +from google.protobuf.field_mask_pb2 import FieldMask +from googleapiclient.errors import HttpError + +from airflow import AirflowException +from airflow.models import BaseOperator +from airflow.providers.google.cloud.hooks.dataproc_metastore import DataprocMetastoreHook + + +class DataprocMetastoreCreateBackupOperator(BaseOperator): + """ + Creates a new backup in a given project and location. + + :param project_id: Required. The ID of the Google Cloud project that the service belongs to. + :type project_id: str + :param region: Required. The ID of the Google Cloud region that the service belongs to. + :type region: str + :param service_id: Required. The ID of the metastore service, which is used as the final component of + the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin + with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or + hyphens. + + This corresponds to the ``service_id`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type service_id: str + :param backup: Required. The backup to create. The ``name`` field is ignored. The ID of the created + backup must be provided in the request's ``backup_id`` field. + + This corresponds to the ``backup`` field on the ``request`` instance; if ``request`` is provided, this + should not be set. + :type backup: google.cloud.metastore_v1.types.Backup + :param backup_id: Required. The ID of the backup, which is used as the final component of the backup's + name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or + number, and consist of alpha-numeric ASCII characters or hyphens. + + This corresponds to the ``backup_id`` field on the ``request`` instance; if ``request`` is provided, + this should not be set. + :type backup_id: str + :param request_id: Optional. A unique id used to identify the request. + :type request_id: str + :param retry: Optional. Designation of what errors, if any, should be retried. + :type retry: google.api_core.retry.Retry + :param timeout: Optional. The timeout for this request. + :type timeout: float + :param metadata: Optional. Strings which should be sent along with the request as metadata. + :type metadata: Sequence[Tuple[str, str]] + :param gcp_conn_id: The connection ID to use connecting to Google Cloud. + :type gcp_conn_id: str + :param impersonation_chain: 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). + :type impersonation_chain: Union[str, Sequence[str]] + """ + + template_fields = ( + 'project_id', + 'backup', + 'impersonation_chain', + ) + template_fields_renderers = {'backup': 'json'} + + def __init__( + self, + *, + project_id: str, + region: str, + service_id: str, + backup: Union[Dict, Backup], + backup_id: str, + request_id: Optional[str] = None, + retry: Optional[Retry] = None, + timeout: Optional[float] = None, + metadata: Optional[Sequence[Tuple[str, str]]] = (), + gcp_conn_id: str = "google_cloud_default", + impersonation_chain: Optional[Union[str, Sequence[str]]] = None, + **kwargs, + ) -> None: + super().__init__(**kwargs) + self.project_id = project_id + self.region = region + self.service_id = service_id + self.backup = backup + self.backup_id = backup_id + self.request_id = request_id + self.retry = retry + self.timeout = timeout + self.metadata = metadata + self.gcp_conn_id = gcp_conn_id + self.impersonation_chain = impersonation_chain + + def execute(self, context: dict) -> dict: + hook = DataprocMetastoreHook( + gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.impersonation_chain + ) + self.log.info("Creating Dataproc Metastore backup: %s", self.backup_id) + + try: + operation = hook.create_backup( + project_id=self.project_id, + region=self.region, + service_id=self.service_id, + backup=self.backup, + backup_id=self.backup_id, + request_id=self.request_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + backup = hook.wait_for_operation(operation) + self.log.info("Backup %s created successfully", self.backup_id) + except HttpError as err: + if err.resp.status not in (409, '409'): + raise + self.log.info("Backup %s already exists", self.backup_id) + backup = hook.get_backup( + project_id=self.project_id, + region=self.region, + service_id=self.service_id, + backup_id=self.backup_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + return Backup.to_dict(backup) + + +class DataprocMetastoreCreateMetadataImportOperator(BaseOperator): + """ + Creates a new MetadataImport in a given project and location. + + :param project_id: Required. The ID of the Google Cloud project that the service belongs to. + :type project_id: str + :param region: Required. The ID of the Google Cloud region that the service belongs to. + :type region: str + :param service_id: Required. The ID of the metastore service, which is used as the final component of + the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin + with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or + hyphens. + + This corresponds to the ``service_id`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type service_id: str + :param metadata_import: Required. The metadata import to create. The ``name`` field is ignored. The ID of + the created metadata import must be provided in the request's ``metadata_import_id`` field. + + This corresponds to the ``metadata_import`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type metadata_import: google.cloud.metastore_v1.types.MetadataImport + :param metadata_import_id: Required. The ID of the metadata import, which is used as the final component + of the metadata import's name. This value must be between 1 and 64 characters long, begin with a + letter, end with a letter or number, and consist of alpha-numeric ASCII characters or hyphens. + + This corresponds to the ``metadata_import_id`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type metadata_import_id: str + :param request_id: Optional. A unique id used to identify the request. + :type request_id: str + :param retry: Optional. Designation of what errors, if any, should be retried. + :type retry: google.api_core.retry.Retry + :param timeout: Optional. The timeout for this request. + :type timeout: float + :param metadata: Optional. Strings which should be sent along with the request as metadata. + :type metadata: Sequence[Tuple[str, str]] + :param gcp_conn_id: The connection ID to use connecting to Google Cloud. + :type gcp_conn_id: str + :param impersonation_chain: 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). + :type impersonation_chain: Union[str, Sequence[str]] + """ + + template_fields = ( + 'project_id', + 'metadata_import', + 'impersonation_chain', + ) + template_fields_renderers = {'metadata_import': 'json'} + + def __init__( + self, + *, + project_id: str, + region: str, + service_id: str, + metadata_import: MetadataImport, + metadata_import_id: str, + request_id: Optional[str] = None, + retry: Optional[Retry] = None, + timeout: Optional[float] = None, + metadata: Optional[Sequence[Tuple[str, str]]] = (), + gcp_conn_id: str = "google_cloud_default", + impersonation_chain: Optional[Union[str, Sequence[str]]] = None, + **kwargs, + ) -> None: + super().__init__(**kwargs) + self.project_id = project_id + self.region = region + self.service_id = service_id + self.metadata_import = metadata_import + self.metadata_import_id = metadata_import_id + self.request_id = request_id + self.retry = retry + self.timeout = timeout + self.metadata = metadata + self.gcp_conn_id = gcp_conn_id + self.impersonation_chain = impersonation_chain + + def execute(self, context: dict): + hook = DataprocMetastoreHook( + gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.impersonation_chain + ) + self.log.info("Creating Dataproc Metastore metadata import: %s", self.metadata_import_id) + operation = hook.create_metadata_import( + project_id=self.project_id, + region=self.region, + service_id=self.service_id, + metadata_import=self.metadata_import, + metadata_import_id=self.metadata_import_id, + request_id=self.request_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + metadata_import = hook.wait_for_operation(operation) + self.log.info("Metadata import %s created successfully", self.metadata_import_id) + return metadata_import + + +class DataprocMetastoreCreateServiceOperator(BaseOperator): + """ + Creates a metastore service in a project and location. + + :param region: Required. The ID of the Google Cloud region that the service belongs to. + :type region: str + :param project_id: Required. The ID of the Google Cloud project that the service belongs to. + :type project_id: str + :param service: Required. The Metastore service to create. The ``name`` field is ignored. The ID of + the created metastore service must be provided in the request's ``service_id`` field. + + This corresponds to the ``service`` field on the ``request`` instance; if ``request`` is provided, + this should not be set. + :type service: google.cloud.metastore_v1.types.Service + :param service_id: Required. The ID of the metastore service, which is used as the final component of + the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin + with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or + hyphens. + + This corresponds to the ``service_id`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type service_id: str + :param request_id: Optional. A unique id used to identify the request. + :type request_id: str + :param retry: Designation of what errors, if any, should be retried. + :type retry: google.api_core.retry.Retry + :param timeout: The timeout for this request. + :type timeout: float + :param metadata: Strings which should be sent along with the request as metadata. + :type metadata: Sequence[Tuple[str, str]] + :param gcp_conn_id: The connection ID to use connecting to Google Cloud. + :type gcp_conn_id: str + :param impersonation_chain: 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). + :type impersonation_chain: Union[str, Sequence[str]] + """ + + template_fields = ( + 'project_id', + 'service', + 'impersonation_chain', + ) + template_fields_renderers = {'service': 'json'} + + def __init__( + self, + *, + region: str, + project_id: str, + service: Optional[Union[Dict, Service]] = None, + service_id: str, + request_id: Optional[str] = None, + retry: Optional[Retry] = None, + timeout: Optional[float] = None, + metadata: Optional[Sequence[Tuple[str, str]]] = (), + gcp_conn_id: str = "google_cloud_default", + impersonation_chain: Optional[Union[str, Sequence[str]]] = None, + **kwargs, + ) -> None: + super().__init__(**kwargs) + self.region = region + self.project_id = project_id + self.service = service + self.service_id = service_id + self.request_id = request_id + self.retry = retry + self.timeout = timeout + self.metadata = metadata + self.gcp_conn_id = gcp_conn_id + self.impersonation_chain = impersonation_chain + + def execute(self, context) -> dict: + hook = DataprocMetastoreHook( + gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.impersonation_chain + ) + self.log.info("Creating Dataproc Metastore service: %s", self.project_id) + try: + operation = hook.create_service( + region=self.region, + project_id=self.project_id, + service=self.service, + service_id=self.service_id, + request_id=self.request_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + service = hook.wait_for_operation(operation) + self.log.info("Service %s created successfully", self.service_id) + except HttpError as err: + if err.resp.status not in (409, '409'): + raise + self.log.info("Instance %s already exists", self.service_id) + service = hook.get_service( + region=self.region, + project_id=self.project_id, + service_id=self.service_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + return Service.to_dict(service) + + +class DataprocMetastoreDeleteBackupOperator(BaseOperator): + """ + Deletes a single backup. + + :param project_id: Required. The ID of the Google Cloud project that the backup belongs to. + :type project_id: str + :param region: Required. The ID of the Google Cloud region that the backup belongs to. + :type region: str + :param service_id: Required. The ID of the metastore service, which is used as the final component of + the metastore service's name. This value must be between 2 and 63 characters long inclusive, begin + with a letter, end with a letter or number, and consist of alpha-numeric ASCII characters or + hyphens. + + This corresponds to the ``service_id`` field on the ``request`` instance; if ``request`` is + provided, this should not be set. + :type service_id: str + :param backup_id: Required. The ID of the backup, which is used as the final component of the backup's + name. This value must be between 1 and 64 characters long, begin with a letter, end with a letter or + number, and consist of alpha-numeric ASCII characters or hyphens. + + This corresponds to the ``backup_id`` field on the ``request`` instance; if ``request`` is provided, + this should not be set. + :type backup_id: str + :param request_id: Optional. A unique id used to identify the request. + :type request_id: str + :param retry: Optional. Designation of what errors, if any, should be retried. + :type retry: google.api_core.retry.Retry + :param timeout: Optional. The timeout for this request. + :type timeout: float + :param metadata: Optional. Strings which should be sent along with the request as metadata. + :type metadata: Sequence[Tuple[str, str]] + :param gcp_conn_id: The connection ID to use connecting to Google Cloud. + :type gcp_conn_id: str + :param impersonation_chain: 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). + :type impersonation_chain: Union[str, Sequence[str]] + """ + + template_fields = ( + 'project_id', + 'impersonation_chain', + ) + + def __init__( + self, + *, + project_id: str, + region: str, + service_id: str, + backup_id: str, + request_id: Optional[str] = None, + retry: Optional[Retry] = None, + timeout: Optional[float] = None, + metadata: Optional[Sequence[Tuple[str, str]]] = (), + gcp_conn_id: str = "google_cloud_default", + impersonation_chain: Optional[Union[str, Sequence[str]]] = None, + **kwargs, + ) -> None: + super().__init__(**kwargs) + self.project_id = project_id + self.region = region + self.service_id = service_id + self.backup_id = backup_id + self.request_id = request_id + self.retry = retry + self.timeout = timeout + self.metadata = metadata + self.gcp_conn_id = gcp_conn_id + self.impersonation_chain = impersonation_chain + + def execute(self, context: dict) -> None: + hook = DataprocMetastoreHook( + gcp_conn_id=self.gcp_conn_id, impersonation_chain=self.impersonation_chain + ) + self.log.info("Deleting Dataproc Metastore backup: %s", self.backup_id) + operation = hook.delete_backup( + project_id=self.project_id, + region=self.region, + service_id=self.service_id, + backup_id=self.backup_id, + request_id=self.request_id, + retry=self.retry, + timeout=self.timeout, + metadata=self.metadata, + ) + hook.wait_for_operation(operation) + self.log.info("Backup %s deleted successfully", self.project_id) + + +class DataprocMetastoreDeleteServiceOperator(BaseOperator): + """ + Deletes a single service. + + :param request: The request object. Request message for + [DataprocMetastore.DeleteService][google.cloud.metastore.v1.DataprocMetastore.DeleteService]. + :type request: google.cloud.metastore_v1.types.DeleteServiceRequest + :param project_id: TODO: Fill description Review comment: ```suggestion :param project_id: Required. The ID of the Google Cloud project that the service belongs to. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: commits-unsubscr...@airflow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
