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
27pub(crate) mod dynamic;
28
29/// Defines the trait used to implement [super::client::DatastoreAdmin].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::DatastoreAdmin`.  In other use-cases, application developers only
33/// use `client::DatastoreAdmin` 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 DatastoreAdmin: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::DatastoreAdmin::export_entities].
42    fn export_entities(
43        &self,
44        _req: crate::model::ExportEntitiesRequest,
45        _options: gax::options::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
48    > + Send {
49        gaxi::unimplemented::unimplemented_stub()
50    }
51
52    /// Implements [super::client::DatastoreAdmin::import_entities].
53    fn import_entities(
54        &self,
55        _req: crate::model::ImportEntitiesRequest,
56        _options: gax::options::RequestOptions,
57    ) -> impl std::future::Future<
58        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
59    > + Send {
60        gaxi::unimplemented::unimplemented_stub()
61    }
62
63    /// Implements [super::client::DatastoreAdmin::create_index].
64    fn create_index(
65        &self,
66        _req: crate::model::CreateIndexRequest,
67        _options: gax::options::RequestOptions,
68    ) -> impl std::future::Future<
69        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
70    > + Send {
71        gaxi::unimplemented::unimplemented_stub()
72    }
73
74    /// Implements [super::client::DatastoreAdmin::delete_index].
75    fn delete_index(
76        &self,
77        _req: crate::model::DeleteIndexRequest,
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::DatastoreAdmin::get_index].
86    fn get_index(
87        &self,
88        _req: crate::model::GetIndexRequest,
89        _options: gax::options::RequestOptions,
90    ) -> impl std::future::Future<
91        Output = crate::Result<gax::response::Response<crate::model::Index>>,
92    > + Send {
93        gaxi::unimplemented::unimplemented_stub()
94    }
95
96    /// Implements [super::client::DatastoreAdmin::list_indexes].
97    fn list_indexes(
98        &self,
99        _req: crate::model::ListIndexesRequest,
100        _options: gax::options::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<gax::response::Response<crate::model::ListIndexesResponse>>,
103    > + Send {
104        gaxi::unimplemented::unimplemented_stub()
105    }
106
107    /// Implements [super::client::DatastoreAdmin::list_operations].
108    fn list_operations(
109        &self,
110        _req: longrunning::model::ListOperationsRequest,
111        _options: gax::options::RequestOptions,
112    ) -> impl std::future::Future<
113        Output = crate::Result<gax::response::Response<longrunning::model::ListOperationsResponse>>,
114    > + Send {
115        gaxi::unimplemented::unimplemented_stub()
116    }
117
118    /// Implements [super::client::DatastoreAdmin::get_operation].
119    fn get_operation(
120        &self,
121        _req: longrunning::model::GetOperationRequest,
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::DatastoreAdmin::delete_operation].
130    fn delete_operation(
131        &self,
132        _req: longrunning::model::DeleteOperationRequest,
133        _options: gax::options::RequestOptions,
134    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
135        gaxi::unimplemented::unimplemented_stub()
136    }
137
138    /// Implements [super::client::DatastoreAdmin::cancel_operation].
139    fn cancel_operation(
140        &self,
141        _req: longrunning::model::CancelOperationRequest,
142        _options: gax::options::RequestOptions,
143    ) -> impl std::future::Future<Output = crate::Result<gax::response::Response<()>>> + Send {
144        gaxi::unimplemented::unimplemented_stub()
145    }
146
147    /// Returns the polling error policy.
148    ///
149    /// When mocking, this method is typically irrelevant. Do not try to verify
150    /// it is called by your mocks.
151    fn get_polling_error_policy(
152        &self,
153        _options: &gax::options::RequestOptions,
154    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
155        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
156    }
157
158    /// Returns the polling backoff policy.
159    ///
160    /// When mocking, this method is typically irrelevant. Do not try to verify
161    /// it is called by your mocks.
162    fn get_polling_backoff_policy(
163        &self,
164        _options: &gax::options::RequestOptions,
165    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
166        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
167    }
168}