google_cloud_dataplex_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 - Cloud Dataplex API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Dataplex 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//! * [BusinessGlossaryService](client/struct.BusinessGlossaryService.html)
31//! * [CatalogService](client/struct.CatalogService.html)
32//! * [CmekService](client/struct.CmekService.html)
33//! * [ContentService](client/struct.ContentService.html)
34//! * [DataProductService](client/struct.DataProductService.html)
35//! * [DataTaxonomyService](client/struct.DataTaxonomyService.html)
36//! * [DataScanService](client/struct.DataScanService.html)
37//! * [MetadataService](client/struct.MetadataService.html)
38//! * [DataplexService](client/struct.DataplexService.html)
39//!
40//! # Features
41//!
42//! - `default-rustls-provider`: enabled by default. Use the default rustls
43//! crypto provider ([aws-lc-rs]) for TLS and authentication. Applications
44//! with specific requirements for cryptography (such as exclusively using the
45//! [ring] crate) should disable this default and call
46//! `rustls::crypto::CryptoProvider::install_default()`.
47//!
48//! [aws-lc-rs]: https://crates.io/crates/aws-lc-rs
49//! [ring]: https://crates.io/crates/ring
50
51#![allow(deprecated)]
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_dataplex_v1::client::DataplexService;
68/// use google_cloud_gax::paginator::ItemPaginator as _;
69/// # async fn sample() -> Result<(), Box<dyn std::error::Error>> {
70/// let client = DataplexService::builder().build().await?;
71/// let parent = "parent_value";
72/// let mut list = client.list_lakes()
73/// .set_parent(parent)
74/// .by_item();
75/// while let Some(item) = list.next().await.transpose()? {
76/// println!("{:?}", item);
77/// }
78/// # Ok(()) }
79/// ```
80/// Concrete implementations of this client library traits.
81pub mod client;
82
83/// Request builders.
84pub mod builder;
85
86#[doc(hidden)]
87pub(crate) mod tracing;
88
89#[doc(hidden)]
90pub(crate) mod transport;
91
92/// The default host used by the service.
93const DEFAULT_HOST: &str = "https://dataplex.googleapis.com/";
94
95pub(crate) mod info {
96 const NAME: &str = env!("CARGO_PKG_NAME");
97 const VERSION: &str = env!("CARGO_PKG_VERSION");
98 pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
99 std::sync::LazyLock::new(|| {
100 let ac = gaxi::api_header::XGoogApiClient {
101 name: NAME,
102 version: VERSION,
103 library_type: gaxi::api_header::GAPIC,
104 };
105 ac.rest_header_value()
106 });
107}
108
109// Define some shortcuts for imported crates.
110pub(crate) use google_cloud_gax::client_builder::ClientBuilder;
111pub(crate) use google_cloud_gax::client_builder::Result as ClientBuilderResult;
112pub(crate) use google_cloud_gax::client_builder::internal::ClientFactory;
113pub(crate) use google_cloud_gax::client_builder::internal::new_builder as new_client_builder;
114pub(crate) use google_cloud_gax::options::RequestOptions;
115pub(crate) use google_cloud_gax::options::internal::RequestBuilder;
116pub(crate) use google_cloud_gax::response::Response;