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