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

{google_cloud_storagebatchoperations-0.4.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.4.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.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations/__init__.py

@@ -41,17 +41,20 @@ from google.cloud.storagebatchoperations_v1.types.storage_batch_operations_types
     BucketList,
     BucketOperation,
     Counters,
+    CustomContextUpdates,
     DeleteObject,
     ErrorLogEntry,
     ErrorSummary,
     Job,
     LoggingConfig,
     Manifest,
+    ObjectCustomContextPayload,
     ObjectRetention,
     PrefixList,
     PutMetadata,
     PutObjectHold,
     RewriteObject,
+    UpdateObjectCustomContext,
 )
 
 __all__ = (
@@ -71,15 +74,18 @@ __all__ = (
     "BucketList",
     "BucketOperation",
     "Counters",
+    "CustomContextUpdates",
     "DeleteObject",
     "ErrorLogEntry",
     "ErrorSummary",
     "Job",
     "LoggingConfig",
     "Manifest",
+    "ObjectCustomContextPayload",
     "ObjectRetention",
     "PrefixList",
     "PutMetadata",
     "PutObjectHold",
     "RewriteObject",
+    "UpdateObjectCustomContext",
 )

{google_cloud_storagebatchoperations-0.4.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.4.0"  # {x-release-please-version}
+__version__ = "0.5.0"  # {x-release-please-version}

{google_cloud_storagebatchoperations-0.4.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,
@@ -49,17 +50,20 @@ 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(
@@ -164,6 +168,7 @@ __all__ = (
     "CancelJobResponse",
     "Counters",
     "CreateJobRequest",
+    "CustomContextUpdates",
     "DeleteJobRequest",
     "DeleteObject",
     "ErrorLogEntry",
@@ -177,6 +182,7 @@ __all__ = (
     "ListJobsResponse",
     "LoggingConfig",
     "Manifest",
+    "ObjectCustomContextPayload",
     "ObjectRetention",
     "OperationMetadata",
     "PrefixList",
@@ -184,4 +190,5 @@ __all__ = (
     "PutObjectHold",
     "RewriteObject",
     "StorageBatchOperationsClient",
+    "UpdateObjectCustomContext",
 )

{google_cloud_storagebatchoperations-0.4.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.4.0"  # {x-release-please-version}
+__version__ = "0.5.0"  # {x-release-please-version}

{google_cloud_storagebatchoperations-0.4.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
 
@@ -46,9 +46,9 @@ except AttributeError:  # pragma: NO COVER
 
 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
-import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.services.storage_batch_operations import (
     pagers,
@@ -141,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):
@@ -157,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
 
@@ -195,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:

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/client.py

@@ -13,12 +13,13 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-from collections import OrderedDict
-from http import HTTPStatus
 import json
 import logging as std_logging
 import os
 import re
+import warnings
+from collections import OrderedDict
+from http import HTTPStatus
 from typing import (
     Callable,
     Dict,
@@ -32,8 +33,8 @@ from typing import (
     Union,
     cast,
 )
-import warnings
 
+import google.protobuf
 from google.api_core import client_options as client_options_lib
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1
@@ -43,7 +44,6 @@ from google.auth.exceptions import MutualTLSChannelError  # type: ignore
 from google.auth.transport import mtls  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.oauth2 import service_account  # type: ignore
-import google.protobuf
 
 from google.cloud.storagebatchoperations_v1 import gapic_version as package_version
 
@@ -63,9 +63,9 @@ _LOGGER = std_logging.getLogger(__name__)
 
 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
-import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.services.storage_batch_operations import (
     pagers,
@@ -89,9 +89,7 @@ class StorageBatchOperationsClientMeta(type):
     objects.
     """
 
-    _transport_registry = (
-        OrderedDict()
-    )  # type: Dict[str, Type[StorageBatchOperationsTransport]]
+    _transport_registry = OrderedDict()  # type: Dict[str, Type[StorageBatchOperationsTransport]]
     _transport_registry["grpc"] = StorageBatchOperationsGrpcTransport
     _transport_registry["grpc_asyncio"] = StorageBatchOperationsGrpcAsyncIOTransport
     _transport_registry["rest"] = StorageBatchOperationsRestTransport
@@ -690,11 +688,9 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
 
         universe_domain_opt = getattr(self._client_options, "universe_domain", None)
 
-        (
-            self._use_client_cert,
-            self._use_mtls_endpoint,
-            self._universe_domain_env,
-        ) = StorageBatchOperationsClient._read_environment_variables()
+        self._use_client_cert, self._use_mtls_endpoint, self._universe_domain_env = (
+            StorageBatchOperationsClient._read_environment_variables()
+        )
         self._client_cert_source = StorageBatchOperationsClient._get_client_cert_source(
             self._client_options.client_cert_source, self._use_client_cert
         )
@@ -729,8 +725,7 @@ class StorageBatchOperationsClient(metaclass=StorageBatchOperationsClientMeta):
                 )
             if self._client_options.scopes:
                 raise ValueError(
-                    "When providing a transport instance, provide its scopes "
-                    "directly."
+                    "When providing a transport instance, provide its scopes directly."
                 )
             self._transport = cast(StorageBatchOperationsTransport, transport)
             self._api_endpoint = self._transport.host

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/pagers.py

@@ -70,7 +70,7 @@ class ListJobsPager:
         *,
         retry: OptionalRetry = gapic_v1.method.DEFAULT,
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
-        metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ):
         """Instantiate the pager.
 
@@ -146,7 +146,7 @@ class ListJobsAsyncPager:
         *,
         retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT,
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
-        metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ):
         """Instantiates the pager.
 
@@ -226,7 +226,7 @@ class ListBucketOperationsPager:
         *,
         retry: OptionalRetry = gapic_v1.method.DEFAULT,
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
-        metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ):
         """Instantiate the pager.
 
@@ -304,7 +304,7 @@ class ListBucketOperationsAsyncPager:
         *,
         retry: OptionalAsyncRetry = gapic_v1.method.DEFAULT,
         timeout: Union[float, object] = gapic_v1.method.DEFAULT,
-        metadata: Sequence[Tuple[str, Union[str, bytes]]] = ()
+        metadata: Sequence[Tuple[str, Union[str, bytes]]] = (),
     ):
         """Instantiates the pager.
 

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/__init__.py

@@ -25,9 +25,7 @@ from .rest import (
 )
 
 # Compile a registry of transports.
-_transport_registry = (
-    OrderedDict()
-)  # type: Dict[str, Type[StorageBatchOperationsTransport]]
+_transport_registry = OrderedDict()  # type: Dict[str, Type[StorageBatchOperationsTransport]]
 _transport_registry["grpc"] = StorageBatchOperationsGrpcTransport
 _transport_registry["grpc_asyncio"] = StorageBatchOperationsGrpcAsyncIOTransport
 _transport_registry["rest"] = StorageBatchOperationsRestTransport

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/base.py

@@ -17,16 +17,16 @@ import abc
 from typing import Awaitable, Callable, Dict, Optional, Sequence, Union
 
 import google.api_core
+import google.auth  # type: ignore
+import google.protobuf
+import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1, operations_v1
 from google.api_core import retry as retries
-import google.auth  # type: ignore
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
 from google.oauth2 import service_account  # type: ignore
-import google.protobuf
-import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1 import gapic_version as package_version
 from google.cloud.storagebatchoperations_v1.types import (
@@ -352,13 +352,19 @@ class StorageBatchOperationsTransport(abc.ABC):
     @property
     def cancel_operation(
         self,
-    ) -> Callable[[operations_pb2.CancelOperationRequest], None,]:
+    ) -> Callable[
+        [operations_pb2.CancelOperationRequest],
+        None,
+    ]:
         raise NotImplementedError()
 
     @property
     def delete_operation(
         self,
-    ) -> Callable[[operations_pb2.DeleteOperationRequest], None,]:
+    ) -> Callable[
+        [operations_pb2.DeleteOperationRequest],
+        None,
+    ]:
         raise NotImplementedError()
 
     @property

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/rest.py

@@ -16,19 +16,19 @@
 import dataclasses
 import json  # type: ignore
 import logging
-from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
 import warnings
+from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
 
-from google.api_core import gapic_v1, operations_v1, rest_helpers, rest_streaming
+import google.protobuf
+import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from google.api_core import exceptions as core_exceptions
+from google.api_core import gapic_v1, operations_v1, rest_helpers, rest_streaming
 from google.api_core import retry as retries
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.auth.transport.requests import AuthorizedSession  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
-import google.protobuf
 from google.protobuf import json_format
-import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from requests import __version__ as requests_version
 
 from google.cloud.storagebatchoperations_v1.types import (
@@ -806,9 +806,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                     Message for response to cancel Job.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseCancelJob._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseCancelJob._get_http_options()
 
             request, metadata = self._interceptor.pre_cancel_job(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseCancelJob._get_transcoded_request(
@@ -962,9 +960,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
 
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseCreateJob._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseCreateJob._get_http_options()
 
             request, metadata = self._interceptor.pre_create_job(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseCreateJob._get_transcoded_request(
@@ -1106,9 +1102,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                     be of type `bytes`.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseDeleteJob._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseDeleteJob._get_http_options()
 
             request, metadata = self._interceptor.pre_delete_job(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseDeleteJob._get_transcoded_request(
@@ -1220,9 +1214,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
 
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseGetBucketOperation._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseGetBucketOperation._get_http_options()
 
             request, metadata = self._interceptor.pre_get_bucket_operation(
                 request, metadata
@@ -1523,9 +1515,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
 
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseListBucketOperations._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseListBucketOperations._get_http_options()
 
             request, metadata = self._interceptor.pre_list_bucket_operations(
                 request, metadata
@@ -1676,9 +1666,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                     Message for response to listing Jobs
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseListJobs._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseListJobs._get_http_options()
 
             request, metadata = self._interceptor.pre_list_jobs(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseListJobs._get_transcoded_request(
@@ -1898,9 +1886,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                 locations_pb2.Location: Response from GetLocation method.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseGetLocation._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseGetLocation._get_http_options()
 
             request, metadata = self._interceptor.pre_get_location(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseGetLocation._get_transcoded_request(
@@ -2039,9 +2025,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                 locations_pb2.ListLocationsResponse: Response from ListLocations method.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseListLocations._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseListLocations._get_http_options()
 
             request, metadata = self._interceptor.pre_list_locations(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseListLocations._get_transcoded_request(
@@ -2178,9 +2162,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                     be of type `bytes`.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseCancelOperation._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseCancelOperation._get_http_options()
 
             request, metadata = self._interceptor.pre_cancel_operation(
                 request, metadata
@@ -2300,9 +2282,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                     be of type `bytes`.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseDeleteOperation._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseDeleteOperation._get_http_options()
 
             request, metadata = self._interceptor.pre_delete_operation(
                 request, metadata
@@ -2420,9 +2400,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                 operations_pb2.Operation: Response from GetOperation method.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseGetOperation._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseGetOperation._get_http_options()
 
             request, metadata = self._interceptor.pre_get_operation(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseGetOperation._get_transcoded_request(
@@ -2561,9 +2539,7 @@ class StorageBatchOperationsRestTransport(_BaseStorageBatchOperationsRestTranspo
                 operations_pb2.ListOperationsResponse: Response from ListOperations method.
             """
 
-            http_options = (
-                _BaseStorageBatchOperationsRestTransport._BaseListOperations._get_http_options()
-            )
+            http_options = _BaseStorageBatchOperationsRestTransport._BaseListOperations._get_http_options()
 
             request, metadata = self._interceptor.pre_list_operations(request, metadata)
             transcoded_request = _BaseStorageBatchOperationsRestTransport._BaseListOperations._get_transcoded_request(

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

@@ -30,17 +30,20 @@ from .storage_batch_operations_types import (
     BucketList,
     BucketOperation,
     Counters,
+    CustomContextUpdates,
     DeleteObject,
     ErrorLogEntry,
     ErrorSummary,
     Job,
     LoggingConfig,
     Manifest,
+    ObjectCustomContextPayload,
     ObjectRetention,
     PrefixList,
     PutMetadata,
     PutObjectHold,
     RewriteObject,
+    UpdateObjectCustomContext,
 )
 
 __all__ = (
@@ -58,15 +61,18 @@ __all__ = (
     "BucketList",
     "BucketOperation",
     "Counters",
+    "CustomContextUpdates",
     "DeleteObject",
     "ErrorLogEntry",
     "ErrorSummary",
     "Job",
     "LoggingConfig",
     "Manifest",
+    "ObjectCustomContextPayload",
     "ObjectRetention",
     "PrefixList",
     "PutMetadata",
     "PutObjectHold",
     "RewriteObject",
+    "UpdateObjectCustomContext",
 )

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/types/storage_batch_operations_types.py

@@ -34,6 +34,9 @@ __protobuf__ = proto.module(
         "RewriteObject",
         "ObjectRetention",
         "PutMetadata",
+        "ObjectCustomContextPayload",
+        "CustomContextUpdates",
+        "UpdateObjectCustomContext",
         "ErrorSummary",
         "ErrorLogEntry",
         "Counters",
@@ -88,6 +91,10 @@ class Job(proto.Message):
             Rewrite the object and updates metadata like
             KMS key.
 
+            This field is a member of `oneof`_ ``transformation``.
+        update_object_custom_context (google.cloud.storagebatchoperations_v1.types.UpdateObjectCustomContext):
+            Update object custom context.
+
             This field is a member of `oneof`_ ``transformation``.
         logging_config (google.cloud.storagebatchoperations_v1.types.LoggingConfig):
             Optional. Logging configuration.
@@ -138,6 +145,7 @@ class Job(proto.Message):
             QUEUED (5):
                 Queued but not yet started.
         """
+
         STATE_UNSPECIFIED = 0
         RUNNING = 1
         SUCCEEDED = 2
@@ -183,6 +191,12 @@ class Job(proto.Message):
         oneof="transformation",
         message="RewriteObject",
     )
+    update_object_custom_context: "UpdateObjectCustomContext" = proto.Field(
+        proto.MESSAGE,
+        number=23,
+        oneof="transformation",
+        message="UpdateObjectCustomContext",
+    )
     logging_config: "LoggingConfig" = proto.Field(
         proto.MESSAGE,
         number=9,
@@ -274,6 +288,10 @@ class BucketOperation(proto.Message):
             Rewrite the object and updates metadata like
             KMS key.
 
+            This field is a member of `oneof`_ ``transformation``.
+        update_object_custom_context (google.cloud.storagebatchoperations_v1.types.UpdateObjectCustomContext):
+            Update object custom context.
+
             This field is a member of `oneof`_ ``transformation``.
         create_time (google.protobuf.timestamp_pb2.Timestamp):
             Output only. The time that the
@@ -311,6 +329,7 @@ class BucketOperation(proto.Message):
             FAILED (5):
                 Terminated due to an unrecoverable failure.
         """
+
         STATE_UNSPECIFIED = 0
         QUEUED = 1
         RUNNING = 2
@@ -362,6 +381,12 @@ class BucketOperation(proto.Message):
         oneof="transformation",
         message="RewriteObject",
     )
+    update_object_custom_context: "UpdateObjectCustomContext" = proto.Field(
+        proto.MESSAGE,
+        number=15,
+        oneof="transformation",
+        message="UpdateObjectCustomContext",
+    )
     create_time: timestamp_pb2.Timestamp = proto.Field(
         proto.MESSAGE,
         number=5,
@@ -527,6 +552,7 @@ class PutObjectHold(proto.Message):
             UNSET (2):
                 Releases the hold.
         """
+
         HOLD_STATUS_UNSPECIFIED = 0
         SET = 1
         UNSET = 2
@@ -633,6 +659,7 @@ class ObjectRetention(proto.Message):
             UNLOCKED (2):
                 Sets the retention mode to unlocked.
         """
+
         RETENTION_MODE_UNSPECIFIED = 0
         LOCKED = 1
         UNLOCKED = 2
@@ -770,6 +797,93 @@ class PutMetadata(proto.Message):
     )
 
 
+class ObjectCustomContextPayload(proto.Message):
+    r"""Describes the payload of a user defined object custom
+    context.
+
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        value (str):
+            The value of the object custom context. If set, ``value``
+            must NOT be an empty string since it is a required field in
+            custom context. If unset, ``value`` will be ignored and no
+            changes will be made to the ``value`` field of the custom
+            context payload.
+
+            This field is a member of `oneof`_ ``_value``.
+    """
+
+    value: str = proto.Field(
+        proto.STRING,
+        number=1,
+        optional=True,
+    )
+
+
+class CustomContextUpdates(proto.Message):
+    r"""Describes a collection of updates to apply to custom contexts
+    identified by key.
+
+    Attributes:
+        updates (MutableMapping[str, google.cloud.storagebatchoperations_v1.types.ObjectCustomContextPayload]):
+            Optional. Insert or update the existing
+            custom contexts.
+        keys_to_clear (MutableSequence[str]):
+            Optional. Custom contexts to clear by key. A key cannot be
+            present in both ``updates`` and ``keys_to_clear``.
+    """
+
+    updates: MutableMapping[str, "ObjectCustomContextPayload"] = proto.MapField(
+        proto.STRING,
+        proto.MESSAGE,
+        number=1,
+        message="ObjectCustomContextPayload",
+    )
+    keys_to_clear: MutableSequence[str] = proto.RepeatedField(
+        proto.STRING,
+        number=2,
+    )
+
+
+class UpdateObjectCustomContext(proto.Message):
+    r"""Describes options to update object custom contexts.
+
+    This message has `oneof`_ fields (mutually exclusive fields).
+    For each oneof, at most one member field can be set at the same time.
+    Setting any member of the oneof automatically clears all other
+    members.
+
+    .. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
+
+    Attributes:
+        custom_context_updates (google.cloud.storagebatchoperations_v1.types.CustomContextUpdates):
+            A collection of updates to apply to specific
+            custom contexts. Use this to add, update or
+            delete individual contexts by key.
+
+            This field is a member of `oneof`_ ``action``.
+        clear_all (bool):
+            If set, must be set to true and all existing
+            object custom contexts will be deleted.
+
+            This field is a member of `oneof`_ ``action``.
+    """
+
+    custom_context_updates: "CustomContextUpdates" = proto.Field(
+        proto.MESSAGE,
+        number=1,
+        oneof="action",
+        message="CustomContextUpdates",
+    )
+    clear_all: bool = proto.Field(
+        proto.BOOL,
+        number=2,
+        oneof="action",
+    )
+
+
 class ErrorSummary(proto.Message):
     r"""A summary of errors by error code, plus a count and sample
     error log entries.
@@ -882,6 +996,7 @@ class LoggingConfig(proto.Message):
                 The corresponding transform action in this
                 job.
         """
+
         LOGGABLE_ACTION_UNSPECIFIED = 0
         TRANSFORM = 6
 
@@ -900,6 +1015,7 @@ class LoggingConfig(proto.Message):
                 actions are logged as
                 [ERROR][google.logging.type.LogSeverity.ERROR].
         """
+
         LOGGABLE_ACTION_STATE_UNSPECIFIED = 0
         SUCCEEDED = 1
         FAILED = 2

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: google-cloud-storagebatchoperations
-Version: 0.4.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.4.0 → google_cloud_storagebatchoperations-0.5.0}/tests/unit/gapic/storagebatchoperations_v1/test_storage_batch_operations.py

@@ -22,17 +22,17 @@ try:
 except ImportError:  # pragma: NO COVER
     import mock
 
-from collections.abc import AsyncIterable, Iterable
 import json
 import math
+from collections.abc import AsyncIterable, Iterable, Mapping, Sequence
 
+import grpc
+import pytest
 from google.api_core import api_core_version
 from google.protobuf import json_format
-import grpc
 from grpc.experimental import aio
 from proto.marshal.rules import wrappers
 from proto.marshal.rules.dates import DurationRule, TimestampRule
-import pytest
 from requests import PreparedRequest, Request, Response
 from requests.sessions import Session
 
@@ -43,7 +43,12 @@ try:
 except ImportError:  # pragma: NO COVER
     HAS_GOOGLE_AUTH_AIO = False
 
+import google.api_core.operation_async as operation_async  # type: ignore
+import google.auth
+import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
+import google.rpc.code_pb2 as code_pb2  # type: ignore
 from google.api_core import (
+    client_options,
     future,
     gapic_v1,
     grpc_helpers,
@@ -52,18 +57,13 @@ from google.api_core import (
     operations_v1,
     path_template,
 )
-from google.api_core import client_options
 from google.api_core import exceptions as core_exceptions
 from google.api_core import retry as retries
-import google.api_core.operation_async as operation_async  # type: ignore
-import google.auth
 from google.auth import credentials as ga_credentials
 from google.auth.exceptions import MutualTLSChannelError
 from google.cloud.location import locations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from google.oauth2 import service_account
-import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
-import google.rpc.code_pb2 as code_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.services.storage_batch_operations import (
     StorageBatchOperationsAsyncClient,
@@ -1014,10 +1014,9 @@ def test_storage_batch_operations_client_get_mtls_endpoint_and_cert_source(
                             client_cert_source=mock_client_cert_source,
                             api_endpoint=mock_api_endpoint,
                         )
-                        (
-                            api_endpoint,
-                            cert_source,
-                        ) = client_class.get_mtls_endpoint_and_cert_source(options)
+                        api_endpoint, cert_source = (
+                            client_class.get_mtls_endpoint_and_cert_source(options)
+                        )
                         assert api_endpoint == mock_api_endpoint
                         assert cert_source is expected_cert_source
 
@@ -1062,10 +1061,9 @@ def test_storage_batch_operations_client_get_mtls_endpoint_and_cert_source(
                             client_cert_source=mock_client_cert_source,
                             api_endpoint=mock_api_endpoint,
                         )
-                        (
-                            api_endpoint,
-                            cert_source,
-                        ) = client_class.get_mtls_endpoint_and_cert_source(options)
+                        api_endpoint, cert_source = (
+                            client_class.get_mtls_endpoint_and_cert_source(options)
+                        )
                         assert api_endpoint == mock_api_endpoint
                         assert cert_source is expected_cert_source
 
@@ -1101,10 +1099,9 @@ def test_storage_batch_operations_client_get_mtls_endpoint_and_cert_source(
                 "google.auth.transport.mtls.default_client_cert_source",
                 return_value=mock_client_cert_source,
             ):
-                (
-                    api_endpoint,
-                    cert_source,
-                ) = client_class.get_mtls_endpoint_and_cert_source()
+                api_endpoint, cert_source = (
+                    client_class.get_mtls_endpoint_and_cert_source()
+                )
                 assert api_endpoint == client_class.DEFAULT_MTLS_ENDPOINT
                 assert cert_source == mock_client_cert_source
 
@@ -1364,9 +1361,7 @@ def test_storage_batch_operations_client_create_channel_credentials_file(
         google.auth, "load_credentials_from_file", autospec=True
     ) as load_creds, mock.patch.object(
         google.auth, "default", autospec=True
-    ) as adc, mock.patch.object(
-        grpc_helpers, "create_channel"
-    ) as create_channel:
+    ) as adc, mock.patch.object(grpc_helpers, "create_channel") as create_channel:
         creds = ga_credentials.AnonymousCredentials()
         file_creds = ga_credentials.AnonymousCredentials()
         load_creds.return_value = (file_creds, None)
@@ -3325,9 +3320,9 @@ def test_list_bucket_operations_use_cached_wrapped_rpc():
         mock_rpc.return_value.name = (
             "foo"  # operation_request.operation in compute client(s) expect a string.
         )
-        client._transport._wrapped_methods[
-            client._transport.list_bucket_operations
-        ] = mock_rpc
+        client._transport._wrapped_methods[client._transport.list_bucket_operations] = (
+            mock_rpc
+        )
         request = {}
         client.list_bucket_operations(request)
 
@@ -3881,9 +3876,9 @@ def test_get_bucket_operation_use_cached_wrapped_rpc():
         mock_rpc.return_value.name = (
             "foo"  # operation_request.operation in compute client(s) expect a string.
         )
-        client._transport._wrapped_methods[
-            client._transport.get_bucket_operation
-        ] = mock_rpc
+        client._transport._wrapped_methods[client._transport.get_bucket_operation] = (
+            mock_rpc
+        )
         request = {}
         client.get_bucket_operation(request)
 
@@ -5177,9 +5172,9 @@ def test_list_bucket_operations_rest_use_cached_wrapped_rpc():
         mock_rpc.return_value.name = (
             "foo"  # operation_request.operation in compute client(s) expect a string.
         )
-        client._transport._wrapped_methods[
-            client._transport.list_bucket_operations
-        ] = mock_rpc
+        client._transport._wrapped_methods[client._transport.list_bucket_operations] = (
+            mock_rpc
+        )
 
         request = {}
         client.list_bucket_operations(request)
@@ -5449,9 +5444,9 @@ def test_get_bucket_operation_rest_use_cached_wrapped_rpc():
         mock_rpc.return_value.name = (
             "foo"  # operation_request.operation in compute client(s) expect a string.
         )
-        client._transport._wrapped_methods[
-            client._transport.get_bucket_operation
-        ] = mock_rpc
+        client._transport._wrapped_methods[client._transport.get_bucket_operation] = (
+            mock_rpc
+        )
 
         request = {}
         client.get_bucket_operation(request)
@@ -6424,6 +6419,13 @@ def test_create_job_rest_call_success(request_type):
             },
         },
         "rewrite_object": {"kms_key": "kms_key_value"},
+        "update_object_custom_context": {
+            "custom_context_updates": {
+                "updates": {},
+                "keys_to_clear": ["keys_to_clear_value1", "keys_to_clear_value2"],
+            },
+            "clear_all": True,
+        },
         "logging_config": {"log_actions": [6], "log_action_states": [1]},
         "create_time": {"seconds": 751, "nanos": 543},
         "schedule_time": {},

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc.py

@@ -16,20 +16,20 @@
 import json
 import logging as std_logging
 import pickle
-from typing import Callable, Dict, Optional, Sequence, Tuple, Union
 import warnings
+from typing import Callable, Dict, Optional, Sequence, Tuple, Union
 
-from google.api_core import gapic_v1, grpc_helpers, operations_v1
 import google.auth  # type: ignore
+import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
+import google.protobuf.message
+import grpc  # type: ignore
+import proto  # type: ignore
+from google.api_core import gapic_v1, grpc_helpers, operations_v1
 from google.auth import credentials as ga_credentials  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
-import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from google.protobuf.json_format import MessageToJson
-import google.protobuf.message
-import grpc  # type: ignore
-import proto  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.types import (
     storage_batch_operations,

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/grpc_asyncio.py

@@ -17,9 +17,13 @@ import inspect
 import json
 import logging as std_logging
 import pickle
-from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union
 import warnings
+from typing import Awaitable, Callable, Dict, Optional, Sequence, Tuple, Union
 
+import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
+import google.protobuf.message
+import grpc  # type: ignore
+import proto  # type: ignore
 from google.api_core import exceptions as core_exceptions
 from google.api_core import gapic_v1, grpc_helpers_async, operations_v1
 from google.api_core import retry_async as retries
@@ -27,12 +31,8 @@ from google.auth import credentials as ga_credentials  # type: ignore
 from google.auth.transport.grpc import SslCredentials  # type: ignore
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
-import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from google.protobuf.json_format import MessageToJson
-import google.protobuf.message
-import grpc  # type: ignore
 from grpc.experimental import aio  # type: ignore
-import proto  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.types import (
     storage_batch_operations,

{google_cloud_storagebatchoperations-0.4.0 → google_cloud_storagebatchoperations-0.5.0}/google/cloud/storagebatchoperations_v1/services/storage_batch_operations/transports/rest_base.py

@@ -17,11 +17,11 @@ import json  # type: ignore
 import re
 from typing import Any, Callable, Dict, List, Optional, Sequence, Tuple, Union
 
+import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 from google.api_core import gapic_v1, path_template
 from google.cloud.location import locations_pb2  # type: ignore
 from google.longrunning import operations_pb2  # type: ignore
 from google.protobuf import json_format
-import google.protobuf.empty_pb2 as empty_pb2  # type: ignore
 
 from google.cloud.storagebatchoperations_v1.types import (
     storage_batch_operations,