Class IndexEndpointServiceClient (2.23.0-rc)

Version latest

• 2.26.0-rc (latest)
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 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 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: projects/{project}/locations/{location}
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 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.IndexEndpoint proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.CreateIndexEndpointRequest. 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::IndexEndpoint > >	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.IndexEndpoint proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetIndexEndpoint(std::string const &, Options)

Gets an IndexEndpoint.

Parameters
Name	Description
name	std::string const & Required. The name of the IndexEndpoint resource. Format: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.GetIndexEndpointRequest. 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::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 StatusOr contains the error details.

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: 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::IndexEndpoint >	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.IndexEndpoint, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.ListIndexEndpointsRequest. 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::IndexEndpoint >	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.IndexEndpoint, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UpdateIndexEndpointRequest. 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::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 StatusOr contains the error details.

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: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeleteIndexEndpointRequest. 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.

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: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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 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.DeployIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.DeployIndexRequest. 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::DeployIndexResponse > >	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.DeployIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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 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.UndeployIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.UndeployIndexRequest. 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::UndeployIndexResponse > >	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.UndeployIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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: projects/{project}/locations/{location}/indexEndpoints/{index_endpoint}
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 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.MutateDeployedIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.aiplatform.v1.MutateDeployedIndexRequest. 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::MutateDeployedIndexResponse > >	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.MutateDeployedIndexResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.