OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

make regen-apis

Browse Source
This commit is contained in:
OMGeeky
2024-05-16 21:23:40 +02:00
parent 52d2e89e51
commit ad85cafeef
5108 changed files with 1615625 additions and 992044 deletions
Download Patch File Download Diff File Expand all files Collapse all files

69
gen/containeranalysis1/README.md
View File

@@ -5,16 +5,16 @@ DO NOT EDIT !
-->
The `google-containeranalysis1` library allows access to all features of the *Google Container Analysis* service.
This documentation was generated from *Container Analysis* crate version *5.0.4+20240223*, where *20240223* is the exact revision of the *containeranalysis:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.4*.
This documentation was generated from *Container Analysis* crate version *5.0.5+20240322*, where *20240322* is the exact revision of the *containeranalysis:v1* schema built by the [mako](http://www.makotemplates.org/) code generator *v5.0.5*.
Everything else about the *Container Analysis* *v1* API can be found at the
[official documentation site](https://cloud.google.com/container-analysis/api/reference/rest/).
# Features
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/ContainerAnalysis) ...
Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/ContainerAnalysis) ...
* projects
* [*notes batch create*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteBatchCreateCall), [*notes create*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteCreateCall), [*notes delete*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteDeleteCall), [*notes get*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteGetCall), [*notes get iam policy*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteGetIamPolicyCall), [*notes list*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteListCall), [*notes occurrences list*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteOccurrenceListCall), [*notes patch*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNotePatchCall), [*notes set iam policy*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteSetIamPolicyCall), [*notes test iam permissions*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectNoteTestIamPermissionCall), [*occurrences batch create*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceBatchCreateCall), [*occurrences create*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceCreateCall), [*occurrences delete*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceDeleteCall), [*occurrences get*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceGetCall), [*occurrences get iam policy*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceGetIamPolicyCall), [*occurrences get notes*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceGetNoteCall), [*occurrences get vulnerability summary*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceGetVulnerabilitySummaryCall), [*occurrences list*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceListCall), [*occurrences patch*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrencePatchCall), [*occurrences set iam policy*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceSetIamPolicyCall), [*occurrences test iam permissions*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectOccurrenceTestIamPermissionCall) and [*resources export sbom*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/api::ProjectResourceExportSBOMCall)
* [*locations notes get*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationNoteGetCall), [*locations notes list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationNoteListCall), [*locations notes occurrences list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationNoteOccurrenceListCall), [*locations occurrences get*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationOccurrenceGetCall), [*locations occurrences get notes*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationOccurrenceGetNoteCall), [*locations occurrences get vulnerability summary*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationOccurrenceGetVulnerabilitySummaryCall), [*locations occurrences list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationOccurrenceListCall), [*locations resources export sbom*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectLocationResourceExportSBOMCall), [*notes batch create*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteBatchCreateCall), [*notes create*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteCreateCall), [*notes delete*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteDeleteCall), [*notes get*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteGetCall), [*notes get iam policy*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteGetIamPolicyCall), [*notes list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteListCall), [*notes occurrences list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteOccurrenceListCall), [*notes patch*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNotePatchCall), [*notes set iam policy*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteSetIamPolicyCall), [*notes test iam permissions*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectNoteTestIamPermissionCall), [*occurrences batch create*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceBatchCreateCall), [*occurrences create*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceCreateCall), [*occurrences delete*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceDeleteCall), [*occurrences get*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceGetCall), [*occurrences get iam policy*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceGetIamPolicyCall), [*occurrences get notes*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceGetNoteCall), [*occurrences get vulnerability summary*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceGetVulnerabilitySummaryCall), [*occurrences list*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceListCall), [*occurrences patch*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrencePatchCall), [*occurrences set iam policy*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceSetIamPolicyCall), [*occurrences test iam permissions*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectOccurrenceTestIamPermissionCall) and [*resources export sbom*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/api::ProjectResourceExportSBOMCall)
@@ -23,17 +23,17 @@ Handle the following *Resources* with ease from the central [hub](https://docs.r
The API is structured into the following primary items:
* **[Hub](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/ContainerAnalysis)**
* **[Hub](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/ContainerAnalysis)**
* a central object to maintain state and allow accessing all *Activities*
* creates [*Method Builders*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::CallBuilder)
* **[Resources](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Resource)**
* creates [*Method Builders*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::MethodsBuilder) which in turn
allow access to individual [*Call Builders*](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::CallBuilder)
* **[Resources](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::Resource)**
* primary types that you can apply *Activities* to
* a collection of properties and *Parts*
* **[Parts](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Part)**
* **[Parts](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::Part)**
* a collection of properties
* never directly used in *Activities*
* **[Activities](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::CallBuilder)**
* **[Activities](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::CallBuilder)**
* operations to apply to *Resources*
All *structures* are marked with applicable traits to further categorize them and ease browsing.
@@ -47,14 +47,16 @@ let r = hub.resource().activity(...).doit().await
Or specifically ...
```ignore
let r = hub.projects().locations_notes_get(...).doit().await
let r = hub.projects().locations_occurrences_get_notes(...).doit().await
let r = hub.projects().notes_create(...).doit().await
let r = hub.projects().notes_get(...).doit().await
let r = hub.projects().notes_patch(...).doit().await
let r = hub.projects().occurrences_get_notes(...).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
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.
@@ -79,22 +81,23 @@ extern crate hyper_rustls;
extern crate google_containeranalysis1 as containeranalysis1;
use containeranalysis1::api::Note;
use containeranalysis1::{Result, Error};
use containeranalysis1::api::enums::*;
use std::default::Default;
use containeranalysis1::{ContainerAnalysis, oauth2, hyper, hyper_rustls, chrono, FieldMask};
// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// 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,
// 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
// 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 = ContainerAnalysis::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().https_or_http().enable_http1().build()), auth);
let mut hub = ContainerAnalysis::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().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 !
@@ -128,49 +131,49 @@ match result {
```
## Handling Errors
All errors produced by the system are provided either as [Result](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Delegate), or the [Authenticator Delegate](https://docs.rs/yup-oauth2/*/yup_oauth2/trait.AuthenticatorDelegate.html).
All errors produced by the system are provided either as [Result](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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
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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Result), should be
If a method supports downloads, the response body, which is part of the [Result](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::ResponseResult), it will return that by default.
If such a method also supports a [Response Result](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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
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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Delegate) to the
[Method Builder](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/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
You may alter the way an `doit()` method is called by providing a [delegate](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::Delegate) to the
[Method Builder](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Delegate) is default-implemented, allowing you to customize it with minimal effort.
The [delegate trait](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::RequestValue) and
[decodable](https://docs.rs/google-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::ResponseResult) via *json*. Optionals are used to indicate that partial requests are responses
All structures provided by this library are made to be [encodable](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::RequestValue) and
[decodable](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::Part) which are identifiable by name, which will be sent to
Most optionals are are considered [Parts](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::CallBuilder), you are able to prepare an action call by repeatedly calling it's methods.
Using [method builders](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/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-containeranalysis1/5.0.4+20240223/google_containeranalysis1/client::RequestValue) are moved
* [request values](https://docs.rs/google-containeranalysis1/5.0.5+20240322/google_containeranalysis1/client::RequestValue) are moved
Arguments will always be copied or cloned into the builder, to make them independent of their original life times.
@@ -179,7 +182,7 @@ Arguments will always be copied or cloned into the builder, to make them indepen
[google-go-api]: https://github.com/google/google-api-go-client
# License
The **containeranalysis1** library was generated by Sebastian Thiel, and is placed
The **containeranalysis1** 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].