google_cloud_chronicle_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 - Chronicle API
18//!
19//! This crate contains traits, types, and functions to interact with Chronicle 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//! * [DataAccessControlService](client/struct.DataAccessControlService.html)
31//! * [DataTableService](client/struct.DataTableService.html)
32//! * [EntityService](client/struct.EntityService.html)
33//! * [InstanceService](client/struct.InstanceService.html)
34//! * [ReferenceListService](client/struct.ReferenceListService.html)
35//! * [RuleService](client/struct.RuleService.html)
36//!
37//! # Features
38//!
39//! - `default-rustls-provider`: enabled by default. Use the default rustls
40//!   crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
41//!   with specific requirements for cryptography (such as exclusively using the
42//!   [ring] crate) should disable this default and call
43//!   `rustls::crypto::CryptoProvider::install_default()`.
44//!
45//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
46//! [ring]: https://crates.io/crates/ring
47
48/// The messages and enums that are part of this client library.
49#[allow(clippy::module_inception)]
50pub mod model;
51
52pub use google_cloud_gax::Result;
53pub use google_cloud_gax::error::Error;
54
55#[allow(rustdoc::invalid_html_tags)]
56#[allow(rustdoc::redundant_explicit_links)]
57pub mod stub;
58
59///
60/// # Example
61/// ```
62/// # use google_cloud_chronicle_v1::client::DataAccessControlService;
63/// use google_cloud_gax::paginator::ItemPaginator as _;
64/// async fn sample(
65///    project_id: &str,
66///    location_id: &str,
67///    instance_id: &str,
68/// ) -> anyhow::Result<()> {
69///     let client = DataAccessControlService::builder().build().await?;
70///     let mut list = client.list_data_access_labels()
71///         .set_parent(format!("projects/{project_id}/locations/{location_id}/instances/{instance_id}"))
72///         .by_item();
73///     while let Some(item) = list.next().await.transpose()? {
74///         println!("{:?}", item);
75///     }
76///     Ok(())
77/// }
78/// ```
79/// Concrete implementations of this client library traits.
80pub mod client;
81
82/// Request builders.
83pub mod builder;
84
85#[doc(hidden)]
86pub(crate) mod tracing;
87
88#[doc(hidden)]
89pub(crate) mod transport;
90
91/// The default host used by the service.
92const DEFAULT_HOST: &str = "https://chronicle.googleapis.com/";
93
94pub(crate) mod info {
95    const NAME: &str = env!("CARGO_PKG_NAME");
96    const VERSION: &str = env!("CARGO_PKG_VERSION");
97    pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
98        std::sync::LazyLock::new(|| {
99            let ac = gaxi::api_header::XGoogApiClient {
100                name: NAME,
101                version: VERSION,
102                library_type: gaxi::api_header::GAPIC,
103            };
104            ac.rest_header_value()
105        });
106}
107
108// Define some shortcuts for imported crates.
109pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
110pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
111pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
112pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
113pub(crate) use google_cloud_gax::options::RequestOptions;
114pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
115pub(crate) use google_cloud_gax::response::Response;
google_cloud_chronicle_v1/lib.rs

google_cloud_chronicle_v1/
lib.rs
