google_cloud_videointelligence_v1/
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
19/// Implements a client for the Cloud Video Intelligence API.
20///
21/// # Example
22/// ```
23/// # tokio_test::block_on(async {
24/// # use google_cloud_videointelligence_v1::client::VideoIntelligenceService;
25/// let client = VideoIntelligenceService::builder().build().await?;
26/// // use `client` to make requests to the Cloud Video Intelligence API.
27/// # gax::client_builder::Result::<()>::Ok(()) });
28/// ```
29///
30/// # Service Description
31///
32/// Service that implements the Video Intelligence API.
33///
34/// # Configuration
35///
36/// To configure `VideoIntelligenceService` use the `with_*` methods in the type returned
37/// by [builder()][VideoIntelligenceService::builder]. The default configuration should
38/// work for most applications. Common configuration changes include
39///
40/// * [with_endpoint()]: by default this client uses the global default endpoint
41///   (`https://videointelligence.googleapis.com`). Applications using regional
42///   endpoints or running in restricted networks (e.g. a network configured
43//    with [Private Google Access with VPC Service Controls]) may want to
44///   override this default.
45/// * [with_credentials()]: by default this client uses
46///   [Application Default Credentials]. Applications using custom
47///   authentication may need to override this default.
48///
49/// [with_endpoint()]: super::builder::video_intelligence_service::ClientBuilder::with_endpoint
50/// [with_credentials()]: super::builder::video_intelligence_service::ClientBuilder::credentials
51/// [Private Google Access with VPC Service Controls]: https://cloud.google.com/vpc-service-controls/docs/private-connectivity
52/// [Application Default Credentials]: https://cloud.google.com/docs/authentication#adc
53///
54/// # Pooling and Cloning
55///
56/// `VideoIntelligenceService` holds a connection pool internally, it is advised to
57/// create one and the reuse it.  You do not need to wrap `VideoIntelligenceService` in
58/// an [Rc](std::rc::Rc) or [Arc](std::sync::Arc) to reuse it, because it
59/// already uses an `Arc` internally.
60#[derive(Clone, Debug)]
61pub struct VideoIntelligenceService {
62    inner: std::sync::Arc<dyn super::stub::dynamic::VideoIntelligenceService>,
63}
64
65impl VideoIntelligenceService {
66    /// Returns a builder for [VideoIntelligenceService].
67    ///
68    /// ```
69    /// # tokio_test::block_on(async {
70    /// # use google_cloud_videointelligence_v1::client::VideoIntelligenceService;
71    /// let client = VideoIntelligenceService::builder().build().await?;
72    /// # gax::client_builder::Result::<()>::Ok(()) });
73    /// ```
74    pub fn builder() -> super::builder::video_intelligence_service::ClientBuilder {
75        gax::client_builder::internal::new_builder(
76            super::builder::video_intelligence_service::client::Factory,
77        )
78    }
79
80    /// Creates a new client from the provided stub.
81    ///
82    /// The most common case for calling this function is in tests mocking the
83    /// client's behavior.
84    pub fn from_stub<T>(stub: T) -> Self
85    where
86        T: super::stub::VideoIntelligenceService + 'static,
87    {
88        Self {
89            inner: std::sync::Arc::new(stub),
90        }
91    }
92
93    pub(crate) async fn new(
94        config: gaxi::options::ClientConfig,
95    ) -> gax::client_builder::Result<Self> {
96        let inner = Self::build_inner(config).await?;
97        Ok(Self { inner })
98    }
99
100    async fn build_inner(
101        conf: gaxi::options::ClientConfig,
102    ) -> gax::client_builder::Result<
103        std::sync::Arc<dyn super::stub::dynamic::VideoIntelligenceService>,
104    > {
105        if gaxi::options::tracing_enabled(&conf) {
106            return Ok(std::sync::Arc::new(Self::build_with_tracing(conf).await?));
107        }
108        Ok(std::sync::Arc::new(Self::build_transport(conf).await?))
109    }
110
111    async fn build_transport(
112        conf: gaxi::options::ClientConfig,
113    ) -> gax::client_builder::Result<impl super::stub::VideoIntelligenceService> {
114        super::transport::VideoIntelligenceService::new(conf).await
115    }
116
117    async fn build_with_tracing(
118        conf: gaxi::options::ClientConfig,
119    ) -> gax::client_builder::Result<impl super::stub::VideoIntelligenceService> {
120        Self::build_transport(conf)
121            .await
122            .map(super::tracing::VideoIntelligenceService::new)
123    }
124
125    /// Performs asynchronous video annotation. Progress and results can be
126    /// retrieved through the `google.longrunning.Operations` interface.
127    /// `Operation.metadata` contains `AnnotateVideoProgress` (progress).
128    /// `Operation.response` contains `AnnotateVideoResponse` (results).
129    ///
130    /// # Long running operations
131    ///
132    /// This method is used to start, and/or poll a [long-running Operation].
133    /// The [Working with long-running operations] chapter in the [user guide]
134    /// covers these operations in detail.
135    ///
136    /// [long-running operation]: https://google.aip.dev/151
137    /// [user guide]: https://googleapis.github.io/google-cloud-rust/
138    /// [working with long-running operations]: https://googleapis.github.io/google-cloud-rust/working_with_long_running_operations.html
139    pub fn annotate_video(&self) -> super::builder::video_intelligence_service::AnnotateVideo {
140        super::builder::video_intelligence_service::AnnotateVideo::new(self.inner.clone())
141    }
142
143    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
144    ///
145    /// [google.longrunning.Operations]: longrunning::client::Operations
146    pub fn list_operations(&self) -> super::builder::video_intelligence_service::ListOperations {
147        super::builder::video_intelligence_service::ListOperations::new(self.inner.clone())
148    }
149
150    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
151    ///
152    /// [google.longrunning.Operations]: longrunning::client::Operations
153    pub fn get_operation(&self) -> super::builder::video_intelligence_service::GetOperation {
154        super::builder::video_intelligence_service::GetOperation::new(self.inner.clone())
155    }
156
157    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
158    ///
159    /// [google.longrunning.Operations]: longrunning::client::Operations
160    pub fn delete_operation(&self) -> super::builder::video_intelligence_service::DeleteOperation {
161        super::builder::video_intelligence_service::DeleteOperation::new(self.inner.clone())
162    }
163
164    /// Provides the [Operations][google.longrunning.Operations] service functionality in this service.
165    ///
166    /// [google.longrunning.Operations]: longrunning::client::Operations
167    pub fn cancel_operation(&self) -> super::builder::video_intelligence_service::CancelOperation {
168        super::builder::video_intelligence_service::CancelOperation::new(self.inner.clone())
169    }
170}
google_cloud_videointelligence_v1/client.rs

google_cloud_videointelligence_v1/
client.rs
