google_cloud_language_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::redundant_explicit_links)]
17#![allow(rustdoc::broken_intra_doc_links)]
18
19use crate::Result;
20use std::sync::Arc;
21
22/// Implements a client for the Cloud Natural Language API.
23///
24/// # Example
25/// ```
26/// # tokio_test::block_on(async {
27/// # use google_cloud_language_v2::client::LanguageService;
28/// let client = LanguageService::builder().build().await?;
29/// // use `client` to make requests to the {Codec.APITitle}}.
30/// # gax::Result::<()>::Ok(()) });
31/// ```
32///
33/// # Service Description
34///
35/// Provides text analysis operations such as sentiment analysis and entity
36/// recognition.
37///
38/// # Configuration
39///
40/// To configure `LanguageService` use the `with_*` methods in the type returned
41/// by [builder()][LanguageService::builder]. The default configuration should
42/// work for most applications. Common configuration changes include
43///
44/// * [with_endpoint()]: by default this client uses the global default endpoint
45///   (`https://language.googleapis.com`). Applications using regional
46///   endpoints or running in restricted networks (e.g. a network configured
47//    with [Private Google Access with VPC Service Controls]) may want to
48///   override this default.
49/// * [with_credentials()]: by default this client uses
50///   [Application Default Credentials]. Applications using custom
51///   authentication may need to override this default.
52///
53/// [with_endpoint()]: super::builder::language_service::ClientBuilder::with_endpoint
54/// [with_credentials()]: super::builder::language_service::ClientBuilder::credentials
55/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
56/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
57///
58/// # Pooling and Cloning
59///
60/// `LanguageService` holds a connection pool internally, it is advised to
61/// create one and the reuse it.  You do not need to wrap `LanguageService` in
62/// an [Rc](std::rc::Rc) or [Arc] to reuse it, because it already uses an `Arc`
63/// internally.
64#[derive(Clone, Debug)]
65pub struct LanguageService {
66    inner: Arc<dyn super::stub::dynamic::LanguageService>,
67}
68
69impl LanguageService {
70    /// Returns a builder for [LanguageService].
71    ///
72    /// ```
73    /// # tokio_test::block_on(async {
74    /// # use google_cloud_language_v2::client::LanguageService;
75    /// let client = LanguageService::builder().build().await?;
76    /// # gax::Result::<()>::Ok(()) });
77    /// ```
78    pub fn builder() -> super::builder::language_service::ClientBuilder {
79        gax::client_builder::internal::new_builder(
80            super::builder::language_service::client::Factory,
81        )
82    }
83
84    /// Creates a new client from the provided stub.
85    ///
86    /// The most common case for calling this function is in tests mocking the
87    /// client's behavior.
88    pub fn from_stub<T>(stub: T) -> Self
89    where
90        T: super::stub::LanguageService + 'static,
91    {
92        Self {
93            inner: Arc::new(stub),
94        }
95    }
96
97    pub(crate) async fn new(config: gaxi::options::ClientConfig) -> Result<Self> {
98        let inner = Self::build_inner(config).await?;
99        Ok(Self { inner })
100    }
101
102    async fn build_inner(
103        conf: gaxi::options::ClientConfig,
104    ) -> Result<Arc<dyn super::stub::dynamic::LanguageService>> {
105        if gaxi::options::tracing_enabled(&conf) {
106            return Ok(Arc::new(Self::build_with_tracing(conf).await?));
107        }
108        Ok(Arc::new(Self::build_transport(conf).await?))
109    }
110
111    async fn build_transport(
112        conf: gaxi::options::ClientConfig,
113    ) -> Result<impl super::stub::LanguageService> {
114        super::transport::LanguageService::new(conf).await
115    }
116
117    async fn build_with_tracing(
118        conf: gaxi::options::ClientConfig,
119    ) -> Result<impl super::stub::LanguageService> {
120        Self::build_transport(conf)
121            .await
122            .map(super::tracing::LanguageService::new)
123    }
124
125    /// Analyzes the sentiment of the provided text.
126    pub fn analyze_sentiment(&self) -> super::builder::language_service::AnalyzeSentiment {
127        super::builder::language_service::AnalyzeSentiment::new(self.inner.clone())
128    }
129
130    /// Finds named entities (currently proper names and common nouns) in the text
131    /// along with entity types, probability, mentions for each entity, and
132    /// other properties.
133    pub fn analyze_entities(&self) -> super::builder::language_service::AnalyzeEntities {
134        super::builder::language_service::AnalyzeEntities::new(self.inner.clone())
135    }
136
137    /// Classifies a document into categories.
138    pub fn classify_text(&self) -> super::builder::language_service::ClassifyText {
139        super::builder::language_service::ClassifyText::new(self.inner.clone())
140    }
141
142    /// Moderates a document for harmful and sensitive categories.
143    pub fn moderate_text(&self) -> super::builder::language_service::ModerateText {
144        super::builder::language_service::ModerateText::new(self.inner.clone())
145    }
146
147    /// A convenience method that provides all features in one call.
148    pub fn annotate_text(&self) -> super::builder::language_service::AnnotateText {
149        super::builder::language_service::AnnotateText::new(self.inner.clone())
150    }
151}
google_cloud_language_v2/client.rs

google_cloud_language_v2/
client.rs
