Struct DatasetService

pub struct DatasetService { /* private fields */ }

Available on crate feature dataset-service only.

Implements a client for the Vertex AI API.

Example

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

Service Description

The service that manages Vertex AI Dataset and its child resources.

Configuration

To configure DatasetService 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

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

Implementations

impl DatasetService

pub fn builder() -> ClientBuilder

Returns a builder for DatasetService.

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

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

where T: DatasetService + '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_dataset(&self) -> CreateDataset

Creates a Dataset.

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_dataset(&self) -> GetDataset

Gets a Dataset.

pub fn update_dataset(&self) -> UpdateDataset

Updates a Dataset.

pub fn list_datasets(&self) -> ListDatasets

Lists Datasets in a Location.

pub fn delete_dataset(&self) -> DeleteDataset

Deletes a Dataset.

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 import_data(&self) -> ImportData

Imports data into a Dataset.

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 export_data(&self) -> ExportData

Exports data from a Dataset.

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 create_dataset_version(&self) -> CreateDatasetVersion

Create a version from a Dataset.

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 update_dataset_version(&self) -> UpdateDatasetVersion

Updates a DatasetVersion.

pub fn delete_dataset_version(&self) -> DeleteDatasetVersion

Deletes a Dataset version.

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_dataset_version(&self) -> GetDatasetVersion

Gets a Dataset version.

pub fn list_dataset_versions(&self) -> ListDatasetVersions

Lists DatasetVersions in a Dataset.

pub fn restore_dataset_version(&self) -> RestoreDatasetVersion

Restores a dataset version.

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 list_data_items(&self) -> ListDataItems

Lists DataItems in a Dataset.

pub fn search_data_items(&self) -> SearchDataItems

Searches DataItems in a Dataset.

pub fn list_saved_queries(&self) -> ListSavedQueries

Lists SavedQueries in a Dataset.

pub fn delete_saved_query(&self) -> DeleteSavedQuery

Deletes a SavedQuery.

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_annotation_spec(&self) -> GetAnnotationSpec

Gets an AnnotationSpec.

pub fn list_annotations(&self) -> ListAnnotations

Lists Annotations belongs to a dataitem This RPC is only available in InternalDatasetService. It is only used for exporting conversation data to CCAI Insights.

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 DatasetService

fn clone(&self) -> DatasetService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DatasetService

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

Formats the value using the given formatter.