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