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: |
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 |
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 |
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 |
GetIndex(std::string const &, Options)
Gets an Index.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the Index resource. Format: |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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: |
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 |
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 |
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 |
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 |
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 |
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 |
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 |