add lifecycle

Author: zhuxiaolong37

alibabacloud_oss_v2/__init__.py

@@ -20,6 +20,7 @@
 from .models.bucket_access_monitor import *
 from .models.bucket_archive_direct_read import *
 from .models.bucket_cname import *
+from .models.bucket_lifecycle import *
 from .models.bucket_cors import *
 from .models.bucket_encryption import *
 from .models.bucket_logging import *

alibabacloud_oss_v2/client.py

@@ -1129,6 +1129,45 @@ def delete_cname(self, request: models.DeleteCnameRequest, **kwargs
         """
         return operations.delete_cname(self._client, request, **kwargs)
 
+    # bucket lifecycle
+    def put_bucket_lifecycle(self, request: models.PutBucketLifecycleRequest, **kwargs
+                             ) -> models.PutBucketLifecycleResult:
+        """
+        Configures a lifecycle rule for a bucket. After you configure a lifecycle rule for a bucket, Object Storage Service (OSS) automatically deletes the objects that match the rule or converts the storage type of the objects based on the point in time that is specified in the lifecycle rule.
+
+        Args:
+            request (PutBucketLifecycleRequest): Request parameters for PutBucketLifecycle operation.
+
+        Returns:
+            PutBucketLifecycleResult: Response result for PutBucketLifecycle operation.
+        """
+        return operations.put_bucket_lifecycle(self._client, request, **kwargs)
+
+    def get_bucket_lifecycle(self, request: models.GetBucketLifecycleRequest, **kwargs
+                             ) -> models.GetBucketLifecycleResult:
+        """
+        Queries the lifecycle rules configured for a bucket. Only the owner of a bucket has the permissions to query the lifecycle rules configured for the bucket.
+
+        Args:
+            request (GetBucketLifecycleRequest): Request parameters for GetBucketLifecycle operation.
+
+        Returns:
+            GetBucketLifecycleResult: Response result for GetBucketLifecycle operation.
+        """
+        return operations.get_bucket_lifecycle(self._client, request, **kwargs)
+
+    def delete_bucket_lifecycle(self, request: models.DeleteBucketLifecycleRequest, **kwargs
+                                ) -> models.DeleteBucketLifecycleResult:
+        """
+        Deletes the lifecycle rules of a bucket.
+
+        Args:
+            request (DeleteBucketLifecycleRequest): Request parameters for DeleteBucketLifecycle operation.
+
+        Returns:
+            DeleteBucketLifecycleResult: Response result for DeleteBucketLifecycle operation.
+        """
+        return operations.delete_bucket_lifecycle(self._client, request, **kwargs)
 
     # bucket cors
     def put_bucket_cors(self, request: models.PutBucketCorsRequest, **kwargs

alibabacloud_oss_v2/models/__init__.py

@@ -8,6 +8,7 @@
 from .bucket_access_monitor import *
 from .bucket_archive_direct_read import *
 from .bucket_cname import *
+from .bucket_lifecycle import *
 from .bucket_cors import *
 from .bucket_logging import *
 from .bucket_encryption import *

alibabacloud_oss_v2/models/bucket_lifecycle.py

@@ -0,0 +1,32 @@
+
+from typing import Optional, Any
+from .. import serde
+
+class Tag(serde.Model):
+    """
+    The container used to store the tag that you want to configure.
+    """
+
+    _attribute_map = {
+        'key': {'tag': 'xml', 'rename': 'Key', 'type': 'str'},
+        'value': {'tag': 'xml', 'rename': 'Value', 'type': 'str'},
+    }
+
+    _xml_map = {
+        'name': 'Tag'
+    }
+
+    def __init__(
+        self,
+        key: Optional[str] = None,
+        value: Optional[str] = None,
+        **kwargs: Any
+    ) -> None:
+        """
+        key (str, optional): The key of a tag. *   A tag key can be up to 64 bytes in length.*   A tag key cannot start with `http://`, `https://`, or `Aliyun`.*   A tag key must be UTF-8 encoded.*   A tag key cannot be left empty.
+        value (str, optional): The value of the tag that you want to add or modify. *   A tag value can be up to 128 bytes in length.*   A tag value must be UTF-8 encoded.*   The tag value can be left empty.
+        """
+        super().__init__(**kwargs)
+        self.key = key
+        self.value = value
+

alibabacloud_oss_v2/models/structs.py

@@ -7,6 +7,7 @@
 from .bucket_access_monitor import *
 from .bucket_archive_direct_read import *
 from .bucket_cname import *
+from .bucket_lifecycle import *
 from .bucket_cors import *
 from .bucket_logging import *
 from .bucket_encryption import *

alibabacloud_oss_v2/operations/__init__.py

@@ -0,0 +1,131 @@
+# pylint: disable=line-too-long
+
+from ..types import OperationInput, CaseInsensitiveDict
+from .. import serde
+from .. import serde_utils
+from .. import models
+from .._client import _SyncClientImpl
+
+
+def put_bucket_lifecycle(client: _SyncClientImpl, request: models.PutBucketLifecycleRequest, **kwargs) -> models.PutBucketLifecycleResult:
+    """
+    put_bucket_lifecycle synchronously
+
+    Args:
+        client (_SyncClientImpl): A agent that sends the request.
+        request (PutBucketLifecycleRequest): The request for the PutBucketLifecycle operation.
+
+    Returns:
+        PutBucketLifecycleResult: The result for the PutBucketLifecycle operation.
+    """
+
+    op_input = serde.serialize_input(
+        request=request,
+        op_input=OperationInput(
+            op_name='PutBucketLifecycle',
+            method='PUT',
+            headers=CaseInsensitiveDict({
+                'Content-Type': 'application/xml',
+            }),
+            parameters={ 
+                'lifecycle': '', 
+            },
+            bucket=request.bucket,
+            op_metadata={'sub-resource': ['lifecycle']},
+        ),
+        custom_serializer=[
+            serde_utils.add_content_md5
+        ]
+    )
+
+    op_output = client.invoke_operation(op_input, **kwargs)
+
+    return serde.deserialize_output(
+        result=models.PutBucketLifecycleResult(),
+        op_output=op_output,
+        custom_deserializer=[
+            serde.deserialize_output_xmlbody
+        ],
+    )
+
+def get_bucket_lifecycle(client: _SyncClientImpl, request: models.GetBucketLifecycleRequest, **kwargs) -> models.GetBucketLifecycleResult:
+    """
+    get_bucket_lifecycle synchronously
+
+    Args:
+        client (_SyncClientImpl): A agent that sends the request.
+        request (GetBucketLifecycleRequest): The request for the GetBucketLifecycle operation.
+
+    Returns:
+        GetBucketLifecycleResult: The result for the GetBucketLifecycle operation.
+    """
+
+    op_input = serde.serialize_input(
+        request=request,
+        op_input=OperationInput(
+            op_name='GetBucketLifecycle',
+            method='GET',
+            headers=CaseInsensitiveDict({
+                'Content-Type': 'application/xml',
+            }),
+            parameters={ 
+                'lifecycle': '', 
+            },
+            bucket=request.bucket,
+            op_metadata={'sub-resource': ['lifecycle']},
+        ),
+        custom_serializer=[
+            serde_utils.add_content_md5
+        ]
+    )
+
+    op_output = client.invoke_operation(op_input, **kwargs)
+
+    return serde.deserialize_output(
+        result=models.GetBucketLifecycleResult(),
+        op_output=op_output,
+        custom_deserializer=[
+            serde.deserialize_output_xmlbody
+        ],
+    )
+
+def delete_bucket_lifecycle(client: _SyncClientImpl, request: models.DeleteBucketLifecycleRequest, **kwargs) -> models.DeleteBucketLifecycleResult:
+    """
+    delete_bucket_lifecycle synchronously
+
+    Args:
+        client (_SyncClientImpl): A agent that sends the request.
+        request (DeleteBucketLifecycleRequest): The request for the DeleteBucketLifecycle operation.
+
+    Returns:
+        DeleteBucketLifecycleResult: The result for the DeleteBucketLifecycle operation.
+    """
+
+    op_input = serde.serialize_input(
+        request=request,
+        op_input=OperationInput(
+            op_name='DeleteBucketLifecycle',
+            method='DELETE',
+            headers=CaseInsensitiveDict({
+                'Content-Type': 'application/xml',
+            }),
+            parameters={ 
+                'lifecycle': '', 
+            },
+            bucket=request.bucket,
+            op_metadata={'sub-resource': ['lifecycle']},
+        ),
+        custom_serializer=[
+            serde_utils.add_content_md5
+        ]
+    )
+
+    op_output = client.invoke_operation(op_input, **kwargs)
+
+    return serde.deserialize_output(
+        result=models.DeleteBucketLifecycleResult(),
+        op_output=op_output,
+        custom_deserializer=[
+            serde.deserialize_output_xmlbody
+        ],
+    )

alibabacloud_oss_v2/operations/bucket_lifecycle.py

@@ -13,6 +13,7 @@
 
 ISO8601 = '%Y-%m-%dT%H:%M:%SZ'
 ISO8601_MICRO = '%Y-%m-%dT%H:%M:%S.%fZ'
+ISO8601_DATE = '%Y-%m-%dT00:00:00.000Z'
 
 class Model:
     """Mixin for all client request body/response body models to support
@@ -130,6 +131,23 @@ def serialize_isotime(value: datetime.datetime) -> str:
         return value.strftime(ISO8601)
 
 
+def serialize_iso_date(value: datetime.datetime) -> str:
+    """Serialize Date object into ISO-8601 formatted string
+
+    Args:
+        value (datetime.datetime): value to be serialized
+
+    Returns:
+        str: ISO-8601 formatted string, eg 2014-05-15T00:00:00.000Z
+    """
+
+    try:
+        return value.strftime(ISO8601_DATE)
+
+    except ValueError:
+        return value.strftime(ISO8601)
+
+
 def serialize_httptime(value: datetime.datetime) -> str:
     """Serialize Datetime object into http time formatted string
 
@@ -249,6 +267,8 @@ def _serialize_xml_any(tag: str, value: Any, atype: str) -> ET.Element:
             child.text = serialize_httptime(value)
         elif 'unixtime' in atypes:
             child.text = serialize_unixtime(value)
+        elif 'ios8601date' in atypes:
+            child.text = serialize_iso_date(value)
         else:
             child.text = serialize_isotime(value)
         return child

alibabacloud_oss_v2/serde.py

@@ -0,0 +1,36 @@
+import argparse
+import alibabacloud_oss_v2 as oss
+
+parser = argparse.ArgumentParser(description="delete bucket lifecycle sample")
+parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
+parser.add_argument('--bucket', help='The name of the bucket.', required=True)
+parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
+
+
+def main():
+
+    args = parser.parse_args()
+
+    # Loading credentials values from the environment variables
+    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
+
+    # Using the SDK's default configuration
+    cfg = oss.config.load_default()
+    cfg.credentials_provider = credentials_provider
+    cfg.region = args.region
+    if args.endpoint is not None:
+        cfg.endpoint = args.endpoint
+
+    client = oss.Client(cfg)
+
+    result = client.delete_bucket_lifecycle(oss.DeleteBucketLifecycleRequest(
+            bucket=args.bucket,
+    ))
+
+    print(f'status code: {result.status_code},'
+            f' request id: {result.request_id},'
+    )
+
+
+if __name__ == "__main__":
+    main()

sample/delete_bucket_lifecycle.py

@@ -0,0 +1,67 @@
+import argparse
+import alibabacloud_oss_v2 as oss
+
+parser = argparse.ArgumentParser(description="get bucket lifecycle sample")
+parser.add_argument('--region', help='The region in which the bucket is located.', required=True)
+parser.add_argument('--bucket', help='The name of the bucket.', required=True)
+parser.add_argument('--endpoint', help='The domain names that other services can use to access OSS')
+
+
+def main():
+
+    args = parser.parse_args()
+
+    # Loading credentials values from the environment variables
+    credentials_provider = oss.credentials.EnvironmentVariableCredentialsProvider()
+
+    # Using the SDK's default configuration
+    cfg = oss.config.load_default()
+    cfg.credentials_provider = credentials_provider
+    cfg.region = args.region
+    if args.endpoint is not None:
+        cfg.endpoint = args.endpoint
+
+    client = oss.Client(cfg)
+
+    result = client.get_bucket_lifecycle(oss.GetBucketLifecycleRequest(
+            bucket=args.bucket,
+    ))
+
+
+    print(f'status code: {result.status_code},'
+            f' request id: {result.request_id},'
+            # f' key: {result.lifecycle_configuration.rules[0].tags[0].key},'
+            # f' value: {result.lifecycle_configuration.rules[0].tags[0].value},'
+            # f' noncurrent days: {result.lifecycle_configuration.rules[0].noncurrent_version_expiration.noncurrent_days},'
+            # f' object size greater than: {result.lifecycle_configuration.rules[0].filter.object_size_greater_than},'
+            # f' object size less than: {result.lifecycle_configuration.rules[0].filter.object_size_less_than},'
+            # f' prefix: {result.lifecycle_configuration.rules[0].filter.filter_not[0].prefix},'
+            # f' key: {result.lifecycle_configuration.rules[0].filter.filter_not[0].tag.key},'
+            # f' value: {result.lifecycle_configuration.rules[0].filter.filter_not[0].tag.value},'
+            # f' id: {result.lifecycle_configuration.rules[0].id},'
+            # f' created before date: {result.lifecycle_configuration.rules[0].expiration.created_before_date},'
+            # f' days: {result.lifecycle_configuration.rules[0].expiration.days},'
+            # f' expired object delete marker: {result.lifecycle_configuration.rules[0].expiration.expired_object_delete_marker},'
+            # f' created before date: {result.lifecycle_configuration.rules[0].transitions[0].created_before_date},'
+            # f' days: {result.lifecycle_configuration.rules[0].transitions[0].days},'
+            # f' is access time: {result.lifecycle_configuration.rules[0].transitions[0].is_access_time},'
+            # f' return to std when visit: {result.lifecycle_configuration.rules[0].transitions[0].return_to_std_when_visit},'
+            # f' allow small file: {result.lifecycle_configuration.rules[0].transitions[0].allow_small_file},'
+            # f' is access time: {result.lifecycle_configuration.rules[0].noncurrent_version_transitions[0].is_access_time},'
+            # f' return to std when visit: {result.lifecycle_configuration.rules[0].noncurrent_version_transitions[0].return_to_std_when_visit},'
+            # f' allow small file: {result.lifecycle_configuration.rules[0].noncurrent_version_transitions[0].allow_small_file},'
+            # f' noncurrent days: {result.lifecycle_configuration.rules[0].noncurrent_version_transitions[0].noncurrent_days},'
+            # f' atime base: {result.lifecycle_configuration.rules[0].atime_base},'
+            # f' prefix: {result.lifecycle_configuration.rules[0].prefix},'
+            # f' status: {result.lifecycle_configuration.rules[0].status},'
+            # f' days: {result.lifecycle_configuration.rules[0].abort_multipart_upload.days},'
+            # f' created before date: {result.lifecycle_configuration.rules[0].abort_multipart_upload.created_before_date},'
+    )
+
+    if result.lifecycle_configuration.rules:
+        for r in result.lifecycle_configuration.rules:
+            print(f'rule: {r}')
+
+
+if __name__ == "__main__":
+    main()