OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-01-05 19:16:24 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
beaeeea41c9b7ddd3ac8e470a1a93e6fdc1962ed
google-apis-rs/gen/clouddeploy1/README.md
Sebastian Thiel 1216fcf695 set version 5.0.4 and publish APIs
2024-03-05 21:02:48 +01:00

202 lines
19 KiB
Markdown
Raw Blame History

<!---
DO NOT EDIT !
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
DO NOT EDIT !
-->
The `google-clouddeploy1` library allows access to all features of the *Google Cloud Deploy* service.
This documentation was generated from *Cloud Deploy* crate version *5.0.4+20240221*, where *20240221* is the exact revision of the *clouddeploy:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
Everything else about the *Cloud Deploy* *v1* API can be found at the
[official documentation site](https://cloud.google.com/deploy/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/CloudDeploy) ...
* projects
* [*locations custom target types create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeCreateCall), [*locations custom target types delete*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeDeleteCall), [*locations custom target types get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeGetCall), [*locations custom target types get iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeGetIamPolicyCall), [*locations custom target types list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeListCall), [*locations custom target types patch*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypePatchCall), [*locations custom target types set iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationCustomTargetTypeSetIamPolicyCall), [*locations delivery pipelines automation runs cancel*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationRunCancelCall), [*locations delivery pipelines automation runs get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationRunGetCall), [*locations delivery pipelines automation runs list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationRunListCall), [*locations delivery pipelines automations create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationCreateCall), [*locations delivery pipelines automations delete*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationDeleteCall), [*locations delivery pipelines automations get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationGetCall), [*locations delivery pipelines automations list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationListCall), [*locations delivery pipelines automations patch*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineAutomationPatchCall), [*locations delivery pipelines create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineCreateCall), [*locations delivery pipelines delete*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineDeleteCall), [*locations delivery pipelines get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineGetCall), [*locations delivery pipelines get iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineGetIamPolicyCall), [*locations delivery pipelines list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineListCall), [*locations delivery pipelines patch*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelinePatchCall), [*locations delivery pipelines releases abandon*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseAbandonCall), [*locations delivery pipelines releases create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseCreateCall), [*locations delivery pipelines releases get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseGetCall), [*locations delivery pipelines releases list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseListCall), [*locations delivery pipelines releases rollouts advance*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutAdvanceCall), [*locations delivery pipelines releases rollouts approve*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutApproveCall), [*locations delivery pipelines releases rollouts cancel*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutCancelCall), [*locations delivery pipelines releases rollouts create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutCreateCall), [*locations delivery pipelines releases rollouts get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutGetCall), [*locations delivery pipelines releases rollouts ignore job*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutIgnoreJobCall), [*locations delivery pipelines releases rollouts job runs get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutJobRunGetCall), [*locations delivery pipelines releases rollouts job runs list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutJobRunListCall), [*locations delivery pipelines releases rollouts job runs terminate*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutJobRunTerminateCall), [*locations delivery pipelines releases rollouts list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutListCall), [*locations delivery pipelines releases rollouts retry job*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineReleaseRolloutRetryJobCall), [*locations delivery pipelines rollback target*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineRollbackTargetCall), [*locations delivery pipelines set iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineSetIamPolicyCall), [*locations delivery pipelines test iam permissions*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationDeliveryPipelineTestIamPermissionCall), [*locations get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationGetCall), [*locations get config*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationGetConfigCall), [*locations list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationListCall), [*locations operations cancel*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationOperationCancelCall), [*locations operations delete*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationOperationDeleteCall), [*locations operations get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationOperationGetCall), [*locations operations list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationOperationListCall), [*locations targets create*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetCreateCall), [*locations targets delete*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetDeleteCall), [*locations targets get*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetGetCall), [*locations targets get iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetGetIamPolicyCall), [*locations targets list*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetListCall), [*locations targets patch*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetPatchCall), [*locations targets set iam policy*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetSetIamPolicyCall) and [*locations targets test iam permissions*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/api::ProjectLocationTargetTestIamPermissionCall)
# Structure of this Library
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/CloudDeploy)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::CallBuilder)
* **[Resources](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
Generally speaking, you can invoke *Activities* like this:
```Rust,ignore
let r = hub.resource().activity(...).doit().await
```
Or specifically ...
```ignore
let r = hub.projects().locations_custom_target_types_create(...).doit().await
let r = hub.projects().locations_custom_target_types_delete(...).doit().await
let r = hub.projects().locations_custom_target_types_patch(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_delete(...).doit().await
let r = hub.projects().locations_delivery_pipelines_automations_patch(...).doit().await
let r = hub.projects().locations_delivery_pipelines_releases_rollouts_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_releases_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_create(...).doit().await
let r = hub.projects().locations_delivery_pipelines_delete(...).doit().await
let r = hub.projects().locations_delivery_pipelines_patch(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_targets_create(...).doit().await
let r = hub.projects().locations_targets_delete(...).doit().await
let r = hub.projects().locations_targets_patch(...).doit().await
```
The `resource()` and `activity(...)` calls create [builders][builder-pattern]. The second one dealing with `Activities`
supports various methods to configure the impending operation (not shown here). It is made such that all required arguments have to be
specified right away (i.e. `(...)`), whereas all optional ones can be [build up][builder-pattern] as desired.
The `doit()` method performs the actual communication with the server and returns the respective result.
# Usage
## Setting up your Project
To use this library, you would put the following lines into your `Cargo.toml` file:
```toml
[dependencies]
google-clouddeploy1 = "*"
serde = "^1.0"
serde_json = "^1.0"
```
## A complete example
```Rust
extern crate hyper;
extern crate hyper_rustls;
extern crate google_clouddeploy1 as clouddeploy1;
use clouddeploy1::api::CustomTargetType;
use clouddeploy1::{Result, Error};
use std::default::Default;
use clouddeploy1::{CloudDeploy, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you,
// unless you replace `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
secret,
oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();
let mut hub = CloudDeploy::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = CustomTargetType::default();
// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.projects().locations_custom_target_types_patch(req, "name")
.validate_only(true)
.update_mask(&Default::default())
.request_id("voluptua.")
.allow_missing(false)
.doit().await;
match result {
Err(e) => match e {
// The Error enum provides details about what exactly happened.
// You can also just use its `Debug`, `Display` or `Error` traits
Error::HttpError(_)
|Error::Io(_)
|Error::MissingAPIKey
|Error::MissingToken(_)
|Error::Cancelled
|Error::UploadSizeLimitExceeded(_, _)
|Error::Failure(_)
|Error::BadRequest(_)
|Error::FieldClash(_)
|Error::JsonDecodeError(_, _) => println!("{}", e),
},
Ok(res) => println!("Success: {:?}", res),
}
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
When delegates handle errors or intermediate values, they may have a chance to instruct the system to retry. This
makes the system potentially resilient to all kinds of errors.
## Uploads and Downloads
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::ResponseResult), it will return that by default.
You can see it as meta-data for the actual media. To trigger a media download, you will have to set up the builder by making
this call: `.param("alt", "media")`.
Methods supporting uploads can do so using up to 2 different protocols:
*simple* and *resumable*. The distinctiveness of each is represented by customized
`doit(...)` methods, which are then named `upload(...)` and `upload_resumable(...)` respectively.
## Customization and Callbacks
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Delegate) to the
[Method Builder](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::CallBuilder) before making the final `doit()` call.
Respective methods will be called to provide progress information, as well as determine whether the system should
retry on failure.
The [delegate trait](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
## Optional Parts in Server-Requests
All structures provided by this library are made to be [encodable](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::RequestValue) and
[decodable](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
are valid.
Most optionals are are considered [Parts](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::Part) which are identifiable by name, which will be sent to
the server to indicate either the set parts of the request or the desired parts in the response.
## Builder Arguments
Using [method builders](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
These will always take a single argument, for which the following statements are true.
* [PODs][wiki-pod] are handed by copy
* strings are passed as `&str`
* [request values](https://docs.rs/google-clouddeploy1/5.0.4+20240221/google_clouddeploy1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
[wiki-pod]: http://en.wikipedia.org/wiki/Plain_old_data_structure
[builder-pattern]: http://en.wikipedia.org/wiki/Builder_pattern
[google-go-api]: https://github.com/google/google-api-go-client
# License
The **clouddeploy1** library was generated by Sebastian Thiel, and is placed
under the *MIT* license.
You can read the full text at the repository's [license file][repo-license].
[repo-license]: https://github.com/Byron/google-apis-rsblob/main/LICENSE.md
Reference in New Issue View Git Blame Copy Permalink