<!---
DO NOT EDIT !
This file was generated automatically from 'src/generator/templates/api/README.md.mako'
DO NOT EDIT !
-->
The `google-monitoring3` library allows access to all features of the *Google Monitoring* service.

This documentation was generated from *Monitoring* crate version *6.0.0+20240623*, where *20240623* is the exact revision of the *monitoring:v3* schema built by the [mako](http://www.makotemplates.org/) code generator *v6.0.0*.

Everything else about the *Monitoring* *v3* API can be found at the
[official documentation site](https://cloud.google.com/monitoring/api/).
# Features

Handle the following *Resources* with ease from the central [hub](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/Monitoring) ...

* folders
 * [*time series list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::FolderTimeSeryListCall)
* organizations
 * [*time series list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::OrganizationTimeSeryListCall)
* projects
 * [*alert policies create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectAlertPolicyCreateCall), [*alert policies delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectAlertPolicyDeleteCall), [*alert policies get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectAlertPolicyGetCall), [*alert policies list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectAlertPolicyListCall), [*alert policies patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectAlertPolicyPatchCall), [*collectd time series create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectCollectdTimeSeryCreateCall), [*groups create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupCreateCall), [*groups delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupDeleteCall), [*groups get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupGetCall), [*groups list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupListCall), [*groups members list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupMemberListCall), [*groups update*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectGroupUpdateCall), [*metric descriptors create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMetricDescriptorCreateCall), [*metric descriptors delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMetricDescriptorDeleteCall), [*metric descriptors get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMetricDescriptorGetCall), [*metric descriptors list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMetricDescriptorListCall), [*monitored resource descriptors get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMonitoredResourceDescriptorGetCall), [*monitored resource descriptors list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectMonitoredResourceDescriptorListCall), [*notification channel descriptors get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelDescriptorGetCall), [*notification channel descriptors list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelDescriptorListCall), [*notification channels create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelCreateCall), [*notification channels delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelDeleteCall), [*notification channels get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelGetCall), [*notification channels get verification code*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelGetVerificationCodeCall), [*notification channels list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelListCall), [*notification channels patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelPatchCall), [*notification channels send verification code*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelSendVerificationCodeCall), [*notification channels verify*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectNotificationChannelVerifyCall), [*snoozes create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectSnoozeCreateCall), [*snoozes get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectSnoozeGetCall), [*snoozes list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectSnoozeListCall), [*snoozes patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectSnoozePatchCall), [*time series create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectTimeSeryCreateCall), [*time series create service*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectTimeSeryCreateServiceCall), [*time series list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectTimeSeryListCall), [*time series query*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectTimeSeryQueryCall), [*uptime check configs create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectUptimeCheckConfigCreateCall), [*uptime check configs delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectUptimeCheckConfigDeleteCall), [*uptime check configs get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectUptimeCheckConfigGetCall), [*uptime check configs list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectUptimeCheckConfigListCall) and [*uptime check configs patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ProjectUptimeCheckConfigPatchCall)
* [services](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::Service)
 * [*create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceCreateCall), [*delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceDeleteCall), [*get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceGetCall), [*list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceListCall), [*patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServicePatchCall), [*service level objectives create*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceServiceLevelObjectiveCreateCall), [*service level objectives delete*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceServiceLevelObjectiveDeleteCall), [*service level objectives get*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceServiceLevelObjectiveGetCall), [*service level objectives list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceServiceLevelObjectiveListCall) and [*service level objectives patch*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::ServiceServiceLevelObjectivePatchCall)
* [uptime check ips](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::UptimeCheckIp)
 * [*list*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/api::UptimeCheckIpListCall)


# Structure of this Library

The API is structured into the following primary items:

* **[Hub](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/Monitoring)**
    * a central object to maintain state and allow accessing all *Activities*
    * creates [*Method Builders*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::MethodsBuilder) which in turn
      allow access to individual [*Call Builders*](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::CallBuilder)
* **[Resources](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::Resource)**
    * primary types that you can apply *Activities* to
    * a collection of properties and *Parts*
    * **[Parts](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::Part)**
        * a collection of properties
        * never directly used in *Activities*
* **[Activities](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::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.services().service_level_objectives_create(...).doit().await
let r = hub.services().service_level_objectives_delete(...).doit().await
let r = hub.services().service_level_objectives_get(...).doit().await
let r = hub.services().service_level_objectives_list(...).doit().await
let r = hub.services().service_level_objectives_patch(...).doit().await
let r = hub.services().create(...).doit().await
let r = hub.services().delete(...).doit().await
let r = hub.services().get(...).doit().await
let r = hub.services().list(...).doit().await
let r = hub.services().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-monitoring3 = "*"
serde = "1"
serde_json = "1"
```

## A complete example

```Rust
extern crate hyper;
extern crate hyper_rustls;
extern crate google_monitoring3 as monitoring3;
use monitoring3::{Result, Error};
use monitoring3::{Monitoring, FieldMask, hyper_rustls, hyper_util, yup_oauth2};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and
// `client_secret`, among other things.
let secret: yup_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 = yup_oauth2::InstalledFlowAuthenticator::builder(
    secret,
    yup_oauth2::InstalledFlowReturnMethod::HTTPRedirect,
).build().await.unwrap();

let client = hyper_util::client::legacy::Client::builder(
    hyper_util::rt::TokioExecutor::new()
)
.build(
    hyper_rustls::HttpsConnectorBuilder::new()
        .with_native_roots()
        .unwrap()
        .https_or_http()
        .enable_http1()
        .build()
);
let mut hub = Monitoring::new(client, auth);
// 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.services().service_level_objectives_list("parent")
             .view("magna")
             .page_token("no")
             .page_size(-55)
             .filter("voluptua.")
             .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-monitoring3/6.0.0+20240623/google_monitoring3/common::Result) enumeration as return value of
the doit() methods, or handed as possibly intermediate results to either the
[Hub Delegate](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::Result), should be
read by you to obtain the media.
If such a method also supports a [Response Result](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::Delegate) to the
[Method Builder](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::RequestValue) and
[decodable](https://docs.rs/google-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::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-monitoring3/6.0.0+20240623/google_monitoring3/common::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

## Cargo Features

* `utoipa` - Add support for [utoipa](https://crates.io/crates/utoipa) and derive `utoipa::ToSchema` on all
the types. You'll have to import and register the required types in `#[openapi(schemas(...))]`, otherwise the
generated `openapi` spec would be invalid.


# License
The **monitoring3** 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