Skip to main content

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: crate::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<crate::Response<google_cloud_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: crate::RequestOptions,
57    ) -> impl std::future::Future<
58        Output = crate::Result<crate::Response<google_cloud_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: crate::RequestOptions,
68    ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Service>>> + Send
69    {
70        gaxi::unimplemented::unimplemented_stub()
71    }
72
73    /// Implements [super::client::ServiceUsage::list_services].
74    fn list_services(
75        &self,
76        _req: crate::model::ListServicesRequest,
77        _options: crate::RequestOptions,
78    ) -> impl std::future::Future<
79        Output = crate::Result<crate::Response<crate::model::ListServicesResponse>>,
80    > + Send {
81        gaxi::unimplemented::unimplemented_stub()
82    }
83
84    /// Implements [super::client::ServiceUsage::batch_enable_services].
85    fn batch_enable_services(
86        &self,
87        _req: crate::model::BatchEnableServicesRequest,
88        _options: crate::RequestOptions,
89    ) -> impl std::future::Future<
90        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
91    > + Send {
92        gaxi::unimplemented::unimplemented_stub()
93    }
94
95    /// Implements [super::client::ServiceUsage::batch_get_services].
96    fn batch_get_services(
97        &self,
98        _req: crate::model::BatchGetServicesRequest,
99        _options: crate::RequestOptions,
100    ) -> impl std::future::Future<
101        Output = crate::Result<crate::Response<crate::model::BatchGetServicesResponse>>,
102    > + Send {
103        gaxi::unimplemented::unimplemented_stub()
104    }
105
106    /// Implements [super::client::ServiceUsage::list_operations].
107    fn list_operations(
108        &self,
109        _req: google_cloud_longrunning::model::ListOperationsRequest,
110        _options: crate::RequestOptions,
111    ) -> impl std::future::Future<
112        Output = crate::Result<
113            crate::Response<google_cloud_longrunning::model::ListOperationsResponse>,
114        >,
115    > + Send {
116        gaxi::unimplemented::unimplemented_stub()
117    }
118
119    /// Implements [super::client::ServiceUsage::get_operation].
120    fn get_operation(
121        &self,
122        _req: google_cloud_longrunning::model::GetOperationRequest,
123        _options: crate::RequestOptions,
124    ) -> impl std::future::Future<
125        Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
126    > + Send {
127        gaxi::unimplemented::unimplemented_stub()
128    }
129
130    /// Returns the polling error policy.
131    ///
132    /// When mocking, this method is typically irrelevant. Do not try to verify
133    /// it is called by your mocks.
134    fn get_polling_error_policy(
135        &self,
136        _options: &crate::RequestOptions,
137    ) -> std::sync::Arc<dyn google_cloud_gax::polling_error_policy::PollingErrorPolicy> {
138        std::sync::Arc::new(google_cloud_gax::polling_error_policy::Aip194Strict)
139    }
140
141    /// Returns the polling backoff policy.
142    ///
143    /// When mocking, this method is typically irrelevant. Do not try to verify
144    /// it is called by your mocks.
145    fn get_polling_backoff_policy(
146        &self,
147        _options: &crate::RequestOptions,
148    ) -> std::sync::Arc<dyn google_cloud_gax::polling_backoff_policy::PollingBackoffPolicy> {
149        std::sync::Arc::new(google_cloud_gax::exponential_backoff::ExponentialBackoff::default())
150    }
151}