google_cloud_bigtable_admin_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 Bigtable Admin API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Bigtable Admin 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//! * [BigtableInstanceAdmin](client/struct.BigtableInstanceAdmin.html)
31//! * [BigtableTableAdmin](client/struct.BigtableTableAdmin.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#![allow(deprecated)]
45
46/// The messages and enums that are part of this client library.
47#[allow(clippy::module_inception)]
48pub mod model;
49
50pub use google_cloud_gax::Result;
51pub use google_cloud_gax::error::Error;
52
53#[allow(rustdoc::invalid_html_tags)]
54#[allow(rustdoc::redundant_explicit_links)]
55pub mod stub;
56
57///
58/// # Example
59/// ```
60/// # use google_cloud_bigtable_admin_v2::client::BigtableInstanceAdmin;
61/// use google_cloud_gax::paginator::ItemPaginator as _;
62/// async fn sample(
63///    project_id: &str,
64///    instance_id: &str,
65/// ) -> anyhow::Result<()> {
66///     let client = BigtableInstanceAdmin::builder().build().await?;
67///     let mut list = client.list_app_profiles()
68///         .set_parent(format!("projects/{project_id}/instances/{instance_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://bigtableadmin.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;
google_cloud_bigtable_admin_v2/lib.rs

google_cloud_bigtable_admin_v2/
lib.rs
