BareMetalSolution

Struct BareMetalSolution 

Source
pub struct BareMetalSolution { /* private fields */ }
Expand description

Implements a client for the Bare Metal Solution API.

§Example

let client = BareMetalSolution::builder().build().await?;
// use `client` to make requests to the Bare Metal Solution API.

§Service Description

Performs management operations on Bare Metal Solution servers.

The baremetalsolution.googleapis.com service provides management capabilities for Bare Metal Solution servers. To access the API methods, you must assign Bare Metal Solution IAM roles containing the desired permissions to your staff in your Google Cloud project. You must also enable the Bare Metal Solution API. Once enabled, the methods act upon specific servers in your Bare Metal Solution environment.

§Configuration

To configure BareMetalSolution 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://baremetalsolution.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

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

Implementations§

Source§

impl BareMetalSolution

Source

pub fn builder() -> ClientBuilder

Returns a builder for BareMetalSolution.

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

pub fn from_stub<T>(stub: T) -> Self
where T: BareMetalSolution + '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.

Source

pub fn list_instances(&self) -> ListInstances

List servers in a given project and location.

Source

pub fn get_instance(&self) -> GetInstance

Get details about a single server.

Source

pub fn update_instance(&self) -> UpdateInstance

Update details of a single server.

§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.

Source

pub fn rename_instance(&self) -> RenameInstance

RenameInstance sets a new name for an instance. Use with caution, previous names become immediately invalidated.

Source

pub fn reset_instance(&self) -> ResetInstance

Perform an ungraceful, hard reset on a server. Equivalent to shutting the power off and then turning it back on.

§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.

Source

pub fn start_instance(&self) -> StartInstance

Starts a server that was shutdown.

§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.

Source

pub fn stop_instance(&self) -> StopInstance

Stop a running server.

§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.

Source

pub fn enable_interactive_serial_console( &self, ) -> EnableInteractiveSerialConsole

Enable the interactive serial console feature on an instance.

§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.

Source

pub fn disable_interactive_serial_console( &self, ) -> DisableInteractiveSerialConsole

Disable the interactive serial console feature on an instance.

§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.

Source

pub fn detach_lun(&self) -> DetachLun

Detach LUN from Instance.

§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.

Source

pub fn list_ssh_keys(&self) -> ListSSHKeys

Lists the public SSH keys registered for the specified project. These SSH keys are used only for the interactive serial console feature.

Source

pub fn create_ssh_key(&self) -> CreateSSHKey

Register a public SSH key in the specified project for use with the interactive serial console feature.

Source

pub fn delete_ssh_key(&self) -> DeleteSSHKey

Deletes a public SSH key registered in the specified project.

Source

pub fn list_volumes(&self) -> ListVolumes

List storage volumes in a given project and location.

Source

pub fn get_volume(&self) -> GetVolume

Get details of a single storage volume.

Source

pub fn update_volume(&self) -> UpdateVolume

Update details of a single storage volume.

§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.

Source

pub fn rename_volume(&self) -> RenameVolume

RenameVolume sets a new name for a volume. Use with caution, previous names become immediately invalidated.

Source

pub fn evict_volume(&self) -> EvictVolume

Skips volume’s cooloff and deletes it now. Volume must be in cooloff state.

§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.

Source

pub fn resize_volume(&self) -> ResizeVolume

Emergency Volume resize.

§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.

Source

pub fn list_networks(&self) -> ListNetworks

List network in a given project and location.

Source

pub fn list_network_usage(&self) -> ListNetworkUsage

List all Networks (and used IPs for each Network) in the vendor account associated with the specified project.

Source

pub fn get_network(&self) -> GetNetwork

Get details of a single network.

Source

pub fn update_network(&self) -> UpdateNetwork

Update details of a single network.

§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.

Source

pub fn create_volume_snapshot(&self) -> CreateVolumeSnapshot

Takes a snapshot of a boot volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

Source

pub fn restore_volume_snapshot(&self) -> RestoreVolumeSnapshot

Uses the specified snapshot to restore its parent volume. Returns INVALID_ARGUMENT if called for a non-boot volume.

§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.

Source

pub fn delete_volume_snapshot(&self) -> DeleteVolumeSnapshot

Deletes a volume snapshot. Returns INVALID_ARGUMENT if called for a non-boot volume.

Source

pub fn get_volume_snapshot(&self) -> GetVolumeSnapshot

Returns the specified snapshot resource. Returns INVALID_ARGUMENT if called for a non-boot volume.

Source

pub fn list_volume_snapshots(&self) -> ListVolumeSnapshots

Retrieves the list of snapshots for the specified volume. Returns a response with an empty list of snapshots if called for a non-boot volume.

Source

pub fn get_lun(&self) -> GetLun

Get details of a single storage logical unit number(LUN).

Source

pub fn list_luns(&self) -> ListLuns

List storage volume luns for given storage volume.

Source

pub fn evict_lun(&self) -> EvictLun

Skips lun’s cooloff and deletes it now. Lun must be in cooloff state.

§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.

Source

pub fn get_nfs_share(&self) -> GetNfsShare

Get details of a single NFS share.

Source

pub fn list_nfs_shares(&self) -> ListNfsShares

List NFS shares.

Source

pub fn update_nfs_share(&self) -> UpdateNfsShare

Update details of a single NFS share.

§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.

Source

pub fn create_nfs_share(&self) -> CreateNfsShare

Create an NFS share.

§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.

Source

pub fn rename_nfs_share(&self) -> RenameNfsShare

RenameNfsShare sets a new name for an nfsshare. Use with caution, previous names become immediately invalidated.

Source

pub fn delete_nfs_share(&self) -> DeleteNfsShare

Delete an NFS share. The underlying volume is automatically deleted.

§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.

Source

pub fn list_provisioning_quotas(&self) -> ListProvisioningQuotas

List the budget details to provision resources on a given project.

Source

pub fn submit_provisioning_config(&self) -> SubmitProvisioningConfig

Submit a provisiong configuration for a given project.

Source

pub fn get_provisioning_config(&self) -> GetProvisioningConfig

Get ProvisioningConfig by name.

Source

pub fn create_provisioning_config(&self) -> CreateProvisioningConfig

Create new ProvisioningConfig.

Source

pub fn update_provisioning_config(&self) -> UpdateProvisioningConfig

Update existing ProvisioningConfig.

Source

pub fn rename_network(&self) -> RenameNetwork

RenameNetwork sets a new name for a network. Use with caution, previous names become immediately invalidated.

Source

pub fn list_os_images(&self) -> ListOSImages

Retrieves the list of OS images which are currently approved.

Source

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

Source

pub fn get_location(&self) -> GetLocation

Gets information about a location.

Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

Trait Implementations§

Source§

impl Clone for BareMetalSolution

Source§

fn clone(&self) -> BareMetalSolution

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BareMetalSolution

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more