Struct CloudDeploy 

pub struct CloudDeploy { /* private fields */ }

Implements a client for the Cloud Deploy API.

Example

let client = CloudDeploy::builder().build().await?;
// use `client` to make requests to the Cloud Deploy API.

Service Description

CloudDeploy service creates and manages Continuous Delivery operations on Google Cloud Platform via Skaffold (https://skaffold.dev).

Configuration

To configure CloudDeploy 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://clouddeploy.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

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

Implementations

impl CloudDeploy

pub fn builder() -> ClientBuilder

Returns a builder for CloudDeploy.

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

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

where T: CloudDeploy + '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_delivery_pipelines(&self) -> ListDeliveryPipelines

Lists DeliveryPipelines in a given project and location.

pub fn get_delivery_pipeline(&self) -> GetDeliveryPipeline

Gets details of a single DeliveryPipeline.

pub fn create_delivery_pipeline(&self) -> CreateDeliveryPipeline

Creates a new DeliveryPipeline 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_delivery_pipeline(&self) -> UpdateDeliveryPipeline

Updates the parameters of a single DeliveryPipeline.

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_delivery_pipeline(&self) -> DeleteDeliveryPipeline

Deletes a single DeliveryPipeline.

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_targets(&self) -> ListTargets

Lists Targets in a given project and location.

pub fn rollback_target(&self) -> RollbackTarget

Creates a Rollout to roll back the specified target.

pub fn get_target(&self) -> GetTarget

Gets details of a single Target.

pub fn create_target(&self) -> CreateTarget

Creates a new Target 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_target(&self) -> UpdateTarget

Updates the parameters of a single Target.

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_target(&self) -> DeleteTarget

Deletes a single Target.

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_custom_target_types(&self) -> ListCustomTargetTypes

Lists CustomTargetTypes in a given project and location.

pub fn get_custom_target_type(&self) -> GetCustomTargetType

Gets details of a single CustomTargetType.

pub fn create_custom_target_type(&self) -> CreateCustomTargetType

Creates a new CustomTargetType 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_custom_target_type(&self) -> UpdateCustomTargetType

Updates a single CustomTargetType.

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_custom_target_type(&self) -> DeleteCustomTargetType

Deletes a single CustomTargetType.

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_releases(&self) -> ListReleases

Lists Releases in a given project and location.

pub fn get_release(&self) -> GetRelease

Gets details of a single Release.

pub fn create_release(&self) -> CreateRelease

Creates a new Release 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 abandon_release(&self) -> AbandonRelease

Abandons a Release in the Delivery Pipeline.

pub fn create_deploy_policy(&self) -> CreateDeployPolicy

Creates a new DeployPolicy 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_deploy_policy(&self) -> UpdateDeployPolicy

Updates the parameters of a single DeployPolicy.

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_deploy_policy(&self) -> DeleteDeployPolicy

Deletes a single DeployPolicy.

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_deploy_policies(&self) -> ListDeployPolicies

Lists DeployPolicies in a given project and location.

pub fn get_deploy_policy(&self) -> GetDeployPolicy

Gets details of a single DeployPolicy.

pub fn approve_rollout(&self) -> ApproveRollout

Approves a Rollout.

pub fn advance_rollout(&self) -> AdvanceRollout

Advances a Rollout in a given project and location.

pub fn cancel_rollout(&self) -> CancelRollout

Cancels a Rollout in a given project and location.

pub fn list_rollouts(&self) -> ListRollouts

Lists Rollouts in a given project and location.

pub fn get_rollout(&self) -> GetRollout

Gets details of a single Rollout.

pub fn create_rollout(&self) -> CreateRollout

Creates a new Rollout 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 ignore_job(&self) -> IgnoreJob

Ignores the specified Job in a Rollout.

pub fn retry_job(&self) -> RetryJob

Retries the specified Job in a Rollout.

pub fn list_job_runs(&self) -> ListJobRuns

Lists JobRuns in a given project and location.

pub fn get_job_run(&self) -> GetJobRun

Gets details of a single JobRun.

pub fn terminate_job_run(&self) -> TerminateJobRun

Terminates a Job Run in a given project and location.

pub fn get_config(&self) -> GetConfig

Gets the configuration for a location.

pub fn create_automation(&self) -> CreateAutomation

Creates a new Automation 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_automation(&self) -> UpdateAutomation

Updates the parameters of a single Automation resource.

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_automation(&self) -> DeleteAutomation

Deletes a single Automation resource.

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_automation(&self) -> GetAutomation

Gets details of a single Automation.

pub fn list_automations(&self) -> ListAutomations

Lists Automations in a given project and location.

pub fn get_automation_run(&self) -> GetAutomationRun

Gets details of a single AutomationRun.

pub fn list_automation_runs(&self) -> ListAutomationRuns

Lists AutomationRuns in a given project and location.

pub fn cancel_automation_run(&self) -> CancelAutomationRun

Cancels an AutomationRun. The state of the AutomationRun after cancelling is CANCELLED. CancelAutomationRun can be called on AutomationRun in the state IN_PROGRESS and PENDING; AutomationRun in a different state returns an FAILED_PRECONDITION error.

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self) -> GetLocation

Gets information about a location.

pub fn set_iam_policy(&self) -> 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) -> 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) -> 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) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self) -> DeleteOperation

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 CloudDeploy

fn clone(&self) -> CloudDeploy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CloudDeploy

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

Formats the value using the given formatter.