Class IndexServiceClient (2.27.0)

Version 2.27.0

• 2.37.0-rc (latest)
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.1
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0

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

Equality

Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection> objects compare equal. Objects that compare equal share the same underlying resources.

Performance

Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.

Thread Safety

Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.

Constructors

IndexServiceClient(IndexServiceClient const &)

Copy and move support

Parameter
Name	Description
	IndexServiceClient const &

IndexServiceClient(IndexServiceClient &&)

Copy and move support

Parameter
Name	Description
	IndexServiceClient &&

IndexServiceClient(std::shared_ptr< IndexServiceConnection >, Options)

Parameters
Name	Description
connection	std::shared_ptr< IndexServiceConnection >
opts	Options

Operators

operator=(IndexServiceClient const &)

Copy and move support

Parameter
Name	Description
	IndexServiceClient const &

Returns
Type	Description
IndexServiceClient &

operator=(IndexServiceClient &&)

Copy and move support

Parameter
Name	Description
	IndexServiceClient &&

Returns
Type	Description
IndexServiceClient &

Functions

CreateIndex(std::string const &, google::cloud::aiplatform::v1::Index const &, Options)

Creates an Index.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Location to create the Index in. Format: projects/{project}/locations/{location}
index	google::cloud::aiplatform::v1::Index const & Required. The Index to create.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.Index proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateIndex(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::Index const &, Options)

Creates an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
parent	std::string const &
index	google::cloud::aiplatform::v1::Index const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateIndex(google::cloud::aiplatform::v1::CreateIndexRequest const &, Options)

Creates an Index.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::CreateIndexRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateIndexRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.Index proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateIndex(NoAwaitTag, google::cloud::aiplatform::v1::CreateIndexRequest const &, Options)

Creates an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::CreateIndexRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

CreateIndex(google::longrunning::Operation const &, Options)

Creates an Index.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >

GetIndex(std::string const &, Options)

Gets an Index.

Parameters
Name	Description
name	std::string const & Required. The name of the Index resource. Format: projects/{project}/locations/{location}/indexes/{index}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::Index >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Index) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetIndex(google::cloud::aiplatform::v1::GetIndexRequest const &, Options)

Gets an Index.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::GetIndexRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetIndexRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::Index >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.Index) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListIndexes(std::string const &, Options)

Lists Indexes in a Location.

Parameters
Name	Description
parent	std::string const & Required. The resource name of the Location from which to list the Indexes. Format: projects/{project}/locations/{location}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::Index >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Index, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListIndexes(google::cloud::aiplatform::v1::ListIndexesRequest, Options)

Lists Indexes in a Location.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::ListIndexesRequest Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListIndexesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StreamRange< google::cloud::aiplatform::v1::Index >	a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.aiplatform.v1.Index, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

UpdateIndex(google::cloud::aiplatform::v1::Index const &, google::protobuf::FieldMask const &, Options)

Updates an Index.

Parameters
Name	Description
index	google::cloud::aiplatform::v1::Index const & Required. The Index which updates the resource on the server.
update_mask	google::protobuf::FieldMask const & The update mask applies to the resource. For the FieldMask definition, see google.protobuf.FieldMask.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.Index proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateIndex(NoAwaitTag, google::cloud::aiplatform::v1::Index const &, google::protobuf::FieldMask const &, Options)

Updates an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
index	google::cloud::aiplatform::v1::Index const &
update_mask	google::protobuf::FieldMask const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateIndex(google::cloud::aiplatform::v1::UpdateIndexRequest const &, Options)

Updates an Index.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::UpdateIndexRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateIndexRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.Index proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateIndex(NoAwaitTag, google::cloud::aiplatform::v1::UpdateIndexRequest const &, Options)

Updates an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::UpdateIndexRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

UpdateIndex(google::longrunning::Operation const &, Options)

Updates an Index.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::Index > >

DeleteIndex(std::string const &, Options)

Deletes an Index.

An Index can only be deleted when all its DeployedIndexes had been undeployed.

Parameters
Name	Description
name	std::string const & Required. The name of the Index resource to be deleted. Format: projects/{project}/locations/{location}/indexes/{index}
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteIndex(NoAwaitTag, std::string const &, Options)

Deletes an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
name	std::string const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteIndex(google::cloud::aiplatform::v1::DeleteIndexRequest const &, Options)

Deletes an Index.

An Index can only be deleted when all its DeployedIndexes had been undeployed.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::DeleteIndexRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteIndexRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.aiplatform.v1.DeleteOperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteIndex(NoAwaitTag, google::cloud::aiplatform::v1::DeleteIndexRequest const &, Options)

Deletes an Index.

Specifying the NoAwaitTag immediately returns the [google::longrunning::Operation] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.

Parameters
Name	Description
	NoAwaitTag
request	google::cloud::aiplatform::v1::DeleteIndexRequest const &
opts	Options

Returns
Type	Description
StatusOr< google::longrunning::Operation >

DeleteIndex(google::longrunning::Operation const &, Options)

Deletes an Index.

This method accepts a google::longrunning::Operation that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.

Parameters
Name	Description
operation	google::longrunning::Operation const &
opts	Options

Returns
Type	Description
future< StatusOr< google::cloud::aiplatform::v1::DeleteOperationMetadata > >

UpsertDatapoints(google::cloud::aiplatform::v1::UpsertDatapointsRequest const &, Options)

Add/update Datapoints into an Index.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::UpsertDatapointsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpsertDatapointsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::UpsertDatapointsResponse >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.UpsertDatapointsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

RemoveDatapoints(google::cloud::aiplatform::v1::RemoveDatapointsRequest const &, Options)

Remove Datapoints from an Index.

Parameters
Name	Description
request	google::cloud::aiplatform::v1::RemoveDatapointsRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.RemoveDatapointsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
opts	Options Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type	Description
StatusOr< google::cloud::aiplatform::v1::RemoveDatapointsResponse >	the result of the RPC. The response message type (google.cloud.aiplatform.v1.RemoveDatapointsResponse) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.