feat: add a v1 UpdateEndpointLongRunning API

PiperOrigin-RevId: 697715678

Source-Link: googleapis/googleapis@4ab02f3

Source-Link: googleapis/googleapis-gen@829605e
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODI5NjA1ZTE2ZGVlMWQ4ZDc5NWQ0ZGVhNDViNGMxMmQ4ZDk4M2ExYyJ9

Author: gcf-owl-bot[bot]

owl-bot-staging/v1/google/cloud/aiplatform/__init__.py

@@ -163,6 +163,7 @@
 from google.cloud.aiplatform_v1.types.deployment_resource_pool_service import UpdateDeploymentResourcePoolOperationMetadata
 from google.cloud.aiplatform_v1.types.deployment_resource_pool_service import UpdateDeploymentResourcePoolRequest
 from google.cloud.aiplatform_v1.types.encryption_spec import EncryptionSpec
+from google.cloud.aiplatform_v1.types.endpoint import ClientConnectionConfig
 from google.cloud.aiplatform_v1.types.endpoint import DeployedModel
 from google.cloud.aiplatform_v1.types.endpoint import Endpoint
 from google.cloud.aiplatform_v1.types.endpoint import FasterDeploymentConfig
@@ -183,6 +184,8 @@
 from google.cloud.aiplatform_v1.types.endpoint_service import UndeployModelOperationMetadata
 from google.cloud.aiplatform_v1.types.endpoint_service import UndeployModelRequest
 from google.cloud.aiplatform_v1.types.endpoint_service import UndeployModelResponse
+from google.cloud.aiplatform_v1.types.endpoint_service import UpdateEndpointLongRunningRequest
+from google.cloud.aiplatform_v1.types.endpoint_service import UpdateEndpointOperationMetadata
 from google.cloud.aiplatform_v1.types.endpoint_service import UpdateEndpointRequest
 from google.cloud.aiplatform_v1.types.entity_type import EntityType
 from google.cloud.aiplatform_v1.types.env_var import EnvVar
@@ -1048,6 +1051,7 @@
     'UpdateDeploymentResourcePoolOperationMetadata',
     'UpdateDeploymentResourcePoolRequest',
     'EncryptionSpec',
+    'ClientConnectionConfig',
     'DeployedModel',
     'Endpoint',
     'FasterDeploymentConfig',
@@ -1068,6 +1072,8 @@
     'UndeployModelOperationMetadata',
     'UndeployModelRequest',
     'UndeployModelResponse',
+    'UpdateEndpointLongRunningRequest',
+    'UpdateEndpointOperationMetadata',
     'UpdateEndpointRequest',
     'EntityType',
     'EnvVar',

owl-bot-staging/v1/google/cloud/aiplatform_v1/__init__.py

@@ -163,6 +163,7 @@
 from .types.deployment_resource_pool_service import UpdateDeploymentResourcePoolOperationMetadata
 from .types.deployment_resource_pool_service import UpdateDeploymentResourcePoolRequest
 from .types.encryption_spec import EncryptionSpec
+from .types.endpoint import ClientConnectionConfig
 from .types.endpoint import DeployedModel
 from .types.endpoint import Endpoint
 from .types.endpoint import FasterDeploymentConfig
@@ -183,6 +184,8 @@
 from .types.endpoint_service import UndeployModelOperationMetadata
 from .types.endpoint_service import UndeployModelRequest
 from .types.endpoint_service import UndeployModelResponse
+from .types.endpoint_service import UpdateEndpointLongRunningRequest
+from .types.endpoint_service import UpdateEndpointOperationMetadata
 from .types.endpoint_service import UpdateEndpointRequest
 from .types.entity_type import EntityType
 from .types.env_var import EnvVar
@@ -1000,6 +1003,7 @@
 'CheckTrialEarlyStoppingStateResponse',
 'Citation',
 'CitationMetadata',
+'ClientConnectionConfig',
 'CoherenceInput',
 'CoherenceInstance',
 'CoherenceResult',
@@ -1734,6 +1738,8 @@
 'UpdateDatasetVersionRequest',
 'UpdateDeploymentResourcePoolOperationMetadata',
 'UpdateDeploymentResourcePoolRequest',
+'UpdateEndpointLongRunningRequest',
+'UpdateEndpointOperationMetadata',
 'UpdateEndpointRequest',
 'UpdateEntityTypeRequest',
 'UpdateExecutionRequest',

owl-bot-staging/v1/google/cloud/aiplatform_v1/gapic_metadata.json

