google_cloud_tasks_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 Tasks API
18//!
19//! This crate contains traits, types, and functions to interact with Cloud Tasks 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//! * [CloudTasks](client/struct.CloudTasks.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/// The messages and enums that are part of this client library.
44#[allow(clippy::module_inception)]
45pub mod model;
46
47pub use google_cloud_gax::Result;
48pub use google_cloud_gax::error::Error;
49
50#[allow(rustdoc::invalid_html_tags)]
51#[allow(rustdoc::redundant_explicit_links)]
52pub mod stub;
53
54///
55/// # Example
56/// ```
57/// # use google_cloud_tasks_v2::client::CloudTasks;
58/// use google_cloud_gax::paginator::ItemPaginator as _;
59/// async fn sample(
60///    project_id: &str,
61///    location_id: &str,
62/// ) -> anyhow::Result<()> {
63///     let client = CloudTasks::builder().build().await?;
64///     let mut list = client.list_queues()
65///         .set_parent(format!("projects/{project_id}/locations/{location_id}"))
66///         .by_item();
67///     while let Some(item) = list.next().await.transpose()? {
68///         println!("{:?}", item);
69///     }
70///     Ok(())
71/// }
72/// ```
73/// Concrete implementations of this client library traits.
74pub mod client;
75
76/// Request builders.
77pub mod builder;
78
79#[doc(hidden)]
80pub(crate) mod tracing;
81
82#[doc(hidden)]
83pub(crate) mod transport;
84
85/// The default host used by the service.
86const DEFAULT_HOST: &str = "https://cloudtasks.googleapis.com/";
87
88pub(crate) mod info {
89    const NAME: &str = env!("CARGO_PKG_NAME");
90    const VERSION: &str = env!("CARGO_PKG_VERSION");
91    pub(crate) static X_GOOG_API_CLIENT_HEADER: std::sync::LazyLock<String> =
92        std::sync::LazyLock::new(|| {
93            let ac = gaxi::api_header::XGoogApiClient {
94                name: NAME,
95                version: VERSION,
96                library_type: gaxi::api_header::GAPIC,
97            };
98            ac.rest_header_value()
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;
google_cloud_tasks_v2/lib.rs

google_cloud_tasks_v2/
lib.rs
