Struct ClusterController

pub struct ClusterController { /* private fields */ }

Implements a client for the Cloud Dataproc API.

Example

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

Service Description

The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

Configuration

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

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

Implementations

impl ClusterController

pub fn builder() -> ClientBuilder

Returns a builder for ClusterController.

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

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

where T: ClusterController + '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_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, ) -> CreateCluster

Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata.

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_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> UpdateCluster

Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata. The cluster must be in a RUNNING state or an error is returned.

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 stop_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> StopCluster

Stops a cluster in a project.

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 start_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> StartCluster

Starts a cluster in a project.

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_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> DeleteCluster

Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata.

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_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> GetCluster

Gets the resource representation for a cluster in a project.

pub fn list_clusters( &self, project_id: impl Into<String>, region: impl Into<String>, ) -> ListClusters

Lists all regions/{region}/clusters in a project alphabetically.

pub fn diagnose_cluster( &self, project_id: impl Into<String>, region: impl Into<String>, cluster_name: impl Into<String>, ) -> DiagnoseCluster

Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata. After the operation completes, Operation.response contains DiagnoseClusterResults.

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 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 ClusterController

fn clone(&self) -> ClusterController

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ClusterController

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

Formats the value using the given formatter.