def update_index_endpoint(
self,
request: index_endpoint_service.UpdateIndexEndpointRequest = None,
*,
index_endpoint: gca_index_endpoint.IndexEndpoint = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gca_index_endpoint.IndexEndpoint:
r"""Updates an IndexEndpoint.
Args:
request (google.cloud.aiplatform_v1beta1.types.UpdateIndexEndpointRequest):
The request object. Request message for
[IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint].
index_endpoint (google.cloud.aiplatform_v1beta1.types.IndexEndpoint):
Required. The IndexEndpoint which
replaces the resource on the server.
This corresponds to the ``index_endpoint`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (google.protobuf.field_mask_pb2.FieldMask):
Required. The update mask applies to the resource. See
[google.protobuf.FieldMask][google.protobuf.FieldMask].
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.aiplatform_v1beta1.types.IndexEndpoint:
Indexes are deployed into it. An
IndexEndpoint can have multiple
DeployedIndexes.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([index_endpoint, 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.')
# Minor optimization to avoid making a copy if the user passes
# in a index_endpoint_service.UpdateIndexEndpointRequest.
# There's no risk of modifying the input as we've already verified
# there are no flattened fields.
if not isinstance(request,
index_endpoint_service.UpdateIndexEndpointRequest):
request = index_endpoint_service.UpdateIndexEndpointRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if index_endpoint is not None:
request.index_endpoint = index_endpoint
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_index_endpoint]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("index_endpoint.name", request.index_endpoint.name), )), )
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
async def update_index_endpoint(
self,
request: index_endpoint_service.UpdateIndexEndpointRequest = None,
*,
index_endpoint: gca_index_endpoint.IndexEndpoint = None,
update_mask: field_mask_pb2.FieldMask = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gca_index_endpoint.IndexEndpoint:
r"""Updates an IndexEndpoint.
Args:
request (:class:`google.cloud.aiplatform_v1beta1.types.UpdateIndexEndpointRequest`):
The request object. Request message for
[IndexEndpointService.UpdateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.UpdateIndexEndpoint].
index_endpoint (:class:`google.cloud.aiplatform_v1beta1.types.IndexEndpoint`):
Required. The IndexEndpoint which
replaces the resource on the server.
This corresponds to the ``index_endpoint`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
update_mask (:class:`google.protobuf.field_mask_pb2.FieldMask`):
Required. The update mask applies to the resource. See
`FieldMask <https://tinyurl.com/protobufs/google.protobuf#fieldmask>`__.
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.aiplatform_v1beta1.types.IndexEndpoint:
Indexes are deployed into it. An
IndexEndpoint can have multiple
DeployedIndexes.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
has_flattened_params = any([index_endpoint, 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."
)
request = index_endpoint_service.UpdateIndexEndpointRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if index_endpoint is not None:
request.index_endpoint = index_endpoint
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 = gapic_v1.method_async.wrap_method(
self._client._transport.update_index_endpoint,
default_timeout=5.0,
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(
(("index_endpoint.name", request.index_endpoint.name),)
),
)
# Send the request.
response = await rpc(request, retry=retry, timeout=timeout, metadata=metadata,)
# Done; return the response.
return response
