docs: clarification for deprecated fields (#108)

* docs: clarification for deprecated fields

PiperOrigin-RevId: 506637342

Source-Link: googleapis/googleapis@9821393

Source-Link: https://github.com/googleapis/googleapis-gen/commit/d9d93e022548947045bef32a4245e3ba5c936808
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDlkOTNlMDIyNTQ4OTQ3MDQ1YmVmMzJhNDI0NWUzYmE1YzkzNjgwOCJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

---------

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

Author: gcf-owl-bot[bot]

google/cloud/optimization_v1/services/fleet_routing/async_client.py

@@ -46,6 +46,7 @@
 from google.api_core import operation_async  # type: ignore
 from google.cloud.optimization_v1.types import async_model
 from google.cloud.optimization_v1.types import fleet_routing
+from google.longrunning import operations_pb2
 from .transports.base import FleetRoutingTransport, DEFAULT_CLIENT_INFO
 from .transports.grpc_asyncio import FleetRoutingGrpcAsyncIOTransport
 from .client import FleetRoutingClient
@@ -463,6 +464,60 @@ async def sample_batch_optimize_tours():
         # Done; return the response.
         return response
 
+    async def get_operation(
+        self,
+        request: Optional[operations_pb2.GetOperationRequest] = None,
+        *,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> operations_pb2.Operation:
+        r"""Gets the latest state of a long-running operation.
+
+        Args:
+            request (:class:`~.operations_pb2.GetOperationRequest`):
+                The request object. Request message for
+                `GetOperation` method.
+            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:
+            ~.operations_pb2.Operation:
+                An ``Operation`` object.
+        """
+        # Create or coerce a protobuf request object.
+        # The request isn't a proto-plus wrapped type,
+        # so it must be constructed via keyword expansion.
+        if isinstance(request, dict):
+            request = operations_pb2.GetOperationRequest(**request)
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = gapic_v1.method.wrap_method(
+            self._client._transport.get_operation,
+            default_timeout=None,
+            client_info=DEFAULT_CLIENT_INFO,
+        )
+
+        # 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),)),
+        )
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
     async def __aenter__(self):
         return self
 

google/cloud/optimization_v1/services/fleet_routing/client.py

@@ -50,6 +50,7 @@
 from google.api_core import operation_async  # type: ignore
 from google.cloud.optimization_v1.types import async_model
 from google.cloud.optimization_v1.types import fleet_routing
+from google.longrunning import operations_pb2
 from .transports.base import FleetRoutingTransport, DEFAULT_CLIENT_INFO
 from .transports.grpc import FleetRoutingGrpcTransport
 from .transports.grpc_asyncio import FleetRoutingGrpcAsyncIOTransport
@@ -669,6 +670,60 @@ def __exit__(self, type, value, traceback):
         """
         self.transport.close()
 
+    def get_operation(
+        self,
+        request: Optional[operations_pb2.GetOperationRequest] = None,
+        *,
+        retry: OptionalRetry = gapic_v1.method.DEFAULT,
+        timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+        metadata: Sequence[Tuple[str, str]] = (),
+    ) -> operations_pb2.Operation:
+        r"""Gets the latest state of a long-running operation.
+
+        Args:
+            request (:class:`~.operations_pb2.GetOperationRequest`):
+                The request object. Request message for
+                `GetOperation` method.
+            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:
+            ~.operations_pb2.Operation:
+                An ``Operation`` object.
+        """
+        # Create or coerce a protobuf request object.
+        # The request isn't a proto-plus wrapped type,
+        # so it must be constructed via keyword expansion.
+        if isinstance(request, dict):
+            request = operations_pb2.GetOperationRequest(**request)
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = gapic_v1.method.wrap_method(
+            self._transport.get_operation,
+            default_timeout=None,
+            client_info=DEFAULT_CLIENT_INFO,
+        )
+
+        # 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),)),
+        )
+
+        # Send the request.
+        response = rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Done; return the response.
+        return response
+
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
     gapic_version=package_version.__version__

google/cloud/optimization_v1/services/fleet_routing/transports/base.py

@@ -28,6 +28,7 @@
 from google.oauth2 import service_account  # type: ignore
 
 from google.cloud.optimization_v1.types import fleet_routing
+from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 
 DEFAULT_CLIENT_INFO = gapic_v1.client_info.ClientInfo(
@@ -190,6 +191,15 @@ def batch_optimize_tours(
     ]:
         raise NotImplementedError()
 
+    @property
+    def get_operation(
+        self,
+    ) -> Callable[
+        [operations_pb2.GetOperationRequest],
+        Union[operations_pb2.Operation, Awaitable[operations_pb2.Operation]],
+    ]:
+        raise NotImplementedError()
+
     @property
     def kind(self) -> str:
         raise NotImplementedError()

google/cloud/optimization_v1/services/fleet_routing/transports/grpc.py

@@ -26,6 +26,7 @@
 import grpc  # type: ignore
 
 from google.cloud.optimization_v1.types import fleet_routing
+from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from .base import FleetRoutingTransport, DEFAULT_CLIENT_INFO
 
@@ -350,6 +351,23 @@ def batch_optimize_tours(
     def close(self):
         self.grpc_channel.close()
 
+    @property
+    def get_operation(
+        self,
+    ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]:
+        r"""Return a callable for the get_operation method over gRPC."""
+        # 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 "get_operation" not in self._stubs:
+            self._stubs["get_operation"] = self.grpc_channel.unary_unary(
+                "/google.longrunning.Operations/GetOperation",
+                request_serializer=operations_pb2.GetOperationRequest.SerializeToString,
+                response_deserializer=operations_pb2.Operation.FromString,
+            )
+        return self._stubs["get_operation"]
+
     @property
     def kind(self) -> str:
         return "grpc"

google/cloud/optimization_v1/services/fleet_routing/transports/grpc_asyncio.py

@@ -26,6 +26,7 @@
 from grpc.experimental import aio  # type: ignore
 
 from google.cloud.optimization_v1.types import fleet_routing
+from google.longrunning import operations_pb2
 from google.longrunning import operations_pb2  # type: ignore
 from .base import FleetRoutingTransport, DEFAULT_CLIENT_INFO
 from .grpc import FleetRoutingGrpcTransport
@@ -358,5 +359,22 @@ def batch_optimize_tours(
     def close(self):
         return self.grpc_channel.close()
 
+    @property
+    def get_operation(
+        self,
+    ) -> Callable[[operations_pb2.GetOperationRequest], operations_pb2.Operation]:
+        r"""Return a callable for the get_operation method over gRPC."""
+        # 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 "get_operation" not in self._stubs:
+            self._stubs["get_operation"] = self.grpc_channel.unary_unary(
+                "/google.longrunning.Operations/GetOperation",
+                request_serializer=operations_pb2.GetOperationRequest.SerializeToString,
+                response_deserializer=operations_pb2.Operation.FromString,
+            )
+        return self._stubs["get_operation"]
+
 
 __all__ = ("FleetRoutingGrpcAsyncIOTransport",)