google_cloud_resourcemanager_v3/lib.rs
1// Copyright 2025 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// https://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14//
15// Code generated by sidekick. DO NOT EDIT.
16
17//! Google Cloud Client Libraries for Rust - Cloud Resource Manager API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Resource Manager API
20//! Most applications will use the structs defined in the [client] module.
21//!
22//! The client library types and functions are stable and not expected to change.
23//! Please note that Google Cloud services do change from time to time. The client
24//! libraries are designed to preserve backwards compatibility when the service
25//! changes in compatible ways. For example, adding RPCs, or fields to messages
26//! should not introduce breaking changes to the client libraries.
27//!
28//! # Available Clients
29//!
30//! * [Folders](client/struct.Folders.html)
31//! * [Organizations](client/struct.Organizations.html)
32//! * [Projects](client/struct.Projects.html)
33//! * [TagBindings](client/struct.TagBindings.html)
34//! * [TagHolds](client/struct.TagHolds.html)
35//! * [TagKeys](client/struct.TagKeys.html)
36//! * [TagValues](client/struct.TagValues.html)
37//!
38//! # Features
39//!
40//! - `default-rustls-provider`: enabled by default. Use the default rustls
41//! crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
42//! with specific requirements for cryptography (such as exclusively using the
43//! [ring] crate) should disable this default and call
44//! `rustls::crypto::CryptoProvider::install_default()`.
45//!
46//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
47//! [ring]: https://crates.io/crates/ring
48
49/// The messages and enums that are part of this client library.
50#[allow(clippy::module_inception)]
51pub mod model;
52
53pub use google_cloud_gax::Result;
54pub use google_cloud_gax::error::Error;
55
56#[allow(rustdoc::invalid_html_tags)]
57#[allow(rustdoc::redundant_explicit_links)]
58pub mod stub;
59
60///
61/// # Example
62/// ```
63/// # use google_cloud_resourcemanager_v3::client::Folders;
64/// use google_cloud_gax::paginator::ItemPaginator as _;
65/// async fn sample(
66/// parent: &str,
67/// ) -> anyhow::Result<()> {
68/// let client = Folders::builder().build().await?;
69/// let mut list = client.list_folders()
70/// .set_parent(parent)
71/// .by_item();
72/// while let Some(item) = list.next().await.transpose()? {
73/// println!("{:?}", item);
74/// }
75/// Ok(())
76/// }
77/// ```
78/// Concrete implementations of this client library traits.
79pub mod client;
80
81/// Request builders.
82pub mod builder;
83
84#[doc(hidden)]
85pub(crate) mod tracing;
86
87#[doc(hidden)]
88pub(crate) mod transport;
89
90/// The default host used by the service.
91const DEFAULT_HOST: &str = "https://cloudresourcemanager.googleapis.com/";
92
93pub(crate) mod info {
94 const NAME: &str = env!("CARGO_PKG_NAME");
95 const VERSION: &str = env!("CARGO_PKG_VERSION");
96 pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
97 std::sync::LazyLock::new(|| {
98 let ac = gaxi::api_header::XGoogApiClient {
99 name: NAME,
100 version: VERSION,
101 library_type: gaxi::api_header::GAPIC,
102 };
103 ac.rest_header_value()
104 });
105}
106
107// Define some shortcuts for imported crates.
108pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
109pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
110pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
111pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
112pub(crate) use google_cloud_gax::options::RequestOptions;
113pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
114pub(crate) use google_cloud_gax::response::Response;