feat: [google-cloud-batch] Update description on allowed_locations in LocationPolicy field (#12677)

BEGIN_COMMIT_OVERRIDE
feat: Update description on allowed_locations in LocationPolicy field


---
feat: Add UpdateJob API to update the job spec, only task_count is
supported now


docs: updated comments
END_COMMIT_OVERRIDE


- [ ] Regenerate this pull request now.

---
feat: Add UpdateJob API to update the job spec, only task_count is
supported now

docs: updated comments
PiperOrigin-RevId: 631869976

Source-Link:
googleapis/googleapis@090d9a1

Source-Link:
googleapis/googleapis-gen@d19bc03
Copy-Tag:
eyJwIjoicGFja2FnZXMvZ29vZ2xlLWNsb3VkLWJhdGNoLy5Pd2xCb3QueWFtbCIsImgiOiJkMTliYzAzNDI4ZGJkYzdiY2NiYWU4NzUyZGVkMTljODU4ZmExNmY2In0=

---------

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: ohmayr <omairnaveed@ymail.com>

Author: gcf-owl-bot[bot]

packages/google-cloud-batch/google/cloud/batch/gapic_version.py

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

packages/google-cloud-batch/google/cloud/batch_v1/gapic_version.py

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

packages/google-cloud-batch/google/cloud/batch_v1alpha/__init__.py

@@ -34,6 +34,7 @@
     ListTasksRequest,
     ListTasksResponse,
     OperationMetadata,
+    UpdateJobRequest,
     UpdateResourceAllowanceRequest,
 )
 from .types.job import (
@@ -113,6 +114,7 @@
     "TaskResourceUsage",
     "TaskSpec",
     "TaskStatus",
+    "UpdateJobRequest",
     "UpdateResourceAllowanceRequest",
     "UsageResourceAllowance",
     "UsageResourceAllowanceSpec",

packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_metadata.json

@@ -60,6 +60,11 @@
                 "list_tasks"
               ]
             },
+            "UpdateJob": {
+              "methods": [
+                "update_job"
+              ]
+            },
             "UpdateResourceAllowance": {
               "methods": [
                 "update_resource_allowance"
@@ -120,6 +125,11 @@
                 "list_tasks"
               ]
             },
+            "UpdateJob": {
+              "methods": [
+                "update_job"
+              ]
+            },
             "UpdateResourceAllowance": {
               "methods": [
                 "update_resource_allowance"
@@ -180,6 +190,11 @@
                 "list_tasks"
               ]
             },
