google_cloud_api_serviceusage_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::ServiceUsage].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::ServiceUsage`.  In other use-cases, application developers only
33/// use `client::ServiceUsage` 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 ServiceUsage: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::ServiceUsage::enable_service].
42    fn enable_service(
43        &self,
44        _req: crate::model::EnableServiceRequest,
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::ServiceUsage::disable_service].
53    fn disable_service(
54        &self,
55        _req: crate::model::DisableServiceRequest,
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::ServiceUsage::get_service].
64    fn get_service(
65        &self,
66        _req: crate::model::GetServiceRequest,
67        _options: gax::options::RequestOptions,
68    ) -> impl std::future::Future<
69        Output = crate::Result<gax::response::Response<crate::model::Service>>,
70    > + Send {
71        gaxi::unimplemented::unimplemented_stub()
72    }
73
74    /// Implements [super::client::ServiceUsage::list_services].
75    fn list_services(
76        &self,
77        _req: crate::model::ListServicesRequest,
78        _options: gax::options::RequestOptions,
79    ) -> impl std::future::Future<
80        Output = crate::Result<gax::response::Response<crate::model::ListServicesResponse>>,
81    > + Send {
82        gaxi::unimplemented::unimplemented_stub()
83    }
84
85    /// Implements [super::client::ServiceUsage::batch_enable_services].
86    fn batch_enable_services(
87        &self,
88        _req: crate::model::BatchEnableServicesRequest,
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::ServiceUsage::batch_get_services].
97    fn batch_get_services(
98        &self,
99        _req: crate::model::BatchGetServicesRequest,
100        _options: gax::options::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<gax::response::Response<crate::model::BatchGetServicesResponse>>,
103    > + Send {
104        gaxi::unimplemented::unimplemented_stub()
105    }
106
107    /// Implements [super::client::ServiceUsage::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::ServiceUsage::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    /// Returns the polling error policy.
130    ///
131    /// When mocking, this method is typically irrelevant. Do not try to verify
132    /// it is called by your mocks.
133    fn get_polling_error_policy(
134        &self,
135        _options: &gax::options::RequestOptions,
136    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
137        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
138    }
139
140    /// Returns the polling backoff policy.
141    ///
142    /// When mocking, this method is typically irrelevant. Do not try to verify
143    /// it is called by your mocks.
144    fn get_polling_backoff_policy(
145        &self,
146        _options: &gax::options::RequestOptions,
147    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
148        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
149    }
150}