Struct IndexService 

pub struct IndexService { /* private fields */ }

Available on crate feature index-service only.

Implements a client for the Vertex AI API.

Example

let client = IndexService::builder().build().await?;
// use `client` to make requests to the Vertex AI API.

Service Description

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

Configuration

To configure IndexService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

• with_endpoint(): by default this client uses the global default endpoint (https://aiplatform.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
• with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

Pooling and Cloning

IndexService holds a connection pool internally, it is advised to create one and the reuse it. You do not need to wrap IndexService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations

impl IndexService

pub fn builder() -> ClientBuilder

Returns a builder for IndexService.

let client = IndexService::builder().build().await?;

pub fn from_stub<T>(stub: T) -> Self

where T: IndexService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

pub fn create_index(&self) -> CreateIndex

Creates an Index.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn get_index(&self) -> GetIndex

Gets an Index.

pub fn list_indexes(&self) -> ListIndexes

Lists Indexes in a Location.

pub fn update_index(&self) -> UpdateIndex

Updates an Index.

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn delete_index(&self) -> DeleteIndex

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

Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

pub fn upsert_datapoints(&self) -> UpsertDatapoints

Add/update Datapoints into an Index.

pub fn remove_datapoints(&self) -> RemoveDatapoints

Remove Datapoints from an Index.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

pub fn wait_operation(&self) -> WaitOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for IndexService

fn clone(&self) -> IndexService

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IndexService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.