A service for managing Vertex AI's IndexEndpoints.
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
IndexEndpointServiceClient(IndexEndpointServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
IndexEndpointServiceClient const &
|
IndexEndpointServiceClient(IndexEndpointServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
IndexEndpointServiceClient &&
|
IndexEndpointServiceClient(std::shared_ptr< IndexEndpointServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< IndexEndpointServiceConnection >
|
opts |
Options
|
Operators
operator=(IndexEndpointServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
IndexEndpointServiceClient const &
|
Returns | |
---|---|
Type | Description |
IndexEndpointServiceClient & |
operator=(IndexEndpointServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
IndexEndpointServiceClient &&
|
Returns | |
---|---|
Type | Description |
IndexEndpointServiceClient & |
Functions
CreateIndexEndpoint(std::string const &, google::cloud::aiplatform::v1::IndexEndpoint const &, Options)
Creates an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location to create the IndexEndpoint in. Format: |
index_endpoint |
google::cloud::aiplatform::v1::IndexEndpoint const &
Required. The IndexEndpoint 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::IndexEndpoint > > |
A |
CreateIndexEndpoint(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::IndexEndpoint const &, Options)
Creates an IndexEndpoint.
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_endpoint |
google::cloud::aiplatform::v1::IndexEndpoint const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateIndexEndpoint(google::cloud::aiplatform::v1::CreateIndexEndpointRequest const &, Options)
Creates an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::CreateIndexEndpointRequest 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::IndexEndpoint > > |
A |
CreateIndexEndpoint(NoAwaitTag, google::cloud::aiplatform::v1::CreateIndexEndpointRequest const &, Options)
Creates an IndexEndpoint.
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::CreateIndexEndpointRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateIndexEndpoint(google::longrunning::Operation const &, Options)
Creates an IndexEndpoint.
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::IndexEndpoint > > |
GetIndexEndpoint(std::string const &, Options)
Gets an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the IndexEndpoint resource. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::IndexEndpoint > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.IndexEndpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetIndexEndpoint(google::cloud::aiplatform::v1::GetIndexEndpointRequest const &, Options)
Gets an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::GetIndexEndpointRequest 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::IndexEndpoint > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.IndexEndpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListIndexEndpoints(std::string const &, Options)
Lists IndexEndpoints in a Location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource name of the Location from which to list the IndexEndpoints. Format: |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::aiplatform::v1::IndexEndpoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListIndexEndpoints(google::cloud::aiplatform::v1::ListIndexEndpointsRequest, Options)
Lists IndexEndpoints in a Location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::ListIndexEndpointsRequest
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::IndexEndpoint > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
UpdateIndexEndpoint(google::cloud::aiplatform::v1::IndexEndpoint const &, google::protobuf::FieldMask const &, Options)
Updates an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
index_endpoint |
google::cloud::aiplatform::v1::IndexEndpoint const &
Required. The IndexEndpoint which replaces the resource on the server. |
update_mask |
google::protobuf::FieldMask const &
Required. The update mask applies to the resource. See google.protobuf.FieldMask. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::aiplatform::v1::IndexEndpoint > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.IndexEndpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateIndexEndpoint(google::cloud::aiplatform::v1::UpdateIndexEndpointRequest const &, Options)
Updates an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UpdateIndexEndpointRequest 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::IndexEndpoint > |
the result of the RPC. The response message type (google.cloud.aiplatform.v1.IndexEndpoint) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteIndexEndpoint(std::string const &, Options)
Deletes an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the IndexEndpoint 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 |
DeleteIndexEndpoint(NoAwaitTag, std::string const &, Options)
Deletes an IndexEndpoint.
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 > |
DeleteIndexEndpoint(google::cloud::aiplatform::v1::DeleteIndexEndpointRequest const &, Options)
Deletes an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeleteIndexEndpointRequest 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 |
DeleteIndexEndpoint(NoAwaitTag, google::cloud::aiplatform::v1::DeleteIndexEndpointRequest const &, Options)
Deletes an IndexEndpoint.
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::DeleteIndexEndpointRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteIndexEndpoint(google::longrunning::Operation const &, Options)
Deletes an IndexEndpoint.
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 > > |
DeployIndex(std::string const &, google::cloud::aiplatform::v1::DeployedIndex const &, Options)
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
Only non-empty Indexes can be deployed.
Parameters | |
---|---|
Name | Description |
index_endpoint |
std::string const &
Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: |
deployed_index |
google::cloud::aiplatform::v1::DeployedIndex const &
Required. The DeployedIndex to be created within the IndexEndpoint. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::DeployIndexResponse > > |
A |
DeployIndex(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::DeployedIndex const &, Options)
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
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_endpoint |
std::string const &
|
deployed_index |
google::cloud::aiplatform::v1::DeployedIndex const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeployIndex(google::cloud::aiplatform::v1::DeployIndexRequest const &, Options)
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
Only non-empty Indexes can be deployed.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::DeployIndexRequest 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::DeployIndexResponse > > |
A |
DeployIndex(NoAwaitTag, google::cloud::aiplatform::v1::DeployIndexRequest const &, Options)
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
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::DeployIndexRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeployIndex(google::longrunning::Operation const &, Options)
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
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::DeployIndexResponse > > |
UndeployIndex(std::string const &, std::string const &, Options)
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
Parameters | |
---|---|
Name | Description |
index_endpoint |
std::string const &
Required. The name of the IndexEndpoint resource from which to undeploy an Index. Format: |
deployed_index_id |
std::string const &
Required. The ID of the DeployedIndex to be undeployed from the IndexEndpoint. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::UndeployIndexResponse > > |
A |
UndeployIndex(NoAwaitTag, std::string const &, std::string const &, Options)
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
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_endpoint |
std::string const &
|
deployed_index_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeployIndex(google::cloud::aiplatform::v1::UndeployIndexRequest const &, Options)
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::UndeployIndexRequest 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::UndeployIndexResponse > > |
A |
UndeployIndex(NoAwaitTag, google::cloud::aiplatform::v1::UndeployIndexRequest const &, Options)
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
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::UndeployIndexRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UndeployIndex(google::longrunning::Operation const &, Options)
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
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::UndeployIndexResponse > > |
MutateDeployedIndex(std::string const &, google::cloud::aiplatform::v1::DeployedIndex const &, Options)
Update an existing DeployedIndex under an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
index_endpoint |
std::string const &
Required. The name of the IndexEndpoint resource into which to deploy an Index. Format: |
deployed_index |
google::cloud::aiplatform::v1::DeployedIndex const &
Required. The DeployedIndex to be updated within the IndexEndpoint. Currently, the updatable fields are [DeployedIndex][automatic_resources] and [DeployedIndex][dedicated_resources] |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::aiplatform::v1::MutateDeployedIndexResponse > > |
A |
MutateDeployedIndex(NoAwaitTag, std::string const &, google::cloud::aiplatform::v1::DeployedIndex const &, Options)
Update an existing DeployedIndex under an IndexEndpoint.
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_endpoint |
std::string const &
|
deployed_index |
google::cloud::aiplatform::v1::DeployedIndex const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
MutateDeployedIndex(google::cloud::aiplatform::v1::MutateDeployedIndexRequest const &, Options)
Update an existing DeployedIndex under an IndexEndpoint.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::aiplatform::v1::MutateDeployedIndexRequest 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::MutateDeployedIndexResponse > > |
A |
MutateDeployedIndex(NoAwaitTag, google::cloud::aiplatform::v1::MutateDeployedIndexRequest const &, Options)
Update an existing DeployedIndex under an IndexEndpoint.
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::MutateDeployedIndexRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
MutateDeployedIndex(google::longrunning::Operation const &, Options)
Update an existing DeployedIndex under an IndexEndpoint.
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::MutateDeployedIndexResponse > > |