Class IndexServiceAsyncClient (1.4.3)

  IndexServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 = 
 None 
 , 
 transport 
 : 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 services 
 . 
 index_service 
 . 
 transports 
 . 
 base 
 . 
 IndexServiceTransport 
 ] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
< module 
 'google.api_core.client_options' 
 from 
 '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py' 
> = 
 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

Type	Description
IndexServiceTransport	The transport used by the client instance.

Methods

IndexServiceAsyncClient

  IndexServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 = 
 None 
 , 
 transport 
 : 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 services 
 . 
 index_service 
 . 
 transports 
 . 
 base 
 . 
 IndexServiceTransport 
 ] 
 = 
 'grpc_asyncio' 
 , 
 client_options 
 : 
< module 
 'google.api_core.client_options' 
 from 
 '/workspace/python-aiplatform/.nox/docfx/lib/python3.8/site-packages/google/api_core/client_options.py' 
> = 
 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

Name	Description
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

Type	Description
google.auth.exceptions.MutualTlsChannelError	If 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 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 CreateIndexRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 index 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index 
 . 
 Index 
 ] 
 = 
 None 
 , 
 retry 
 : 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Optional 
 [ 
 float 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Creates an Index.

Parameters

Name	Description
request	`CreateIndexRequest` 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

Type	Description
google.api_core.operation_async.AsyncOperation	An 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 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 DeleteIndexRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 name 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 = 
< _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.

Parameters

Name	Description
request	`DeleteIndexRequest` 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

Type

Description

google.api_core.operation_async.AsyncOperation

An 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

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
IndexServiceAsyncClient	The 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

Name	Description
info	`dict` The service account private key info.

Returns

Type	Description
IndexServiceAsyncClient	The 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

Name	Description
filename	`str` The path to the service account private key json file.

Returns

Type	Description
IndexServiceAsyncClient	The constructed client.

get_index

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

Gets an Index.

Parameters

Name	Description
request	`GetIndexRequest` 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

Type	Description
google.cloud.aiplatform_v1.types.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.

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 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 ListIndexesRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Optional 
 [ 
 float 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Lists Indexes in a Location.

Parameters

Name	Description
request	`ListIndexesRequest` 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

Type	Description
google.cloud.aiplatform_v1.services.index_service.pagers.ListIndexesAsyncPager	Response 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 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 UpdateIndexRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 index 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index 
 . 
 Index 
 ] 
 = 
 None 
 , 
 update_mask 
 : 
 Optional 
 [ 
 google 
 . 
 protobuf 
 . 
 field_mask_pb2 
 . 
 FieldMask 
 ] 
 = 
 None 
 , 
 retry 
 : 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 Retry 
 = 
< _MethodDefault 
 . 
 _DEFAULT_VALUE 
 : 
< object 
 object 
>> , 
 timeout 
 : 
 Optional 
 [ 
 float 
 ] 
 = 
 None 
 , 
 metadata 
 : 
 Sequence 
 [ 
 Tuple 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 ())

Updates an Index.

Parameters

Name	Description
request	`UpdateIndexRequest` 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

Type	Description
google.api_core.operation_async.AsyncOperation	An 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.