google-cloud-storagebatchoperations 0.3.0__tar.gz → 0.5.0__tar.gz

{google_cloud_storagebatchoperations-0.3.0/google_cloud_storagebatchoperations.egg-info → google_cloud_storagebatchoperations-0.5.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-storagebatchoperations
-Version: 0.3.0
+Version: 0.5.0
 Summary: Google Cloud Storagebatchoperations API client library
 Home-page: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-storagebatchoperations
 Author: Google LLC

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations/__init__.py

@@ -29,25 +29,32 @@ from google.cloud.storagebatchoperations_v1.types.storage_batch_operations impor
     CancelJobResponse,
     CreateJobRequest,
     DeleteJobRequest,
+    GetBucketOperationRequest,
     GetJobRequest,
+    ListBucketOperationsRequest,
+    ListBucketOperationsResponse,
     ListJobsRequest,
     ListJobsResponse,
     OperationMetadata,
 )
 from google.cloud.storagebatchoperations_v1.types.storage_batch_operations_types import (
     BucketList,
+    BucketOperation,
     Counters,
+    CustomContextUpdates,
     DeleteObject,
     ErrorLogEntry,
     ErrorSummary,
     Job,
     LoggingConfig,
     Manifest,
+    ObjectCustomContextPayload,
     ObjectRetention,
     PrefixList,
     PutMetadata,
     PutObjectHold,
     RewriteObject,
+    UpdateObjectCustomContext,
 )
 
 __all__ = (
@@ -57,21 +64,28 @@ __all__ = (
     "CancelJobResponse",
     "CreateJobRequest",
     "DeleteJobRequest",
+    "GetBucketOperationRequest",
     "GetJobRequest",
+    "ListBucketOperationsRequest",
+    "ListBucketOperationsResponse",
     "ListJobsRequest",
     "ListJobsResponse",
     "OperationMetadata",
     "BucketList",
+    "BucketOperation",
     "Counters",
+    "CustomContextUpdates",
     "DeleteObject",
     "ErrorLogEntry",
     "ErrorSummary",
     "Job",
     "LoggingConfig",
     "Manifest",
+    "ObjectCustomContextPayload",
     "ObjectRetention",
     "PrefixList",
     "PutMetadata",
     "PutObjectHold",
     "RewriteObject",
+    "UpdateObjectCustomContext",
 )

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.3.0"  # {x-release-please-version}
+__version__ = "0.5.0"  # {x-release-please-version}

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/__init__.py

@@ -28,6 +28,7 @@ else:  # pragma: NO COVER
     # this code path once we drop support for Python 3.7
     import importlib_metadata as metadata
 
+
 from .services.storage_batch_operations import (
     StorageBatchOperationsAsyncClient,
     StorageBatchOperationsClient,
@@ -37,25 +38,32 @@ from .types.storage_batch_operations import (
     CancelJobResponse,
     CreateJobRequest,
     DeleteJobRequest,
+    GetBucketOperationRequest,
     GetJobRequest,
+    ListBucketOperationsRequest,
+    ListBucketOperationsResponse,
     ListJobsRequest,
     ListJobsResponse,
     OperationMetadata,
 )
 from .types.storage_batch_operations_types import (
     BucketList,
+    BucketOperation,
     Counters,
+    CustomContextUpdates,
     DeleteObject,
     ErrorLogEntry,
     ErrorSummary,
     Job,
     LoggingConfig,
     Manifest,
+    ObjectCustomContextPayload,
     ObjectRetention,
     PrefixList,
     PutMetadata,
     PutObjectHold,
     RewriteObject,
+    UpdateObjectCustomContext,
 )
 
 if hasattr(api_core, "check_python_version") and hasattr(
@@ -155,20 +163,26 @@ else:  # pragma: NO COVER
 __all__ = (
     "StorageBatchOperationsAsyncClient",
     "BucketList",
+    "BucketOperation",
     "CancelJobRequest",
     "CancelJobResponse",
     "Counters",
     "CreateJobRequest",
+    "CustomContextUpdates",
     "DeleteJobRequest",
     "DeleteObject",
     "ErrorLogEntry",
     "ErrorSummary",
+    "GetBucketOperationRequest",
     "GetJobRequest",
     "Job",
+    "ListBucketOperationsRequest",
+    "ListBucketOperationsResponse",
     "ListJobsRequest",
     "ListJobsResponse",
     "LoggingConfig",
     "Manifest",
+    "ObjectCustomContextPayload",
     "ObjectRetention",
     "OperationMetadata",
     "PrefixList",
@@ -176,4 +190,5 @@ __all__ = (
     "PutObjectHold",
     "RewriteObject",
     "StorageBatchOperationsClient",
+    "UpdateObjectCustomContext",
 )

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/gapic_metadata.json

@@ -25,11 +25,21 @@
                 "delete_job"
               ]
             },
+            "GetBucketOperation": {
+              "methods": [
+                "get_bucket_operation"
+              ]
+            },
             "GetJob": {
               "methods": [
                 "get_job"
               ]
             },
+            "ListBucketOperations": {
+              "methods": [
+                "list_bucket_operations"
+              ]
+            },
             "ListJobs": {
               "methods": [
                 "list_jobs"
@@ -55,11 +65,21 @@
                 "delete_job"
               ]
             },
+            "GetBucketOperation": {
+              "methods": [
+                "get_bucket_operation"
+              ]
+            },
             "GetJob": {
               "methods": [
                 "get_job"
               ]
             },
+            "ListBucketOperations": {
+              "methods": [
+                "list_bucket_operations"
+              ]
+            },
             "ListJobs": {
               "methods": [
                 "list_jobs"
@@ -85,11 +105,21 @@
                 "delete_job"
               ]
             },
+            "GetBucketOperation": {
+              "methods": [
+                "get_bucket_operation"
+              ]
+            },
             "GetJob": {
               "methods": [
                 "get_job"
               ]
             },
+            "ListBucketOperations": {
+              "methods": [
+                "list_bucket_operations"
+              ]
+            },
             "ListJobs": {
               "methods": [
                 "list_jobs"

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/gapic_version.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-__version__ = "0.3.0"  # {x-release-please-version}
+__version__ = "0.5.0"  # {x-release-please-version}

{google_cloud_storagebatchoperations-0.3.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/async_client.py

@@ -13,9 +13,9 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from collections import OrderedDict
 import logging as std_logging
 import re
+from collections import OrderedDict
 from typing import (
     Callable,
     Dict,
@@ -29,13 +29,13 @@ from typing import (
     Union,
 )
 
+import google.protobuf
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
 from google.api_core import retry_async as retries
 from google.api_core.client_options import ClientOptions
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.oauth2 import service_account  # type: ignore
-import google.protobuf
 
 from google.cloud.storagebatchoperations_v1 import gapic_version as package_version
 
@@ -44,11 +44,11 @@ try:
 except AttributeError:  # pragma: NO COVER
     OptionalRetry = Union[retries.AsyncRetry, object, None]  # type: ignore
 
-from google.api_core import operation  # type: ignore
-from google.api_core import operation_async  # type: ignore
+import google.api_core.operation as operation  # type: ignore
+import google.api_core.operation_async as operation_async  # type: ignore
+import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
-from google.protobuf import timestamp_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.services.storage_batch_operations import (
     pagers,
@@ -89,6 +89,12 @@ class StorageBatchOperationsAsyncClient:
     _DEFAULT_ENDPOINT_TEMPLATE = StorageBatchOperationsClient._DEFAULT_ENDPOINT_TEMPLATE
     _DEFAULT_UNIVERSE = StorageBatchOperationsClient._DEFAULT_UNIVERSE
 
+    bucket_operation_path = staticmethod(
+        StorageBatchOperationsClient.bucket_operation_path
+    )
+    parse_bucket_operation_path = staticmethod(
+        StorageBatchOperationsClient.parse_bucket_operation_path
+    )
     crypto_key_path = staticmethod(StorageBatchOperationsClient.crypto_key_path)
     parse_crypto_key_path = staticmethod(
         StorageBatchOperationsClient.parse_crypto_key_path
@@ -135,7 +141,10 @@ class StorageBatchOperationsAsyncClient:
         Returns:
             StorageBatchOperationsAsyncClient: The constructed client.
         """
-        return StorageBatchOperationsClient.from_service_account_info.__func__(StorageBatchOperationsAsyncClient, info, *args, **kwargs)  # type: ignore
+        sa_info_func = (
+            StorageBatchOperationsClient.from_service_account_info.__func__  # type: ignore
+        )
+        return sa_info_func(StorageBatchOperationsAsyncClient, info, *args, **kwargs)
 
     @classmethod
     def from_service_account_file(cls, filename: str, *args, **kwargs):
@@ -151,7 +160,12 @@ class StorageBatchOperationsAsyncClient:
         Returns:
             StorageBatchOperationsAsyncClient: The constructed client.
         """
-        return StorageBatchOperationsClient.from_service_account_file.__func__(StorageBatchOperationsAsyncClient, filename, *args, **kwargs)  # type: ignore
+        sa_file_func = (
+            StorageBatchOperationsClient.from_service_account_file.__func__  # type: ignore
+        )
+        return sa_file_func(
+            StorageBatchOperationsAsyncClient, filename, *args, **kwargs
+        )
 
     from_service_account_json = from_service_account_file
 
@@ -189,7 +203,9 @@ class StorageBatchOperationsAsyncClient:
         Raises:
             google.auth.exceptions.MutualTLSChannelError: If any errors happen.
         """
-        return StorageBatchOperationsClient.get_mtls_endpoint_and_cert_source(client_options)  # type: ignore
+        return StorageBatchOperationsClient.get_mtls_endpoint_and_cert_source(
+            client_options
+        )  # type: ignore
 
     @property
     def transport(self) -> StorageBatchOperationsTransport:
@@ -909,6 +925,250 @@ class StorageBatchOperationsAsyncClient:
         # Done; return the response.
         return response
 
+    async def list_bucket_operations(
+        self,
+        request: Optional[
+            Union[storage_batch_operations.ListBucketOperationsRequest, dict]
+        ] = None,
+        *,
+        parent: Optional[str] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
+    ) -> pagers.ListBucketOperationsAsyncPager:
+        r"""Lists BucketOperations in a given project and job.
+
+        .. code-block:: python
+
+            # This snippet has been automatically generated and should be regarded as a
+            # code template only.
+            # It will require modifications to work:
+            # - It may require correct/in-range values for request initialization.
+            # - It may require specifying regional endpoints when creating the service
+            #   client as shown in:
+            #   https://googleapis.dev/python/google-api-core/latest/client_options.html
+            from google.cloud import storagebatchoperations_v1
+
+            async def sample_list_bucket_operations():
+                # Create a client
+                client = storagebatchoperations_v1.StorageBatchOperationsAsyncClient()
+
+                # Initialize request argument(s)
+                request = storagebatchoperations_v1.ListBucketOperationsRequest(
+                    parent="parent_value",
+                )
+
+                # Make the request
+                page_result = client.list_bucket_operations(request=request)
+
+                # Handle the response
+                async for response in page_result:
+                    print(response)
+
+        Args:
+            request (Optional[Union[google.cloud.storagebatchoperations_v1.types.ListBucketOperationsRequest, dict]]):
+                The request object. Message for request to list
+                BucketOperations
+            parent (:class:`str`):
+                Required. Format:
+                projects/{project_id}/locations/global/jobs/{job_id}.
+
+                This corresponds to the ``parent`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be
+                sent along with the request as metadata. Normally, each value must be of type `str`,
+                but for metadata keys ending with the suffix `-bin`, the corresponding values must
+                be of type `bytes`.
+
+        Returns:
+            google.cloud.storagebatchoperations_v1.services.storage_batch_operations.pagers.ListBucketOperationsAsyncPager:
+                Message for response to listing
+                BucketOperations
+                Iterating over this object will yield
+                results and resolve additional pages
+                automatically.
+
+        """
+        # Create or coerce a protobuf request object.
+        # - Quick check: If we got a request object, we should *not* have
+        #   gotten any keyword arguments that map to the request.
+        flattened_params = [parent]
+        has_flattened_params = (
+            len([param for param in flattened_params if param is not None]) > 0
+        )
+        if request is not None and has_flattened_params:
+            raise ValueError(
+                "If the `request` argument is set, then none of "
+                "the individual field arguments should be set."
+            )
+
+        # - Use the request object if provided (there's no risk of modifying the input as
+        #   there are no flattened fields), or create one.
+        if not isinstance(
+            request, storage_batch_operations.ListBucketOperationsRequest
+        ):
+            request = storage_batch_operations.ListBucketOperationsRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if parent is not None:
+            request.parent = parent
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.list_bucket_operations
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("parent", request.parent),)),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # This method is paged; wrap the response in a pager, which provides
+        # an `__aiter__` convenience method.
+        response = pagers.ListBucketOperationsAsyncPager(
+            method=rpc,
+            request=request,
+            response=response,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
+    async def get_bucket_operation(
+        self,
+        request: Optional[
+            Union[storage_batch_operations.GetBucketOperationRequest, dict]
+        ] = None,
+        *,
+        name: Optional[str] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
+    ) -> storage_batch_operations_types.BucketOperation:
+        r"""Gets a BucketOperation.
+
+        .. code-block:: python
+
+            # This snippet has been automatically generated and should be regarded as a
+            # code template only.
+            # It will require modifications to work:
+            # - It may require correct/in-range values for request initialization.
+            # - It may require specifying regional endpoints when creating the service
+            #   client as shown in:
+            #   https://googleapis.dev/python/google-api-core/latest/client_options.html
+            from google.cloud import storagebatchoperations_v1
+
+            async def sample_get_bucket_operation():
+                # Create a client
+                client = storagebatchoperations_v1.StorageBatchOperationsAsyncClient()
+
+                # Initialize request argument(s)
+                request = storagebatchoperations_v1.GetBucketOperationRequest(
+                    name="name_value",
+                )
+
+                # Make the request
+                response = await client.get_bucket_operation(request=request)
+
+                # Handle the response
+                print(response)
+
+        Args:
+            request (Optional[Union[google.cloud.storagebatchoperations_v1.types.GetBucketOperationRequest, dict]]):
+                The request object. Message for getting a
+                BucketOperation.
+            name (:class:`str`):
+                Required. ``name`` of the bucket operation to retrieve.
+                Format:
+                projects/{project_id}/locations/global/jobs/{job_id}/bucketOperations/{bucket_operation_id}.
+
+                This corresponds to the ``name`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry_async.AsyncRetry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, Union[str, bytes]]]): Key/value pairs which should be
+                sent along with the request as metadata. Normally, each value must be of type `str`,
+                but for metadata keys ending with the suffix `-bin`, the corresponding values must
+                be of type `bytes`.
+
+        Returns:
+            google.cloud.storagebatchoperations_v1.types.BucketOperation:
+                BucketOperation represents a
+                bucket-level breakdown of a Job.
+
+        """
+        # Create or coerce a protobuf request object.
+        # - Quick check: If we got a request object, we should *not* have
+        #   gotten any keyword arguments that map to the request.
+        flattened_params = [name]
+        has_flattened_params = (
+            len([param for param in flattened_params if param is not None]) > 0
+        )
+        if request is not None and has_flattened_params:
+            raise ValueError(
+                "If the `request` argument is set, then none of "
+                "the individual field arguments should be set."
+            )
+
+        # - Use the request object if provided (there's no risk of modifying the input as
+        #   there are no flattened fields), or create one.
+        if not isinstance(request, storage_batch_operations.GetBucketOperationRequest):
+            request = storage_batch_operations.GetBucketOperationRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if name is not None:
+            request.name = name
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.get_bucket_operation
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("name", request.name),)),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
     async def list_operations(
         self,
         request: Optional[operations_pb2.ListOperationsRequest] = None,