Struct TensorboardService

pub struct TensorboardService { /* private fields */ }

Available on crate feature tensorboard-service only.

Implements a client for the Vertex AI API.

Example

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

Service Description

TensorboardService

Configuration

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

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

Implementations

impl TensorboardService

pub fn builder() -> ClientBuilder

Returns a builder for TensorboardService.

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

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

where T: TensorboardService + '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_tensorboard(&self) -> CreateTensorboard

Creates a Tensorboard.

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_tensorboard(&self) -> GetTensorboard

Gets a Tensorboard.

pub fn update_tensorboard(&self) -> UpdateTensorboard

Updates a Tensorboard.

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_tensorboards(&self) -> ListTensorboards

Lists Tensorboards in a Location.

pub fn delete_tensorboard(&self) -> DeleteTensorboard

Deletes a Tensorboard.

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 read_tensorboard_usage(&self) -> ReadTensorboardUsage

Returns a list of monthly active users for a given TensorBoard instance.

pub fn read_tensorboard_size(&self) -> ReadTensorboardSize

Returns the storage size for a given TensorBoard instance.

pub fn create_tensorboard_experiment(&self) -> CreateTensorboardExperiment

Creates a TensorboardExperiment.

pub fn get_tensorboard_experiment(&self) -> GetTensorboardExperiment

Gets a TensorboardExperiment.

pub fn update_tensorboard_experiment(&self) -> UpdateTensorboardExperiment

Updates a TensorboardExperiment.

pub fn list_tensorboard_experiments(&self) -> ListTensorboardExperiments

Lists TensorboardExperiments in a Location.

pub fn delete_tensorboard_experiment(&self) -> DeleteTensorboardExperiment

Deletes a TensorboardExperiment.

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_tensorboard_run(&self) -> CreateTensorboardRun

Creates a TensorboardRun.

pub fn batch_create_tensorboard_runs(&self) -> BatchCreateTensorboardRuns

Batch create TensorboardRuns.

pub fn get_tensorboard_run(&self) -> GetTensorboardRun

Gets a TensorboardRun.

pub fn update_tensorboard_run(&self) -> UpdateTensorboardRun

Updates a TensorboardRun.

pub fn list_tensorboard_runs(&self) -> ListTensorboardRuns

Lists TensorboardRuns in a Location.

pub fn delete_tensorboard_run(&self) -> DeleteTensorboardRun

Deletes a TensorboardRun.

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 batch_create_tensorboard_time_series( &self, ) -> BatchCreateTensorboardTimeSeries

Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.

pub fn create_tensorboard_time_series(&self) -> CreateTensorboardTimeSeries

Creates a TensorboardTimeSeries.

pub fn get_tensorboard_time_series(&self) -> GetTensorboardTimeSeries

Gets a TensorboardTimeSeries.

pub fn update_tensorboard_time_series(&self) -> UpdateTensorboardTimeSeries

Updates a TensorboardTimeSeries.

pub fn list_tensorboard_time_series(&self) -> ListTensorboardTimeSeries

Lists TensorboardTimeSeries in a Location.

pub fn delete_tensorboard_time_series(&self) -> DeleteTensorboardTimeSeries

Deletes a TensorboardTimeSeries.

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 batch_read_tensorboard_time_series_data( &self, ) -> BatchReadTensorboardTimeSeriesData

Reads multiple TensorboardTimeSeries’ data. The data point number limit is 1000 for scalars, 100 for tensors and blob references. If the number of data points stored is less than the limit, all data is returned. Otherwise, the number limit of data points is randomly selected from this time series and returned.

pub fn read_tensorboard_time_series_data(&self) -> ReadTensorboardTimeSeriesData

Reads a TensorboardTimeSeries’ data. By default, if the number of data points stored is less than 1000, all data is returned. Otherwise, 1000 data points is randomly selected from this time series and returned. This value can be changed by changing max_data_points, which can’t be greater than 10k.

pub fn write_tensorboard_experiment_data( &self, ) -> WriteTensorboardExperimentData

Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun’s. If any data fail to be ingested, an error is returned.

pub fn write_tensorboard_run_data(&self) -> WriteTensorboardRunData

Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun. If any data fail to be ingested, an error is returned.

pub fn export_tensorboard_time_series_data( &self, ) -> ExportTensorboardTimeSeriesData

Exports a TensorboardTimeSeries’ data. Data is returned in paginated responses.

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 TensorboardService

fn clone(&self) -> TensorboardService

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TensorboardService

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

Formats the value using the given formatter.