google_cloud_redis_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::CloudRedis].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::CloudRedis`.  In other use-cases, application developers only
33/// use `client::CloudRedis` 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 CloudRedis: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::CloudRedis::list_instances].
42    fn list_instances(
43        &self,
44        _req: crate::model::ListInstancesRequest,
45        _options: gax::options::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<gax::response::Response<crate::model::ListInstancesResponse>>,
48    > + Send {
49        gaxi::unimplemented::unimplemented_stub()
50    }
51
52    /// Implements [super::client::CloudRedis::get_instance].
53    fn get_instance(
54        &self,
55        _req: crate::model::GetInstanceRequest,
56        _options: gax::options::RequestOptions,
57    ) -> impl std::future::Future<
58        Output = crate::Result<gax::response::Response<crate::model::Instance>>,
59    > + Send {
60        gaxi::unimplemented::unimplemented_stub()
61    }
62
63    /// Implements [super::client::CloudRedis::get_instance_auth_string].
64    fn get_instance_auth_string(
65        &self,
66        _req: crate::model::GetInstanceAuthStringRequest,
67        _options: gax::options::RequestOptions,
68    ) -> impl std::future::Future<
69        Output = crate::Result<gax::response::Response<crate::model::InstanceAuthString>>,
70    > + Send {
71        gaxi::unimplemented::unimplemented_stub()
72    }
73
74    /// Implements [super::client::CloudRedis::create_instance].
75    fn create_instance(
76        &self,
77        _req: crate::model::CreateInstanceRequest,
78        _options: gax::options::RequestOptions,
79    ) -> impl std::future::Future<
80        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
81    > + Send {
82        gaxi::unimplemented::unimplemented_stub()
83    }
84
85    /// Implements [super::client::CloudRedis::update_instance].
86    fn update_instance(
87        &self,
88        _req: crate::model::UpdateInstanceRequest,
89        _options: gax::options::RequestOptions,
90    ) -> impl std::future::Future<
91        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
92    > + Send {
93        gaxi::unimplemented::unimplemented_stub()
94    }
95
96    /// Implements [super::client::CloudRedis::upgrade_instance].
97    fn upgrade_instance(
98        &self,
99        _req: crate::model::UpgradeInstanceRequest,
100        _options: gax::options::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
103    > + Send {
104        gaxi::unimplemented::unimplemented_stub()
105    }
106
107    /// Implements [super::client::CloudRedis::import_instance].
108    fn import_instance(
109        &self,
110        _req: crate::model::ImportInstanceRequest,
111        _options: gax::options::RequestOptions,
112    ) -> impl std::future::Future<
113        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
114    > + Send {
115        gaxi::unimplemented::unimplemented_stub()
116    }
117
118    /// Implements [super::client::CloudRedis::export_instance].
119    fn export_instance(
120        &self,
121        _req: crate::model::ExportInstanceRequest,
122        _options: gax::options::RequestOptions,
123    ) -> impl std::future::Future<
124        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
125    > + Send {
126        gaxi::unimplemented::unimplemented_stub()
127    }
128
129    /// Implements [super::client::CloudRedis::failover_instance].
130    fn failover_instance(
131        &self,
132        _req: crate::model::FailoverInstanceRequest,
133        _options: gax::options::RequestOptions,
134    ) -> impl std::future::Future<
135        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
136    > + Send {
137        gaxi::unimplemented::unimplemented_stub()
138    }
139
140    /// Implements [super::client::CloudRedis::delete_instance].
141    fn delete_instance(
142        &self,
143        _req: crate::model::DeleteInstanceRequest,
144        _options: gax::options::RequestOptions,
145    ) -> impl std::future::Future<
146        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
147    > + Send {
148        gaxi::unimplemented::unimplemented_stub()
149    }
150
151    /// Implements [super::client::CloudRedis::reschedule_maintenance].
152    fn reschedule_maintenance(
153        &self,
154        _req: crate::model::RescheduleMaintenanceRequest,
155        _options: gax::options::RequestOptions,
156    ) -> impl std::future::Future<
157        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
158    > + Send {
159        gaxi::unimplemented::unimplemented_stub()
160    }
161
162    /// Implements [super::client::CloudRedis::list_locations].
163    fn list_locations(
164        &self,
165        _req: location::model::ListLocationsRequest,
166        _options: gax::options::RequestOptions,
167    ) -> impl std::future::Future<
168        Output = crate::Result<gax::response::Response<location::model::ListLocationsResponse>>,
169    > + Send {
170        gaxi::unimplemented::unimplemented_stub()
171    }
172
173    /// Implements [super::client::CloudRedis::get_location].
174    fn get_location(
175        &self,
176        _req: location::model::GetLocationRequest,
177        _options: gax::options::RequestOptions,
178    ) -> impl std::future::Future<
179        Output = crate::Result<gax::response::Response<location::model::Location>>,
180    > + Send {
181        gaxi::unimplemented::unimplemented_stub()
182    }
183
184    /// Implements [super::client::CloudRedis::list_operations].
185    fn list_operations(
186        &self,
187        _req: longrunning::model::ListOperationsRequest,
188        _options: gax::options::RequestOptions,
189    ) -> impl std::future::Future<
190        Output = crate::Result<gax::response::Response<longrunning::model::ListOperationsResponse>>,
191    > + Send {
192        gaxi::unimplemented::unimplemented_stub()
193    }
194
195    /// Implements [super::client::CloudRedis::get_operation].
196    fn get_operation(
197        &self,
198        _req: longrunning::model::GetOperationRequest,
199        _options: gax::options::RequestOptions,
200    ) -> impl std::future::Future<
201        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
202    > + Send {
203        gaxi::unimplemented::unimplemented_stub()
204    }
205
206    /// Implements [super::client::CloudRedis::delete_operation].
207    fn delete_operation(
208        &self,
209        _req: longrunning::model::DeleteOperationRequest,
210        _options: gax::options::RequestOptions,
211    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
212        gaxi::unimplemented::unimplemented_stub()
213    }
214
215    /// Implements [super::client::CloudRedis::cancel_operation].
216    fn cancel_operation(
217        &self,
218        _req: longrunning::model::CancelOperationRequest,
219        _options: gax::options::RequestOptions,
220    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
221        gaxi::unimplemented::unimplemented_stub()
222    }
223
224    /// Returns the polling error policy.
225    ///
226    /// When mocking, this method is typically irrelevant. Do not try to verify
227    /// it is called by your mocks.
228    fn get_polling_error_policy(
229        &self,
230        _options: &gax::options::RequestOptions,
231    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
232        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
233    }
234
235    /// Returns the polling backoff policy.
236    ///
237    /// When mocking, this method is typically irrelevant. Do not try to verify
238    /// it is called by your mocks.
239    fn get_polling_backoff_policy(
240        &self,
241        _options: &gax::options::RequestOptions,
242    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
243        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
244    }
245}