Struct EdgeContainer

pub struct EdgeContainer { /* private fields */ }

Implements a client for the Distributed Cloud Edge Container API.

Example

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

Service Description

EdgeContainer API provides management of Kubernetes Clusters on Google Edge Cloud deployments.

Configuration

To configure EdgeContainer 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://edgecontainer.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

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

Implementations

impl EdgeContainer

pub fn builder() -> ClientBuilder

Returns a builder for EdgeContainer.

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

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

where T: EdgeContainer + '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 list_clusters(&self, parent: impl Into<String>) -> ListClusters

Lists Clusters in a given project and location.

pub fn get_cluster(&self, name: impl Into<String>) -> GetCluster

Gets details of a single Cluster.

pub fn create_cluster(&self, parent: impl Into<String>) -> CreateCluster

Creates a new Cluster in a given project and location.

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, cluster: impl Into<Cluster>) -> UpdateCluster

Updates the parameters of a single Cluster.

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

Upgrades a single cluster.

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, name: impl Into<String>) -> DeleteCluster

Deletes a single Cluster.

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 generate_access_token( &self, cluster: impl Into<String>, ) -> GenerateAccessToken

Generates an access token for a Cluster.

pub fn generate_offline_credential( &self, cluster: impl Into<String>, ) -> GenerateOfflineCredential

Generates an offline credential for a Cluster.

pub fn list_node_pools(&self, parent: impl Into<String>) -> ListNodePools

Lists NodePools in a given project and location.

pub fn get_node_pool(&self, name: impl Into<String>) -> GetNodePool

Gets details of a single NodePool.

pub fn create_node_pool(&self, parent: impl Into<String>) -> CreateNodePool

Creates a new NodePool in a given project and location.

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_node_pool(&self, node_pool: impl Into<NodePool>) -> UpdateNodePool

Updates the parameters of a single NodePool.

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

Deletes a single NodePool.

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_machines(&self, parent: impl Into<String>) -> ListMachines

Lists Machines in a given project and location.

pub fn get_machine(&self, name: impl Into<String>) -> GetMachine

Gets details of a single Machine.

pub fn list_vpn_connections( &self, parent: impl Into<String>, ) -> ListVpnConnections

Lists VPN connections in a given project and location.

pub fn get_vpn_connection(&self, name: impl Into<String>) -> GetVpnConnection

Gets details of a single VPN connection.

pub fn create_vpn_connection( &self, parent: impl Into<String>, ) -> CreateVpnConnection

Creates a new VPN connection in a given project and location.

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

Deletes a single VPN connection.

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

Gets the server config.

pub fn list_locations(&self, name: impl Into<String>) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self, name: impl Into<String>) -> GetLocation

Gets information about a location.

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 EdgeContainer

fn clone(&self) -> EdgeContainer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EdgeContainer

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

Formats the value using the given formatter.