google_cloud_trace_v2/
client.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#![allow(rustdoc::bare_urls)]
17#![allow(rustdoc::broken_intra_doc_links)]
18#![allow(rustdoc::invalid_html_tags)]
19#![allow(rustdoc::redundant_explicit_links)]
20
21/// Implements a client for the Cloud Trace API.
22///
23/// # Example
24/// ```
25/// # use google_cloud_trace_v2::client::TraceService;
26/// async fn sample(
27/// ) -> anyhow::Result<()> {
28///     let client = TraceService::builder().build().await?;
29///     client.batch_write_spans()
30///         /* set fields */
31///         .send().await?;
32///     Ok(())
33/// }
34/// ```
35///
36/// # Service Description
37///
38/// Service for collecting and viewing traces and spans within a trace.
39///
40/// A trace is a collection of spans corresponding to a single
41/// operation or a set of operations in an application.
42///
43/// A span is an individual timed event which forms a node of the trace tree.
44/// A single trace can contain spans from multiple services.
45///
46/// # Configuration
47///
48/// To configure `TraceService` use the `with_*` methods in the type returned
49/// by [builder()][TraceService::builder]. The default configuration should
50/// work for most applications. Common configuration changes include
51///
52/// * [with_endpoint()]: by default this client uses the global default endpoint
53///   (`https://cloudtrace.googleapis.com`). Applications using regional
54///   endpoints or running in restricted networks (e.g. a network configured
55///   with [Private Google Access with VPC Service Controls]) may want to
56///   override this default.
57/// * [with_credentials()]: by default this client uses
58///   [Application Default Credentials]. Applications using custom
59///   authentication may need to override this default.
60///
61/// [with_endpoint()]: super::builder::trace_service::ClientBuilder::with_endpoint
62/// [with_credentials()]: super::builder::trace_service::ClientBuilder::with_credentials
63/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
64/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
65///
66/// # Pooling and Cloning
67///
68/// `TraceService` holds a connection pool internally, it is advised to
69/// create one and reuse it. You do not need to wrap `TraceService` in
70/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
71/// already uses an `Arc` internally.
72#[derive(Clone, Debug)]
73pub struct TraceService {
74    inner: std::sync::Arc<dyn super::stub::dynamic::TraceService>,
75}
76
77impl TraceService {
78    /// Returns a builder for [TraceService].
79    ///
80    /// ```
81    /// # async fn sample() -> google_cloud_gax::client_builder::Result<()> {
82    /// # use google_cloud_trace_v2::client::TraceService;
83    /// let client = TraceService::builder().build().await?;
84    /// # Ok(()) }
85    /// ```
86    pub fn builder() -> super::builder::trace_service::ClientBuilder {
87        crate::new_client_builder(super::builder::trace_service::client::Factory)
88    }
89
90    /// Creates a new client from the provided stub.
91    ///
92    /// The most common case for calling this function is in tests mocking the
93    /// client's behavior.
94    pub fn from_stub<T>(stub: impl Into<std::sync::Arc<T>>) -> Self
95    where
96        T: super::stub::TraceService + 'static,
97    {
98        Self { inner: stub.into() }
99    }
100
101    pub(crate) async fn new(
102        config: gaxi::options::ClientConfig,
103    ) -> crate::ClientBuilderResult<Self> {
104        let inner = Self::build_inner(config).await?;
105        Ok(Self { inner })
106    }
107
108    async fn build_inner(
109        conf: gaxi::options::ClientConfig,
110    ) -> crate::ClientBuilderResult<std::sync::Arc<dyn super::stub::dynamic::TraceService>> {
111        if gaxi::options::tracing_enabled(&conf) {
112            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
113        }
114        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
115    }
116
117    async fn build_transport(
118        conf: gaxi::options::ClientConfig,
119    ) -> crate::ClientBuilderResult<impl super::stub::TraceService> {
120        super::transport::TraceService::new(conf).await
121    }
122
123    async fn build_with_tracing(
124        conf: gaxi::options::ClientConfig,
125    ) -> crate::ClientBuilderResult<impl super::stub::TraceService> {
126        Self::build_transport(conf)
127            .await
128            .map(super::tracing::TraceService::new)
129    }
130
131    /// Batch writes new spans to new or existing traces. You cannot update
132    /// existing spans.
133    ///
134    /// # Example
135    /// ```
136    /// # use google_cloud_trace_v2::client::TraceService;
137    /// use google_cloud_trace_v2::Result;
138    /// async fn sample(
139    ///    client: &TraceService
140    /// ) -> Result<()> {
141    ///     client.batch_write_spans()
142    ///         /* set fields */
143    ///         .send().await?;
144    ///     Ok(())
145    /// }
146    /// ```
147    pub fn batch_write_spans(&self) -> super::builder::trace_service::BatchWriteSpans {
148        super::builder::trace_service::BatchWriteSpans::new(self.inner.clone())
149    }
150
151    /// Creates a new span.
152    ///
153    /// # Example
154    /// ```
155    /// # use google_cloud_trace_v2::client::TraceService;
156    /// use google_cloud_trace_v2::Result;
157    /// async fn sample(
158    ///    client: &TraceService
159    /// ) -> Result<()> {
160    ///     let response = client.create_span()
161    ///         /* set fields */
162    ///         .send().await?;
163    ///     println!("response {:?}", response);
164    ///     Ok(())
165    /// }
166    /// ```
167    pub fn create_span(&self) -> super::builder::trace_service::CreateSpan {
168        super::builder::trace_service::CreateSpan::new(self.inner.clone())
169    }
170}
google_cloud_trace_v2/client.rs

google_cloud_trace_v2/
client.rs
