Class IndexServiceAsyncClient (1.13.0)

IndexServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.index_service.transports.base.IndexServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

A service for creating and managing Vertex AI's Index resources.

Inheritance

builtins.object > IndexServiceAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns
TypeDescription
IndexServiceTransportThe transport used by the client instance.

Methods

IndexServiceAsyncClient

IndexServiceAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.aiplatform_v1beta1.services.index_service.transports.base.IndexServiceTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the index service client.

Parameters
NameDescription
credentials Optional[google.auth.credentials.Credentials]

The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.

transport Union[str, `.IndexServiceTransport`]

The transport to use. If set to None, a transport is chosen automatically.

client_options ClientOptions

Custom options for the client. It won't take effect if a transport instance is provided. (1) The api_endpoint property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto switch to the default mTLS endpoint if client certificate is present, this is the default value). However, the api_endpoint property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide client certificate for mutual TLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used.

Exceptions
TypeDescription
google.auth.exceptions.MutualTlsChannelErrorIf mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

create_index

create_index(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_service.CreateIndexRequest, dict]] = None, *, parent: Optional[str] = None, index: Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Creates an Index.

from google.cloud import aiplatform_v1beta1

async def sample_create_index():
    # Create a client
    client = aiplatform_v1beta1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    index = aiplatform_v1beta1.Index()
    index.display_name = "display_name_value"

    request = aiplatform_v1beta1.CreateIndexRequest(
        parent="parent_value",
        index=index,
    )

    # Make the request
    operation = client.create_index(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.aiplatform_v1beta1.types.CreateIndexRequest, dict]

The request object. Request message for IndexService.CreateIndex.

parent `str`

Required. The resource name of the Location to create the Index 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 Index

Required. The Index to create. This corresponds to the index 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Index A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

delete_index

delete_index(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_service.DeleteIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes an Index. An Index can only be deleted when all its xref_DeployedIndexes had been undeployed.

from google.cloud import aiplatform_v1beta1

async def sample_delete_index():
    # Create a client
    client = aiplatform_v1beta1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.DeleteIndexRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_index(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.aiplatform_v1beta1.types.DeleteIndexRequest, dict]

The request object. Request message for IndexService.DeleteIndex.

name `str`

Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index} This corresponds to the name 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be `google.protobuf.empty_pb2.Empty` A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for Empty is empty JSON object {}.

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
IndexServiceAsyncClientThe constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
NameDescription
info dict

The service account private key info.

Returns
TypeDescription
IndexServiceAsyncClientThe constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
NameDescription
filename str

The path to the service account private key json file.

Returns
TypeDescription
IndexServiceAsyncClientThe constructed client.

get_index

get_index(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_service.GetIndexRequest, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an Index.

from google.cloud import aiplatform_v1beta1

async def sample_get_index():
    # Create a client
    client = aiplatform_v1beta1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.GetIndexRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_index(request=request)

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.aiplatform_v1beta1.types.GetIndexRequest, dict]

The request object. Request message for IndexService.GetIndex

name `str`

Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index} This corresponds to the name 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
TypeDescription
google.cloud.aiplatform_v1beta1.types.IndexA representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: Optional[google.api_core.client_options.ClientOptions] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variabel is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
NameDescription
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.

Exceptions
TypeDescription
google.auth.exceptions.MutualTLSChannelErrorIf any errors happen.
Returns
TypeDescription
Tuple[str, Callable[[], Tuple[bytes, bytes]]]returns the API endpoint and the client cert source to use.

get_transport_class

get_transport_class()

Returns an appropriate transport class.

index_endpoint_path

index_endpoint_path(project: str, location: str, index_endpoint: str)

Returns a fully-qualified index_endpoint string.

index_path

index_path(project: str, location: str, index: str)

Returns a fully-qualified index string.

list_indexes

list_indexes(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_service.ListIndexesRequest, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists Indexes in a Location.

from google.cloud import aiplatform_v1beta1

async def sample_list_indexes():
    # Create a client
    client = aiplatform_v1beta1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1beta1.ListIndexesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_indexes(request=request)

    # Handle the response
    async for response in page_result:
        print(response)
Parameters
NameDescription
request Union[google.cloud.aiplatform_v1beta1.types.ListIndexesRequest, dict]

The request object. Request message for IndexService.ListIndexes.

parent `str`

Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location} This corresponds to the parent 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
TypeDescription
google.cloud.aiplatform_v1beta1.services.index_service.pagers.ListIndexesAsyncPagerResponse message for IndexService.ListIndexes. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

parse_index_endpoint_path

parse_index_endpoint_path(path: str)

Parses a index_endpoint path into its component segments.

parse_index_path

parse_index_path(path: str)

Parses a index path into its component segments.

update_index

update_index(request: Optional[Union[google.cloud.aiplatform_v1beta1.types.index_service.UpdateIndexRequest, dict]] = None, *, index: Optional[google.cloud.aiplatform_v1beta1.types.index.Index] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates an Index.

from google.cloud import aiplatform_v1beta1

async def sample_update_index():
    # Create a client
    client = aiplatform_v1beta1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    index = aiplatform_v1beta1.Index()
    index.display_name = "display_name_value"

    request = aiplatform_v1beta1.UpdateIndexRequest(
        index=index,
    )

    # Make the request
    operation = client.update_index(request=request)

    print("Waiting for operation to complete...")

    response = await operation.result()

    # Handle the response
    print(response)
Parameters
NameDescription
request Union[google.cloud.aiplatform_v1beta1.types.UpdateIndexRequest, dict]

The request object. Request message for IndexService.UpdateIndex.

index Index

Required. The Index which updates the resource on the server. This corresponds to the index field on the request instance; if request is provided, this should not be set.

update_mask `google.protobuf.field_mask_pb2.FieldMask`

The update mask applies to the resource. For the FieldMask definition, 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
TypeDescription
google.api_core.operation_async.AsyncOperationAn object representing a long-running operation. The result type for the operation will be Index A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.