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

google_cloud_chronicle_v1/
lib.rs
