Struct BatchController

pub struct BatchController { /* private fields */ }

Implements a client for the Cloud Dataproc API.

Example

let client = BatchController::builder().build().await?;
// use `client` to make requests to the {Codec.APITitle}}.

Service Description

The BatchController provides methods to manage batch workloads.

Configuration

To configure BatchController 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://dataproc.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

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

Implementations

impl BatchController

pub fn builder() -> ClientBuilder

Returns a builder for BatchController.

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

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

where T: BatchController + '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_batch(&self, parent: impl Into<String>) -> CreateBatch

Creates a batch workload that executes asynchronously.

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_batch(&self, name: impl Into<String>) -> GetBatch

Gets the batch workload resource representation.

pub fn list_batches(&self, parent: impl Into<String>) -> ListBatches

Lists batch workloads.

pub fn delete_batch(&self, name: impl Into<String>) -> DeleteBatch

Deletes the batch workload resource. If the batch is not in terminal state, the delete fails and the response returns FAILED_PRECONDITION.

pub fn set_iam_policy(&self, resource: impl Into<String>) -> 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, resource: impl Into<String>) -> 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, resource: impl Into<String>, ) -> 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, name: impl Into<String>) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self, name: impl Into<String>) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self, name: impl Into<String>) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self, name: impl Into<String>) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for BatchController

fn clone(&self) -> BatchController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatchController

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

Formats the value using the given formatter.