Class IndexServiceAsyncClient (1.21.0)

  IndexServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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
Type Description
IndexServiceTransport The transport used by the client instance.

Methods

IndexServiceAsyncClient

  IndexServiceAsyncClient 
 ( 
 * 
 , 
 credentials 
 : 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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
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.

cancel_operation

  cancel_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 CancelOperationRequest 
 ] 
 = 
 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 
 ]] 
 = 
 ())

Starts asynchronous cancellation on a long-running operation.

The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name Description
request .operations_pb2.CancelOperationRequest

The request object. Request message for CancelOperation method.
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.

 
  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_v1 
 . 
 types 
 . 
 index_service 
 . 
 CreateIndexRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 parent 
 : 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 index 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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.

 # 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_create_index():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

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

    request = aiplatform_v1.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
Name Description
request Union[ google.cloud.aiplatform_v1.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
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 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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.

 # 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_delete_index():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1.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
Name Description
request Union[ google.cloud.aiplatform_v1.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
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); }

delete_operation

  delete_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 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 a long-running operation.

This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name Description
request .operations_pb2.DeleteOperationRequest

The request object. Request message for DeleteOperation method.
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.

 
  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 
 ( 
 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 
 ( 
 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_iam_policy

  get_iam_policy 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 GetIamPolicyRequest 
 ] 
 = 
 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 the IAM access control policy for a function.

Returns an empty policy if the function exists and does not have a policy set.

Parameters
Name Description
request .iam_policy_pb2.GetIamPolicyRequest

The request object. Request message for GetIamPolicy method.
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
.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""> IAM developer's guide __.

get_index

  get_index 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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.

 # 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_get_index():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

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

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[ google.cloud.aiplatform_v1.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
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_location

  get_location 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 GetLocationRequest 
 ] 
 = 
 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 information about a location.

Parameters
Name Description
request .location_pb2.GetLocationRequest

The request object. Request message for GetLocation method.
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
.location_pb2.Location Location object.

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
Name Description
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
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_operation

  get_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 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 the latest state of a long-running operation.

Parameters
Name Description
request .operations_pb2.GetOperationRequest

The request object. Request message for GetOperation method.
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
.operations_pb2.Operation An Operation object.

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_v1 
 . 
 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.

 # 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_list_indexes():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1.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
Name Description
request Union[ google.cloud.aiplatform_v1.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
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.

list_locations

  list_locations 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 location 
 . 
 locations_pb2 
 . 
 ListLocationsRequest 
 ] 
 = 
 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 information about the supported locations for this service.

Parameters
Name Description
request .location_pb2.ListLocationsRequest

The request object. Request message for ListLocations method.
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
.location_pb2.ListLocationsResponse Response message for ListLocations method.

list_operations

  list_operations 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 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 operations that match the specified filter in the request.

Parameters
Name Description
request .operations_pb2.ListOperationsRequest

The request object. Request message for ListOperations method.
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
.operations_pb2.ListOperationsResponse Response message for ListOperations method. 
  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.

remove_datapoints

  remove_datapoints 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 RemoveDatapointsRequest 
 , 
 dict 
 ]] 
 = 
 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 
 ]] 
 = 
 ())

Remove Datapoints from an Index.

 # 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_remove_datapoints():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1.RemoveDatapointsRequest(
        index="index_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[ google.cloud.aiplatform_v1.types.RemoveDatapointsRequest , dict]

The request object. Request message for IndexService.RemoveDatapoints

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.RemoveDatapointsResponse Response message for IndexService.RemoveDatapoints

set_iam_policy

  set_iam_policy 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 SetIamPolicyRequest 
 ] 
 = 
 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 
 ]] 
 = 
 ())

Sets the IAM access control policy on the specified function.

Replaces any existing policy.

Parameters
Name Description
request .iam_policy_pb2.SetIamPolicyRequest

The request object. Request message for SetIamPolicy method.
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
.policy_pb2.Policy Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A Policy is a collection of bindings . A binding binds one or more members to a single role . Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions (defined by IAM or configured by users). A binding can optionally specify a condition , which is a logic expression that further constrains the role binding based on attributes about the request and/or target resource. **JSON Example** :: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": ["user:eve@example.com"], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01t00:00:00.000z')",="" }="" }="" ]="" }="" **yaml="" example**="" ::="" bindings:="" -="" members:="" -="" user:mike@example.com="" -="" group:admins@example.com="" -="" domain:google.com="" -="" serviceaccount:my-project-id@appspot.gserviceaccount.com="" role:="" roles/resourcemanager.organizationadmin="" -="" members:="" -="" user:eve@example.com="" role:="" roles/resourcemanager.organizationviewer="" condition:="" title:="" expirable="" access="" description:="" does="" not="" grant="" access="" after="" sep="" 2020="" expression:="" request.time="">< timestamp('2020-10-01t00:00:00.000z')="" for="" a="" description="" of="" iam="" and="" its="" features,="" see="" the=""> IAM developer's guide __.

test_iam_permissions

  test_iam_permissions 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 iam 
 . 
 v1 
 . 
 iam_policy_pb2 
 . 
 TestIamPermissionsRequest 
 ] 
 = 
 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 
 ]] 
 = 
 ())

Tests the specified IAM permissions against the IAM access control policy for a function.

If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Parameters
Name Description
request .iam_policy_pb2.TestIamPermissionsRequest

The request object. Request message for TestIamPermissions method.
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
.iam_policy_pb2.TestIamPermissionsResponse Response message for TestIamPermissions method.

update_index

  update_index 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 UpdateIndexRequest 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 * 
 , 
 index 
 : 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 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.

 # 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_index():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

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

    request = aiplatform_v1.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
Name Description
request Union[ google.cloud.aiplatform_v1.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
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.

upsert_datapoints

  upsert_datapoints 
 ( 
 request 
 : 
 Optional 
 [ 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 aiplatform_v1 
 . 
 types 
 . 
 index_service 
 . 
 UpsertDatapointsRequest 
 , 
 dict 
 ]] 
 = 
 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 
 ]] 
 = 
 ())

Add/update Datapoints into an Index.

 # 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_upsert_datapoints():
    # Create a client
    client = aiplatform_v1.IndexServiceAsyncClient()

    # Initialize request argument(s)
    request = aiplatform_v1.UpsertDatapointsRequest(
        index="index_value",
    )

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

    # Handle the response
    print(response)
Parameters
Name Description
request Union[ google.cloud.aiplatform_v1.types.UpsertDatapointsRequest , dict]

The request object. Request message for IndexService.UpsertDatapoints

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.UpsertDatapointsResponse Response message for IndexService.UpsertDatapoints

wait_operation

  wait_operation 
 ( 
 request 
 : 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 WaitOperationRequest 
 ] 
 = 
 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 
 ]] 
 = 
 ())

Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state.

If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns google.rpc.Code.UNIMPLEMENTED .

Parameters
Name Description
request .operations_pb2.WaitOperationRequest

The request object. Request message for WaitOperation method.
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
.operations_pb2.Operation An Operation object.