@@ -462,6 +462,11 @@
               "methods": [
                 "update_endpoint"
               ]
+            },
+            "UpdateEndpointLongRunning": {
+              "methods": [
+                "update_endpoint_long_running"
+              ]
             }
           }
         },
@@ -507,6 +512,11 @@
               "methods": [
                 "update_endpoint"
               ]
+            },
+            "UpdateEndpointLongRunning": {
+              "methods": [
+                "update_endpoint_long_running"
+              ]
             }
           }
         },
@@ -552,6 +562,11 @@
               "methods": [
                 "update_endpoint"
               ]
+            },
+            "UpdateEndpointLongRunning": {
+              "methods": [
+                "update_endpoint_long_running"
+              ]
             }
           }
         }

owl-bot-staging/v1/google/cloud/aiplatform_v1/services/endpoint_service/async_client.py

@@ -744,6 +744,128 @@ async def sample_update_endpoint():
         # Done; return the response.
         return response
 
+    async def update_endpoint_long_running(self,
+            request: Optional[Union[endpoint_service.UpdateEndpointLongRunningRequest, dict]] = None,
+            *,
+            endpoint: Optional[gca_endpoint.Endpoint] = None,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+            metadata: Sequence[Tuple[str, str]] = (),
+            ) -> operation_async.AsyncOperation:
+        r"""Updates an Endpoint with a long running operation.
+
+        .. 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 aiplatform_v1
+
+            async def sample_update_endpoint_long_running():
+                # Create a client
+                client = aiplatform_v1.EndpointServiceAsyncClient()
+
+                # Initialize request argument(s)
+                endpoint = aiplatform_v1.Endpoint()
+                endpoint.display_name = "display_name_value"
+
+                request = aiplatform_v1.UpdateEndpointLongRunningRequest(
+                    endpoint=endpoint,
+                )
+
+                # Make the request
+                operation = client.update_endpoint_long_running(request=request)
+
+                print("Waiting for operation to complete...")
+
+                response = (await operation).result()
+
+                # Handle the response
+                print(response)
+
+        Args:
+            request (Optional[Union[google.cloud.aiplatform_v1.types.UpdateEndpointLongRunningRequest, dict]]):
+                The request object. Request message for
+                [EndpointService.UpdateEndpointLongRunning][google.cloud.aiplatform.v1.EndpointService.UpdateEndpointLongRunning].
+            endpoint (:class:`google.cloud.aiplatform_v1.types.Endpoint`):
+                Required. The Endpoint which replaces the resource on
+                the server. Currently we only support updating the
+                ``client_connection_config`` field, all the other
+                fields' update will be blocked.
+
+                This corresponds to the ``endpoint`` 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.api_core.operation_async.AsyncOperation:
+                An object representing a long-running operation.
+
+                The result type for the operation will be :class:`google.cloud.aiplatform_v1.types.Endpoint` Models are deployed into it, and afterwards Endpoint is called to obtain
+                   predictions and explanations.
+
+        """
+        # 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([endpoint])
+        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, endpoint_service.UpdateEndpointLongRunningRequest):
+            request = endpoint_service.UpdateEndpointLongRunningRequest(request)
+
+        # If we have keyword arguments corresponding to fields on the
+        # request, apply these.
+        if endpoint is not None:
+            request.endpoint = endpoint
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._client._transport._wrapped_methods[self._client._transport.update_endpoint_long_running]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((
+                ("endpoint.name", request.endpoint.name),
+            )),
+        )
+
+        # Validate the universe domain.
+        self._client._validate_universe_domain()
+
+        # Send the request.
+        response = await rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Wrap the response in an operation future.
+        response = operation_async.from_gapic(
+            response,
+            self._client._transport.operations_client,
+            gca_endpoint.Endpoint,
+            metadata_type=endpoint_service.UpdateEndpointOperationMetadata,
+        )
+
+        # Done; return the response.
+        return response
+
     async def delete_endpoint(self,
             request: Optional[Union[endpoint_service.DeleteEndpointRequest, dict]] = None,
             *,

owl-bot-staging/v1/google/cloud/aiplatform_v1/services/endpoint_service/client.py

@@ -1134,6 +1134,127 @@ def sample_update_endpoint():
         # Done; return the response.
         return response
 
+    def update_endpoint_long_running(self,
+            request: Optional[Union[endpoint_service.UpdateEndpointLongRunningRequest, dict]] = None,
+            *,
+            endpoint: Optional[gca_endpoint.Endpoint] = None,
+            retry: OptionalRetry = gapic_v1.method.DEFAULT,
+            timeout: Union[float, object] = gapic_v1.method.DEFAULT,
+            metadata: Sequence[Tuple[str, str]] = (),
+            ) -> gac_operation.Operation:
+        r"""Updates an Endpoint with a long running operation.
+
+        .. 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 aiplatform_v1
+
+            def sample_update_endpoint_long_running():
+                # Create a client
+                client = aiplatform_v1.EndpointServiceClient()
+
+                # Initialize request argument(s)
+                endpoint = aiplatform_v1.Endpoint()
+                endpoint.display_name = "display_name_value"
+
+                request = aiplatform_v1.UpdateEndpointLongRunningRequest(
+                    endpoint=endpoint,
+                )
+
+                # Make the request
+                operation = client.update_endpoint_long_running(request=request)
+
+                print("Waiting for operation to complete...")
+
+                response = operation.result()
+
+                # Handle the response
+                print(response)
+
+        Args:
+            request (Union[google.cloud.aiplatform_v1.types.UpdateEndpointLongRunningRequest, dict]):
+                The request object. Request message for
+                [EndpointService.UpdateEndpointLongRunning][google.cloud.aiplatform.v1.EndpointService.UpdateEndpointLongRunning].
+            endpoint (google.cloud.aiplatform_v1.types.Endpoint):
+                Required. The Endpoint which replaces the resource on
+                the server. Currently we only support updating the
+                ``client_connection_config`` field, all the other
+                fields' update will be blocked.
+
+                This corresponds to the ``endpoint`` 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.api_core.operation.Operation:
+                An object representing a long-running operation.
+
+                The result type for the operation will be :class:`google.cloud.aiplatform_v1.types.Endpoint` Models are deployed into it, and afterwards Endpoint is called to obtain
+                   predictions and explanations.
+
+        """
+        # 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([endpoint])
+        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, endpoint_service.UpdateEndpointLongRunningRequest):
+            request = endpoint_service.UpdateEndpointLongRunningRequest(request)
+            # If we have keyword arguments corresponding to fields on the
+            # request, apply these.
+            if endpoint is not None:
+                request.endpoint = endpoint
+
+        # Wrap the RPC method; this adds retry and timeout information,
+        # and friendly error handling.
+        rpc = self._transport._wrapped_methods[self._transport.update_endpoint_long_running]
+
+        # Certain fields should be provided within the metadata header;
+        # add these here.
+        metadata = tuple(metadata) + (
+            gapic_v1.routing_header.to_grpc_metadata((
+                ("endpoint.name", request.endpoint.name),
+            )),
+        )
+
+        # Validate the universe domain.
+        self._validate_universe_domain()
+
+        # Send the request.
+        response = rpc(
+            request,
+            retry=retry,
+            timeout=timeout,
+            metadata=metadata,
+        )
+
+        # Wrap the response in an operation future.
+        response = gac_operation.from_gapic(
+            response,
+            self._transport.operations_client,
+            gca_endpoint.Endpoint,
+            metadata_type=endpoint_service.UpdateEndpointOperationMetadata,
+        )
+
+        # Done; return the response.
+        return response
+
     def delete_endpoint(self,
             request: Optional[Union[endpoint_service.DeleteEndpointRequest, dict]] = None,
             *,

owl-bot-staging/v1/google/cloud/aiplatform_v1/services/endpoint_service/transports/base.py

@@ -146,6 +146,11 @@ def _prep_wrapped_messages(self, client_info):
                 default_timeout=None,
                 client_info=client_info,
             ),
+            self.update_endpoint_long_running: gapic_v1.method.wrap_method(
+                self.update_endpoint_long_running,
+                default_timeout=None,
+                client_info=client_info,
+            ),
             self.delete_endpoint: gapic_v1.method.wrap_method(
                 self.delete_endpoint,
                 default_timeout=None,
@@ -268,6 +273,15 @@ def update_endpoint(self) -> Callable[
             ]]:
         raise NotImplementedError()
 
+    @property
+    def update_endpoint_long_running(self) -> Callable[
+            [endpoint_service.UpdateEndpointLongRunningRequest],
+            Union[
+                operations_pb2.Operation,
+                Awaitable[operations_pb2.Operation]
+            ]]:
+        raise NotImplementedError()
+
     @property
     def delete_endpoint(self) -> Callable[
             [endpoint_service.DeleteEndpointRequest],