def create_index_endpoint(
self,
request: index_endpoint_service.CreateIndexEndpointRequest = None,
*,
parent: str = None,
index_endpoint: gca_index_endpoint.IndexEndpoint = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> gac_operation.Operation:
r"""Creates an IndexEndpoint.
Args:
request (google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointRequest):
The request object. Request message for
[IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint].
parent (str):
Required. The resource name of the Location to create
the IndexEndpoint in. Format:
``projects/{project}/locations/{location}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
index_endpoint (google.cloud.aiplatform_v1beta1.types.IndexEndpoint):
Required. The IndexEndpoint to
create.
This corresponds to the ``index_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_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([parent, index_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.')
# Minor optimization to avoid making a copy if the user passes
# in a index_endpoint_service.CreateIndexEndpointRequest.
# 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.CreateIndexEndpointRequest):
request = index_endpoint_service.CreateIndexEndpointRequest(
request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if index_endpoint is not None:
request.index_endpoint = index_endpoint
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = self._transport._wrapped_methods[
self._transport.create_index_endpoint]
# Certain fields should be provided within the metadata header;
# add these here.
metadata = tuple(metadata) + (gapic_v1.routing_header.to_grpc_metadata(
(("parent", request.parent), )), )
# 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_index_endpoint.IndexEndpoint,
metadata_type=index_endpoint_service.
CreateIndexEndpointOperationMetadata,
)
# Done; return the response.
return response
async def create_index_endpoint(
self,
request: Union[index_endpoint_service.CreateIndexEndpointRequest, dict] = None,
*,
parent: str = None,
index_endpoint: gca_index_endpoint.IndexEndpoint = None,
retry: OptionalRetry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> operation_async.AsyncOperation:
r"""Creates an IndexEndpoint.
.. code-block:: python
from google.cloud import aiplatform_v1beta1
def sample_create_index_endpoint():
# Create a client
client = aiplatform_v1beta1.IndexEndpointServiceClient()
# Initialize request argument(s)
index_endpoint = aiplatform_v1beta1.IndexEndpoint()
index_endpoint.display_name = "display_name_value"
request = aiplatform_v1beta1.CreateIndexEndpointRequest(
parent="parent_value",
index_endpoint=index_endpoint,
)
# Make the request
operation = client.create_index_endpoint(request=request)
print("Waiting for operation to complete...")
response = operation.result()
# Handle the response
print(response)
Args:
request (Union[google.cloud.aiplatform_v1beta1.types.CreateIndexEndpointRequest, dict]):
The request object. Request message for
[IndexEndpointService.CreateIndexEndpoint][google.cloud.aiplatform.v1beta1.IndexEndpointService.CreateIndexEndpoint].
parent (:class:`str`):
Required. The resource name of the Location to create
the IndexEndpoint in. Format:
``projects/{project}/locations/{location}``
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
index_endpoint (:class:`google.cloud.aiplatform_v1beta1.types.IndexEndpoint`):
Required. The IndexEndpoint to
create.
This corresponds to the ``index_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_async.AsyncOperation:
An object representing a long-running operation.
The result type for the operation will be :class:`google.cloud.aiplatform_v1beta1.types.IndexEndpoint` Indexes are deployed into it. An IndexEndpoint can have multiple
DeployedIndexes.
"""
# 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([parent, index_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."
)
request = index_endpoint_service.CreateIndexEndpointRequest(request)
# If we have keyword arguments corresponding to fields on the
# request, apply these.
if parent is not None:
request.parent = parent
if index_endpoint is not None:
request.index_endpoint = index_endpoint
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method_async.wrap_method(
self._client._transport.create_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((("parent", request.parent),)),
)
# 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_index_endpoint.IndexEndpoint,
metadata_type=index_endpoint_service.CreateIndexEndpointOperationMetadata,
)
# Done; return the response.
return response
