google_cloud_logging_v2/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 Logging API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Logging 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//! * [LoggingServiceV2](client/struct.LoggingServiceV2.html)
31//! * [ConfigServiceV2](client/struct.ConfigServiceV2.html)
32//! * [MetricsServiceV2](client/struct.MetricsServiceV2.html)
33//!
34//! # Features
35//!
36//! - `default-rustls-provider`: enabled by default. Use the default rustls
37//! crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
38//! with specific requirements for cryptography (such as exclusively using the
39//! [ring] crate) should disable this default and call
40//! `rustls::crypto::CryptoProvider::install_default()`.
41//!
42//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
43//! [ring]: https://crates.io/crates/ring
44
45#![allow(deprecated)]
46
47/// The messages and enums that are part of this client library.
48#[allow(clippy::module_inception)]
49pub mod model;
50
51pub use google_cloud_gax::Result;
52pub use google_cloud_gax::error::Error;
53
54#[allow(rustdoc::invalid_html_tags)]
55#[allow(rustdoc::redundant_explicit_links)]
56pub mod stub;
57
58/// Concrete implementations of client library traits.
59///
60/// # Example
61/// ```
62/// # use google_cloud_logging_v2::client::LoggingServiceV2;
63/// async fn sample(
64/// ) -> anyhow::Result<()> {
65/// let client = LoggingServiceV2::builder().build().await?;
66/// // use `client` to make requests to the Cloud Logging API.
67/// Ok(())
68/// }
69/// ```
70pub mod client;
71
72/// Request builders.
73pub mod builder;
74
75#[doc(hidden)]
76pub(crate) mod tracing;
77
78#[doc(hidden)]
79pub(crate) mod transport;
80
81#[doc(hidden)]
82#[allow(clippy::all)]
83#[allow(unused_imports)]
84#[allow(dead_code)]
85#[allow(missing_docs)]
86pub(crate) mod prost {
87 include!("prost/includes.rs");
88}
89
90#[doc(hidden)]
91#[allow(clippy::all)]
92#[allow(unused_imports)]
93#[allow(dead_code)]
94#[allow(missing_docs)]
95pub(crate) mod convert;
96
97/// The default host used by the service.
98const DEFAULT_HOST: &str = "https://logging.googleapis.com/";
99
100pub(crate) mod info {
101 const NAME: &str = env!("CARGO_PKG_NAME");
102 const VERSION: &str = env!("CARGO_PKG_VERSION");
103 pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
104 std::sync::LazyLock::new(|| {
105 let ac = gaxi::api_header::XGoogApiClient {
106 name: NAME,
107 version: VERSION,
108 library_type: gaxi::api_header::GAPIC,
109 };
110 ac.rest_header_value()
111 });
112 pub(crate) static X_GOOG_API_CLIENT_GRPC_HEADER: std::sync::LazyLock<String> =
113 std::sync::LazyLock::new(|| {
114 let ac = gaxi::api_header::XGoogApiClient {
115 name: NAME,
116 version: VERSION,
117 library_type: gaxi::api_header::GAPIC,
118 };
119 ac.grpc_header_value()
120 });
121}
122
123// Define some shortcuts for imported crates.
124pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
125pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
126pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
127pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
128pub(crate) use google_cloud_gax::options::RequestOptions;
129pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
130pub(crate) use google_cloud_gax::response::Response;