Source code for airflow.providers.alibaba.cloud.operators.oss

#
# 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 Alibaba Cloud OSS operators."""
from __future__ import annotations

from typing import TYPE_CHECKING

from airflow.models import BaseOperator
from airflow.providers.alibaba.cloud.hooks.oss import OSSHook

if TYPE_CHECKING:
    from airflow.utils.context import Context


[docs]class OSSCreateBucketOperator(BaseOperator): """ This operator creates an OSS bucket. :param region: OSS region you want to create bucket :param bucket_name: This is bucket name you want to create :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.create_bucket(bucket_name=self.bucket_name)
[docs]class OSSDeleteBucketOperator(BaseOperator): """ This operator to delete an OSS bucket. :param region: OSS region you want to create bucket :param bucket_name: This is bucket name you want to delete :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.delete_bucket(bucket_name=self.bucket_name)
[docs]class OSSUploadObjectOperator(BaseOperator): """ This operator to upload an file-like object. :param key: the OSS path of the object :param file: local file to upload. :param region: OSS region you want to create bucket :param bucket_name: This is bucket name you want to create :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, key: str, file: str, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.key = key self.file = file self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.upload_local_file(bucket_name=self.bucket_name, key=self.key, file=self.file)
[docs]class OSSDownloadObjectOperator(BaseOperator): """ This operator to Download an OSS object. :param key: key of the object to download. :param local_file: local path + file name to save. :param region: OSS region :param bucket_name: OSS bucket name :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, key: str, file: str, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.key = key self.file = file self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.download_file(bucket_name=self.bucket_name, key=self.key, local_file=self.file)
[docs]class OSSDeleteBatchObjectOperator(BaseOperator): """ This operator to delete OSS objects. :param key: key list of the objects to delete. :param region: OSS region :param bucket_name: OSS bucket name :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, keys: list, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.keys = keys self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.delete_objects(bucket_name=self.bucket_name, key=self.keys)
[docs]class OSSDeleteObjectOperator(BaseOperator): """ This operator to delete an OSS object. :param key: key of the object to delete. :param region: OSS region :param bucket_name: OSS bucket name :param oss_conn_id: The Airflow connection used for OSS credentials. """ def __init__( self, key: str, region: str, bucket_name: str | None = None, oss_conn_id: str = "oss_default", **kwargs, ) -> None: super().__init__(**kwargs) self.key = key self.oss_conn_id = oss_conn_id self.region = region self.bucket_name = bucket_name
[docs] def execute(self, context: Context): oss_hook = OSSHook(oss_conn_id=self.oss_conn_id, region=self.region) oss_hook.delete_object(bucket_name=self.bucket_name, key=self.key)

Was this entry helpful?