google_cloud_securitycenter_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 - Security Command Center API
18//!
19//! This crate contains traits, types, and functions to interact with Security Command Center 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//! * [SecurityCenter](client/struct.SecurityCenter.html)
31//!
32//! # Features
33//!
34//! - `default-rustls-provider`: enabled by default. Use the default rustls
35//! crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
36//! with specific requirements for cryptography (such as exclusively using the
37//! [ring] crate) should disable this default and call
38//! `rustls::crypto::CryptoProvider::install_default()`.
39//!
40//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
41//! [ring]: https://crates.io/crates/ring
42
43#![allow(deprecated)]
44
45/// The messages and enums that are part of this client library.
46#[allow(clippy::module_inception)]
47pub mod model;
48
49pub use google_cloud_gax::Result;
50pub use google_cloud_gax::error::Error;
51
52#[allow(rustdoc::invalid_html_tags)]
53#[allow(rustdoc::redundant_explicit_links)]
54pub mod stub;
55
56///
57/// # Example
58/// ```
59/// # use google_cloud_securitycenter_v2::client::SecurityCenter;
60/// use google_cloud_gax::paginator::ItemPaginator as _;
61/// async fn sample(
62/// organization_id: &str,
63/// simulation_id: &str,
64/// valued_resource_id: &str,
65/// ) -> anyhow::Result<()> {
66/// let client = SecurityCenter::builder().build().await?;
67/// let mut list = client.list_attack_paths()
68/// .set_parent(format!("organizations/{organization_id}/simulations/{simulation_id}/valuedResources/{valued_resource_id}"))
69/// .by_item();
70/// while let Some(item) = list.next().await.transpose()? {
71/// println!("{:?}", item);
72/// }
73/// Ok(())
74/// }
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://securitycenter.googleapis.com/";
90
91pub(crate) mod info {
92 const NAME: &str = env!("CARGO_PKG_NAME");
93 const VERSION: &str = env!("CARGO_PKG_VERSION");
94 pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
95 std::sync::LazyLock::new(|| {
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// Define some shortcuts for imported crates.
106pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
107pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
108pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
109pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
110pub(crate) use google_cloud_gax::options::RequestOptions;
111pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
112pub(crate) use google_cloud_gax::response::Response;