google_cloud_datastore_admin_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::DatastoreAdmin].
33///
34/// Application developers may need to implement this trait to mock
35/// `client::DatastoreAdmin`.  In other use-cases, application developers only
36/// use `client::DatastoreAdmin` 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 DatastoreAdmin: std::fmt::Debug + Send + Sync {
44    /// Implements [super::client::DatastoreAdmin::export_entities].
45    fn export_entities(
46        &self,
47        _req: crate::model::ExportEntitiesRequest,
48        _options: gax::options::RequestOptions,
49    ) -> impl std::future::Future<
50        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
51    > + Send {
52        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
53            Err(Error::other("unimplemented")),
54        )
55    }
56
57    /// Implements [super::client::DatastoreAdmin::import_entities].
58    fn import_entities(
59        &self,
60        _req: crate::model::ImportEntitiesRequest,
61        _options: gax::options::RequestOptions,
62    ) -> impl std::future::Future<
63        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
64    > + Send {
65        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
66            Err(Error::other("unimplemented")),
67        )
68    }
69
70    /// Implements [super::client::DatastoreAdmin::create_index].
71    fn create_index(
72        &self,
73        _req: crate::model::CreateIndexRequest,
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::DatastoreAdmin::delete_index].
84    fn delete_index(
85        &self,
86        _req: crate::model::DeleteIndexRequest,
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::DatastoreAdmin::get_index].
97    fn get_index(
98        &self,
99        _req: crate::model::GetIndexRequest,
100        _options: gax::options::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<gax::response::Response<crate::model::Index>>,
103    > + Send {
104        std::future::ready::<crate::Result<gax::response::Response<crate::model::Index>>>(Err(
105            Error::other("unimplemented"),
106        ))
107    }
108
109    /// Implements [super::client::DatastoreAdmin::list_indexes].
110    fn list_indexes(
111        &self,
112        _req: crate::model::ListIndexesRequest,
113        _options: gax::options::RequestOptions,
114    ) -> impl std::future::Future<
115        Output = crate::Result<gax::response::Response<crate::model::ListIndexesResponse>>,
116    > + Send {
117        std::future::ready::<
118            crate::Result<gax::response::Response<crate::model::ListIndexesResponse>>,
119        >(Err(Error::other("unimplemented")))
120    }
121
122    /// Implements [super::client::DatastoreAdmin::list_operations].
123    fn list_operations(
124        &self,
125        _req: longrunning::model::ListOperationsRequest,
126        _options: gax::options::RequestOptions,
127    ) -> impl std::future::Future<
128        Output = crate::Result<gax::response::Response<longrunning::model::ListOperationsResponse>>,
129    > + Send {
130        std::future::ready::<
131            crate::Result<gax::response::Response<longrunning::model::ListOperationsResponse>>,
132        >(Err(Error::other("unimplemented")))
133    }
134
135    /// Implements [super::client::DatastoreAdmin::get_operation].
136    fn get_operation(
137        &self,
138        _req: longrunning::model::GetOperationRequest,
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::DatastoreAdmin::delete_operation].
149    fn delete_operation(
150        &self,
151        _req: longrunning::model::DeleteOperationRequest,
152        _options: gax::options::RequestOptions,
153    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
154        std::future::ready::<crate::Result<gax::response::Response<()>>>(Err(Error::other(
155            "unimplemented",
156        )))
157    }
158
159    /// Implements [super::client::DatastoreAdmin::cancel_operation].
160    fn cancel_operation(
161        &self,
162        _req: longrunning::model::CancelOperationRequest,
163        _options: gax::options::RequestOptions,
164    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
165        std::future::ready::<crate::Result<gax::response::Response<()>>>(Err(Error::other(
166            "unimplemented",
167        )))
168    }
169
170    /// Returns the polling error policy.
171    ///
172    /// When mocking, this method is typically irrelevant. Do not try to verify
173    /// it is called by your mocks.
174    fn get_polling_error_policy(
175        &self,
176        _options: &gax::options::RequestOptions,
177    ) -> Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
178        Arc::new(gax::polling_error_policy::Aip194Strict)
179    }
180
181    /// Returns the polling backoff policy.
182    ///
183    /// When mocking, this method is typically irrelevant. Do not try to verify
184    /// it is called by your mocks.
185    fn get_polling_backoff_policy(
186        &self,
187        _options: &gax::options::RequestOptions,
188    ) -> Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
189        Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
190    }
191}
google_cloud_datastore_admin_v1/stub.rs

google_cloud_datastore_admin_v1/
stub.rs
