google_cloud_kms_v1/
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 Key Management Service (KMS) API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Key Management Service (KMS) 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//! * [Autokey](client/struct.Autokey.html)
31//! * [AutokeyAdmin](client/struct.AutokeyAdmin.html)
32//! * [EkmService](client/struct.EkmService.html)
33//! * [HsmManagement](client/struct.HsmManagement.html)
34//! * [KeyManagementService](client/struct.KeyManagementService.html)
35//!
36//! # Features
37//!
38//! - `default-rustls-provider`: enabled by default. Use the default rustls
39//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
40//!   with specific requirements for cryptography (such as exclusively using the
41//!   [ring] crate) should disable this default and call
42//!   `rustls::crypto::CryptoProvider::install_default()`.
43//!
44//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
45//! [ring]: https://crates.io/crates/ring
46
47#![allow(deprecated)]
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_kms_v1::client::Autokey;
64/// use google_cloud_gax::paginator::ItemPaginator as _;
65/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
66///     let client = Autokey::builder().build().await?;
67///     let parent = "parent_value";
68///     let mut list = client.list_key_handles()
69///         .set_parent(parent)
70///         .by_item();
71///     while let Some(item) = list.next().await.transpose()? {
72///         println!("{:?}", item);
73///     }
74/// # Ok(()) }
75/// ```
76/// Concrete implementations of this client library traits.
77pub mod client;
78
79/// Request builders.
80pub mod builder;
81
82#[doc(hidden)]
83pub(crate) mod tracing;
84
85#[doc(hidden)]
86pub(crate) mod transport;
87
88/// The default host used by the service.
89const DEFAULT_HOST: &str = "https://cloudkms.googleapis.com/";
90
91pub(crate) mod info {
92    const NAME: &str = env!("CARGO_PKG_NAME");
93    const VERSION: &str = env!("CARGO_PKG_VERSION");
94    lazy_static::lazy_static! {
95        pub(crate) static ref X_GOOG_API_CLIENT_HEADER: String = {
96            let ac = gaxi::api_header::XGoogApiClient{
97                name:          NAME,
98                version:       VERSION,
99                library_type:  gaxi::api_header::GAPIC,
100            };
101            ac.rest_header_value()
102        };
103    }
104}
105
106// Define some shortcuts for imported crates.
107pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
108pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
109pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
110pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
111pub(crate) use google_cloud_gax::options::RequestOptions;
112pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
113pub(crate) use google_cloud_gax::response::Response;
google_cloud_kms_v1/lib.rs

google_cloud_kms_v1/
lib.rs