+            "UpdateJob": {
+              "methods": [
+                "update_job"
+              ]
+            },
             "UpdateResourceAllowance": {
               "methods": [
                 "update_resource_allowance"

packages/google-cloud-batch/google/cloud/batch_v1alpha/gapic_version.py

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

packages/google-cloud-batch/google/cloud/batch_v1alpha/services/batch_service/async_client.py

@@ -633,6 +633,121 @@ async def sample_delete_job():
         # Done; return the response.
         return response
 
+    async def update_job(
+        self,
+        request: Optional[Union[batch.UpdateJobRequest, dict]] = None,
+        *,
+        job: Optional[gcb_job.Job] = None,
+        update_mask: Optional[field_mask_pb2.FieldMask] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> gcb_job.Job:
+        r"""Update a 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 batch_v1alpha
+
+            async def sample_update_job():
+                # Create a client
+                client = batch_v1alpha.BatchServiceAsyncClient()
+
+                # Initialize request argument(s)
+                request = batch_v1alpha.UpdateJobRequest(
+                )
+
+                # Make the request
+                response = await client.update_job(request=request)
+
+                # Handle the response
+                print(response)
+
+        Args:
+            request (Optional[Union[google.cloud.batch_v1alpha.types.UpdateJobRequest, dict]]):
+                The request object. UpdateJob Request.
+            job (:class:`google.cloud.batch_v1alpha.types.Job`):
+                Required. The Job to update. Only fields specified in
+                ``update_mask`` are updated.
+
+                This corresponds to the ``job`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
+                Required. Mask of fields to update.
+
+                UpdateJob request now only supports update on
+                ``task_count`` field in a job's first task group. Other
+                fields will be ignored.
+
+                This corresponds to the ``update_mask`` 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, str]]): Strings which should be
+                sent along with the request as metadata.
+
+        Returns:
+            google.cloud.batch_v1alpha.types.Job:
+                The Cloud Batch Job description.
+        """
+        # 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.
+        has_flattened_params = any([job, update_mask])
+        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, batch.UpdateJobRequest):
+            request = batch.UpdateJobRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if job is not None:
+            request.job = job
+        if update_mask is not None:
+            request.update_mask = update_mask
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[
+            self._client._transport.update_job
+        ]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("job.name", request.job.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_jobs(
         self,
         request: Optional[Union[batch.ListJobsRequest, dict]] = None,

packages/google-cloud-batch/google/cloud/batch_v1alpha/services/batch_service/client.py

@@ -1109,6 +1109,118 @@ def sample_delete_job():
         # Done; return the response.
         return response
 
+    def update_job(
+        self,
+        request: Optional[Union[batch.UpdateJobRequest, dict]] = None,
+        *,
+        job: Optional[gcb_job.Job] = None,
+        update_mask: Optional[field_mask_pb2.FieldMask] = None,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> gcb_job.Job:
+        r"""Update a 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 batch_v1alpha
+
+            def sample_update_job():
+                # Create a client
+                client = batch_v1alpha.BatchServiceClient()
+
+                # Initialize request argument(s)
+                request = batch_v1alpha.UpdateJobRequest(
+                )
+
+                # Make the request
+                response = client.update_job(request=request)
+
+                # Handle the response
+                print(response)
+
+        Args:
+            request (Union[google.cloud.batch_v1alpha.types.UpdateJobRequest, dict]):
+                The request object. UpdateJob Request.
+            job (google.cloud.batch_v1alpha.types.Job):
+                Required. The Job to update. Only fields specified in
+                ``update_mask`` are updated.
+
+                This corresponds to the ``job`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            update_mask (google.protobuf.field_mask_pb2.FieldMask):
+                Required. Mask of fields to update.
+
+                UpdateJob request now only supports update on
+                ``task_count`` field in a job's first task group. Other
+                fields will be ignored.
+
+                This corresponds to the ``update_mask`` field
+                on the ``request`` instance; if ``request`` is provided, this
+                should not be set.
+            retry (google.api_core.retry.Retry): Designation of what errors, if any,
+                should be retried.
+            timeout (float): The timeout for this request.
+            metadata (Sequence[Tuple[str, str]]): Strings which should be
+                sent along with the request as metadata.
+
+        Returns:
+            google.cloud.batch_v1alpha.types.Job:
+                The Cloud Batch Job description.
+        """
+        # 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.
+        has_flattened_params = any([job, update_mask])
+        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, batch.UpdateJobRequest):
+            request = batch.UpdateJobRequest(request)
+            # If we have keyword arguments corresponding to fields on the
+            # request, apply these.
+            if job is not None:
+                request.job = job
+            if update_mask is not None:
+                request.update_mask = update_mask
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._transport._wrapped_methods[self._transport.update_job]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((("job.name", request.job.name),)),
+        )
+
+        # Validate the universe domain.
+        self._validate_universe_domain()
+
+        # Send the request.
+        response = rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
     def list_jobs(
         self,
         request: Optional[Union[batch.ListJobsRequest, dict]] = None,

packages/google-cloud-batch/google/cloud/batch_v1alpha/services/batch_service/transports/base.py

@@ -159,6 +159,11 @@ def _prep_wrapped_messages(self, client_info):
                 default_timeout=60.0,
                 client_info=client_info,
             ),
+            self.update_job: gapic_v1.method.wrap_method(
+                self.update_job,
+                default_timeout=60.0,
+                client_info=client_info,
+            ),
             self.list_jobs: gapic_v1.method.wrap_method(
                 self.list_jobs,
                 default_retry=retries.Retry(
@@ -281,6 +286,12 @@ def delete_job(
     ]:
         raise NotImplementedError()
 
+    @property
+    def update_job(
+        self,
+    ) -> Callable[[batch.UpdateJobRequest], Union[gcb_job.Job, Awaitable[gcb_job.Job]]]:
+        raise NotImplementedError()
+
     @property
     def list_jobs(
         self,

packages/google-cloud-batch/google/cloud/batch_v1alpha/services/batch_service/transports/grpc.py

@@ -333,6 +333,30 @@ def delete_job(
             )
         return self._stubs["delete_job"]
 
+    @property
+    def update_job(self) -> Callable[[batch.UpdateJobRequest], gcb_job.Job]:
+        r"""Return a callable for the update job method over gRPC.
+
+        Update a Job.
+
+        Returns:
+            Callable[[~.UpdateJobRequest],
+                    ~.Job]:
+                A function that, when called, will call the underlying RPC
+                on the server.
+        """
+        # Generate a "stub function" on-the-fly which will actually make
+        # the request.
+        # gRPC handles serialization and deserialization, so we just need
+        # to pass in the functions for each.
+        if "update_job" not in self._stubs:
+            self._stubs["update_job"] = self.grpc_channel.unary_unary(
+                "/google.cloud.batch.v1alpha.BatchService/UpdateJob",
+                request_serializer=batch.UpdateJobRequest.serialize,
+                response_deserializer=gcb_job.Job.deserialize,
+            )
+        return self._stubs["update_job"]
+
     @property
     def list_jobs(self) -> Callable[[batch.ListJobsRequest], batch.ListJobsResponse]:
         r"""Return a callable for the list jobs method over gRPC.