Struct OsConfigService 

pub struct OsConfigService { /* private fields */ }

Implements a client for the OS Config API.

Example

let client = OsConfigService::builder().build().await?;
// use `client` to make requests to the OS Config API.

Service Description

OS Config API

The OS Config service is a server-side component that you can use to manage package installations and patch jobs for virtual machine instances.

Configuration

To configure OsConfigService 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://osconfig.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

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

Implementations

impl OsConfigService

pub fn builder() -> ClientBuilder

Returns a builder for OsConfigService.

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

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

where T: OsConfigService + '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 execute_patch_job(&self) -> ExecutePatchJob

Patch VM instances by creating and running a patch job.

pub fn get_patch_job(&self) -> GetPatchJob

Get the patch job. This can be used to track the progress of an ongoing patch job or review the details of completed jobs.

pub fn cancel_patch_job(&self) -> CancelPatchJob

Cancel a patch job. The patch job must be active. Canceled patch jobs cannot be restarted.

pub fn list_patch_jobs(&self) -> ListPatchJobs

Get a list of patch jobs.

pub fn list_patch_job_instance_details(&self) -> ListPatchJobInstanceDetails

Get a list of instance details for a given patch job.

pub fn create_patch_deployment(&self) -> CreatePatchDeployment

Create an OS Config patch deployment.

pub fn get_patch_deployment(&self) -> GetPatchDeployment

Get an OS Config patch deployment.

pub fn list_patch_deployments(&self) -> ListPatchDeployments

Get a page of OS Config patch deployments.

pub fn delete_patch_deployment(&self) -> DeletePatchDeployment

Delete an OS Config patch deployment.

pub fn update_patch_deployment(&self) -> UpdatePatchDeployment

Update an OS Config patch deployment.

pub fn pause_patch_deployment(&self) -> PausePatchDeployment

Change state of patch deployment to “PAUSED”. Patch deployment in paused state doesn’t generate patch jobs.

pub fn resume_patch_deployment(&self) -> ResumePatchDeployment

Change state of patch deployment back to “ACTIVE”. Patch deployment in active state continues to generate patch jobs.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for OsConfigService

fn clone(&self) -> OsConfigService

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OsConfigService

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

Formats the value using the given formatter.