google_cloud_documentai_v1/
stub.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//! Traits to mock the clients in this library.
18//!
19//! Application developers may need to mock the clients in this library to test
20//! how their application works with different (and sometimes hard to trigger)
21//! client and service behavior. Such test can define mocks implementing the
22//! trait(s) defined in this module, initialize the client with an instance of
23//! this mock in their tests, and verify their application responds as expected.
24
25#![allow(rustdoc::broken_intra_doc_links)]
26
27pub(crate) mod dynamic;
28
29/// Defines the trait used to implement [super::client::DocumentProcessorService].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::DocumentProcessorService`.  In other use-cases, application developers only
33/// use `client::DocumentProcessorService` and need not be concerned with this trait or
34/// its implementations.
35///
36/// Services gain new RPCs routinely. Consequently, this trait gains new methods
37/// too. To avoid breaking applications the trait provides a default
38/// implementation of each method. Most of these implementations just return an
39/// error.
40pub trait DocumentProcessorService: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::DocumentProcessorService::process_document].
42    fn process_document(
43        &self,
44        _req: crate::model::ProcessRequest,
45        _options: crate::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<crate::Response<crate::model::ProcessResponse>>,
48    > + Send {
49        gaxi::unimplemented::unimplemented_stub()
50    }
51
52    /// Implements [super::client::DocumentProcessorService::batch_process_documents].
53    fn batch_process_documents(
54        &self,
55        _req: crate::model::BatchProcessRequest,
56        _options: crate::RequestOptions,
57    ) -> impl std::future::Future<
58        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
59    > + Send {
60        gaxi::unimplemented::unimplemented_stub()
61    }
62
63    /// Implements [super::client::DocumentProcessorService::fetch_processor_types].
64    fn fetch_processor_types(
65        &self,
66        _req: crate::model::FetchProcessorTypesRequest,
67        _options: crate::RequestOptions,
68    ) -> impl std::future::Future<
69        Output = crate::Result<crate::Response<crate::model::FetchProcessorTypesResponse>>,
70    > + Send {
71        gaxi::unimplemented::unimplemented_stub()
72    }
73
74    /// Implements [super::client::DocumentProcessorService::list_processor_types].
75    fn list_processor_types(
76        &self,
77        _req: crate::model::ListProcessorTypesRequest,
78        _options: crate::RequestOptions,
79    ) -> impl std::future::Future<
80        Output = crate::Result<crate::Response<crate::model::ListProcessorTypesResponse>>,
81    > + Send {
82        gaxi::unimplemented::unimplemented_stub()
83    }
84
85    /// Implements [super::client::DocumentProcessorService::get_processor_type].
86    fn get_processor_type(
87        &self,
88        _req: crate::model::GetProcessorTypeRequest,
89        _options: crate::RequestOptions,
90    ) -> impl std::future::Future<
91        Output = crate::Result<crate::Response<crate::model::ProcessorType>>,
92    > + Send {
93        gaxi::unimplemented::unimplemented_stub()
94    }
95
96    /// Implements [super::client::DocumentProcessorService::list_processors].
97    fn list_processors(
98        &self,
99        _req: crate::model::ListProcessorsRequest,
100        _options: crate::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<crate::Response<crate::model::ListProcessorsResponse>>,
103    > + Send {
104        gaxi::unimplemented::unimplemented_stub()
105    }
106
107    /// Implements [super::client::DocumentProcessorService::get_processor].
108    fn get_processor(
109        &self,
110        _req: crate::model::GetProcessorRequest,
111        _options: crate::RequestOptions,
112    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Processor>>> + Send
113    {
114        gaxi::unimplemented::unimplemented_stub()
115    }
116
117    /// Implements [super::client::DocumentProcessorService::train_processor_version].
118    fn train_processor_version(
119        &self,
120        _req: crate::model::TrainProcessorVersionRequest,
121        _options: crate::RequestOptions,
122    ) -> impl std::future::Future<
123        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
124    > + Send {
125        gaxi::unimplemented::unimplemented_stub()
126    }
127
128    /// Implements [super::client::DocumentProcessorService::get_processor_version].
129    fn get_processor_version(
130        &self,
131        _req: crate::model::GetProcessorVersionRequest,
132        _options: crate::RequestOptions,
133    ) -> impl std::future::Future<
134        Output = crate::Result<crate::Response<crate::model::ProcessorVersion>>,
135    > + Send {
136        gaxi::unimplemented::unimplemented_stub()
137    }
138
139    /// Implements [super::client::DocumentProcessorService::list_processor_versions].
140    fn list_processor_versions(
141        &self,
142        _req: crate::model::ListProcessorVersionsRequest,
143        _options: crate::RequestOptions,
144    ) -> impl std::future::Future<
145        Output = crate::Result<crate::Response<crate::model::ListProcessorVersionsResponse>>,
146    > + Send {
147        gaxi::unimplemented::unimplemented_stub()
148    }
149
150    /// Implements [super::client::DocumentProcessorService::delete_processor_version].
151    fn delete_processor_version(
152        &self,
153        _req: crate::model::DeleteProcessorVersionRequest,
154        _options: crate::RequestOptions,
155    ) -> impl std::future::Future<
156        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
157    > + Send {
158        gaxi::unimplemented::unimplemented_stub()
159    }
160
161    /// Implements [super::client::DocumentProcessorService::deploy_processor_version].
162    fn deploy_processor_version(
163        &self,
164        _req: crate::model::DeployProcessorVersionRequest,
165        _options: crate::RequestOptions,
166    ) -> impl std::future::Future<
167        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
168    > + Send {
169        gaxi::unimplemented::unimplemented_stub()
170    }
171
172    /// Implements [super::client::DocumentProcessorService::undeploy_processor_version].
173    fn undeploy_processor_version(
174        &self,
175        _req: crate::model::UndeployProcessorVersionRequest,
176        _options: crate::RequestOptions,
177    ) -> impl std::future::Future<
178        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
179    > + Send {
180        gaxi::unimplemented::unimplemented_stub()
181    }
182
183    /// Implements [super::client::DocumentProcessorService::create_processor].
184    fn create_processor(
185        &self,
186        _req: crate::model::CreateProcessorRequest,
187        _options: crate::RequestOptions,
188    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Processor>>> + Send
189    {
190        gaxi::unimplemented::unimplemented_stub()
191    }
192
193    /// Implements [super::client::DocumentProcessorService::delete_processor].
194    fn delete_processor(
195        &self,
196        _req: crate::model::DeleteProcessorRequest,
197        _options: crate::RequestOptions,
198    ) -> impl std::future::Future<
199        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
200    > + Send {
201        gaxi::unimplemented::unimplemented_stub()
202    }
203
204    /// Implements [super::client::DocumentProcessorService::enable_processor].
205    fn enable_processor(
206        &self,
207        _req: crate::model::EnableProcessorRequest,
208        _options: crate::RequestOptions,
209    ) -> impl std::future::Future<
210        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
211    > + Send {
212        gaxi::unimplemented::unimplemented_stub()
213    }
214
215    /// Implements [super::client::DocumentProcessorService::disable_processor].
216    fn disable_processor(
217        &self,
218        _req: crate::model::DisableProcessorRequest,
219        _options: crate::RequestOptions,
220    ) -> impl std::future::Future<
221        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
222    > + Send {
223        gaxi::unimplemented::unimplemented_stub()
224    }
225
226    /// Implements [super::client::DocumentProcessorService::set_default_processor_version].
227    fn set_default_processor_version(
228        &self,
229        _req: crate::model::SetDefaultProcessorVersionRequest,
230        _options: crate::RequestOptions,
231    ) -> impl std::future::Future<
232        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
233    > + Send {
234        gaxi::unimplemented::unimplemented_stub()
235    }
236
237    /// Implements [super::client::DocumentProcessorService::review_document].
238    fn review_document(
239        &self,
240        _req: crate::model::ReviewDocumentRequest,
241        _options: crate::RequestOptions,
242    ) -> impl std::future::Future<
243        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
244    > + Send {
245        gaxi::unimplemented::unimplemented_stub()
246    }
247
248    /// Implements [super::client::DocumentProcessorService::evaluate_processor_version].
249    fn evaluate_processor_version(
250        &self,
251        _req: crate::model::EvaluateProcessorVersionRequest,
252        _options: crate::RequestOptions,
253    ) -> impl std::future::Future<
254        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
255    > + Send {
256        gaxi::unimplemented::unimplemented_stub()
257    }
258
259    /// Implements [super::client::DocumentProcessorService::get_evaluation].
260    fn get_evaluation(
261        &self,
262        _req: crate::model::GetEvaluationRequest,
263        _options: crate::RequestOptions,
264    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Evaluation>>> + Send
265    {
266        gaxi::unimplemented::unimplemented_stub()
267    }
268
269    /// Implements [super::client::DocumentProcessorService::list_evaluations].
270    fn list_evaluations(
271        &self,
272        _req: crate::model::ListEvaluationsRequest,
273        _options: crate::RequestOptions,
274    ) -> impl std::future::Future<
275        Output = crate::Result<crate::Response<crate::model::ListEvaluationsResponse>>,
276    > + Send {
277        gaxi::unimplemented::unimplemented_stub()
278    }
279
280    /// Implements [super::client::DocumentProcessorService::list_locations].
281    fn list_locations(
282        &self,
283        _req: google_cloud_location::model::ListLocationsRequest,
284        _options: crate::RequestOptions,
285    ) -> impl std::future::Future<
286        Output = crate::Result<
287            crate::Response<google_cloud_location::model::ListLocationsResponse>,
288        >,
289    > + Send {
290        gaxi::unimplemented::unimplemented_stub()
291    }
292
293    /// Implements [super::client::DocumentProcessorService::get_location].
294    fn get_location(
295        &self,
296        _req: google_cloud_location::model::GetLocationRequest,
297        _options: crate::RequestOptions,
298    ) -> impl std::future::Future<
299        Output = crate::Result<crate::Response<google_cloud_location::model::Location>>,
300    > + Send {
301        gaxi::unimplemented::unimplemented_stub()
302    }
303
304    /// Implements [super::client::DocumentProcessorService::list_operations].
305    fn list_operations(
306        &self,
307        _req: google_cloud_longrunning::model::ListOperationsRequest,
308        _options: crate::RequestOptions,
309    ) -> impl std::future::Future<
310        Output = crate::Result<
311            crate::Response<google_cloud_longrunning::model::ListOperationsResponse>,
312        >,
313    > + Send {
314        gaxi::unimplemented::unimplemented_stub()
315    }
316
317    /// Implements [super::client::DocumentProcessorService::get_operation].
318    fn get_operation(
319        &self,
320        _req: google_cloud_longrunning::model::GetOperationRequest,
321        _options: crate::RequestOptions,
322    ) -> impl std::future::Future<
323        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
324    > + Send {
325        gaxi::unimplemented::unimplemented_stub()
326    }
327
328    /// Implements [super::client::DocumentProcessorService::cancel_operation].
329    fn cancel_operation(
330        &self,
331        _req: google_cloud_longrunning::model::CancelOperationRequest,
332        _options: crate::RequestOptions,
333    ) -> impl std::future::Future<Output = crate::Result<crate::Response<()>>> + Send {
334        gaxi::unimplemented::unimplemented_stub()
335    }
336
337    /// Returns the polling error policy.
338    ///
339    /// When mocking, this method is typically irrelevant. Do not try to verify
340    /// it is called by your mocks.
341    fn get_polling_error_policy(
342        &self,
343        _options: &crate::RequestOptions,
344    ) -> std::sync::Arc<dyn google_cloud_gax::polling_error_policy::PollingErrorPolicy> {
345        std::sync::Arc::new(google_cloud_gax::polling_error_policy::Aip194Strict)
346    }
347
348    /// Returns the polling backoff policy.
349    ///
350    /// When mocking, this method is typically irrelevant. Do not try to verify
351    /// it is called by your mocks.
352    fn get_polling_backoff_policy(
353        &self,
354        _options: &crate::RequestOptions,
355    ) -> std::sync::Arc<dyn google_cloud_gax::polling_backoff_policy::PollingBackoffPolicy> {
356        std::sync::Arc::new(google_cloud_gax::exponential_backoff::ExponentialBackoff::default())
357    }
358}
google_cloud_documentai_v1/stub.rs

google_cloud_documentai_v1/
stub.rs
