google_cloud_storagebatchoperations_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::StorageBatchOperations].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::StorageBatchOperations`.  In other use-cases, application developers only
33/// use `client::StorageBatchOperations` 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 StorageBatchOperations: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::StorageBatchOperations::list_jobs].
42    fn list_jobs(
43        &self,
44        _req: crate::model::ListJobsRequest,
45        _options: gax::options::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<gax::response::Response<crate::model::ListJobsResponse>>,
48    > + Send {
49        gaxi::unimplemented::unimplemented_stub()
50    }
51
52    /// Implements [super::client::StorageBatchOperations::get_job].
53    fn get_job(
54        &self,
55        _req: crate::model::GetJobRequest,
56        _options: gax::options::RequestOptions,
57    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<crate::model::Job>>>
58    + Send {
59        gaxi::unimplemented::unimplemented_stub()
60    }
61
62    /// Implements [super::client::StorageBatchOperations::create_job].
63    fn create_job(
64        &self,
65        _req: crate::model::CreateJobRequest,
66        _options: gax::options::RequestOptions,
67    ) -> impl std::future::Future<
68        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
69    > + Send {
70        gaxi::unimplemented::unimplemented_stub()
71    }
72
73    /// Implements [super::client::StorageBatchOperations::delete_job].
74    fn delete_job(
75        &self,
76        _req: crate::model::DeleteJobRequest,
77        _options: gax::options::RequestOptions,
78    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
79        gaxi::unimplemented::unimplemented_stub()
80    }
81
82    /// Implements [super::client::StorageBatchOperations::cancel_job].
83    fn cancel_job(
84        &self,
85        _req: crate::model::CancelJobRequest,
86        _options: gax::options::RequestOptions,
87    ) -> impl std::future::Future<
88        Output = crate::Result<gax::response::Response<crate::model::CancelJobResponse>>,
89    > + Send {
90        gaxi::unimplemented::unimplemented_stub()
91    }
92
93    /// Implements [super::client::StorageBatchOperations::list_locations].
94    fn list_locations(
95        &self,
96        _req: location::model::ListLocationsRequest,
97        _options: gax::options::RequestOptions,
98    ) -> impl std::future::Future<
99        Output = crate::Result<gax::response::Response<location::model::ListLocationsResponse>>,
100    > + Send {
101        gaxi::unimplemented::unimplemented_stub()
102    }
103
104    /// Implements [super::client::StorageBatchOperations::get_location].
105    fn get_location(
106        &self,
107        _req: location::model::GetLocationRequest,
108        _options: gax::options::RequestOptions,
109    ) -> impl std::future::Future<
110        Output = crate::Result<gax::response::Response<location::model::Location>>,
111    > + Send {
112        gaxi::unimplemented::unimplemented_stub()
113    }
114
115    /// Implements [super::client::StorageBatchOperations::list_operations].
116    fn list_operations(
117        &self,
118        _req: longrunning::model::ListOperationsRequest,
119        _options: gax::options::RequestOptions,
120    ) -> impl std::future::Future<
121        Output = crate::Result<gax::response::Response<longrunning::model::ListOperationsResponse>>,
122    > + Send {
123        gaxi::unimplemented::unimplemented_stub()
124    }
125
126    /// Implements [super::client::StorageBatchOperations::get_operation].
127    fn get_operation(
128        &self,
129        _req: longrunning::model::GetOperationRequest,
130        _options: gax::options::RequestOptions,
131    ) -> impl std::future::Future<
132        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
133    > + Send {
134        gaxi::unimplemented::unimplemented_stub()
135    }
136
137    /// Implements [super::client::StorageBatchOperations::delete_operation].
138    fn delete_operation(
139        &self,
140        _req: longrunning::model::DeleteOperationRequest,
141        _options: gax::options::RequestOptions,
142    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
143        gaxi::unimplemented::unimplemented_stub()
144    }
145
146    /// Implements [super::client::StorageBatchOperations::cancel_operation].
147    fn cancel_operation(
148        &self,
149        _req: longrunning::model::CancelOperationRequest,
150        _options: gax::options::RequestOptions,
151    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
152        gaxi::unimplemented::unimplemented_stub()
153    }
154
155    /// Returns the polling error policy.
156    ///
157    /// When mocking, this method is typically irrelevant. Do not try to verify
158    /// it is called by your mocks.
159    fn get_polling_error_policy(
160        &self,
161        _options: &gax::options::RequestOptions,
162    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
163        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
164    }
165
166    /// Returns the polling backoff policy.
167    ///
168    /// When mocking, this method is typically irrelevant. Do not try to verify
169    /// it is called by your mocks.
170    fn get_polling_backoff_policy(
171        &self,
172        _options: &gax::options::RequestOptions,
173    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
174        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
175    }
176}