google_cloud_shell_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::CloudShellService].
30///
31/// Application developers may need to implement this trait to mock
32/// `client::CloudShellService`.  In other use-cases, application developers only
33/// use `client::CloudShellService` 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 CloudShellService: std::fmt::Debug + Send + Sync {
41    /// Implements [super::client::CloudShellService::get_environment].
42    fn get_environment(
43        &self,
44        _req: crate::model::GetEnvironmentRequest,
45        _options: gax::options::RequestOptions,
46    ) -> impl std::future::Future<
47        Output = crate::Result<gax::response::Response<crate::model::Environment>>,
48    > + Send {
49        gaxi::unimplemented::unimplemented_stub()
50    }
51
52    /// Implements [super::client::CloudShellService::start_environment].
53    fn start_environment(
54        &self,
55        _req: crate::model::StartEnvironmentRequest,
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::CloudShellService::authorize_environment].
64    fn authorize_environment(
65        &self,
66        _req: crate::model::AuthorizeEnvironmentRequest,
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::CloudShellService::add_public_key].
75    fn add_public_key(
76        &self,
77        _req: crate::model::AddPublicKeyRequest,
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::CloudShellService::remove_public_key].
86    fn remove_public_key(
87        &self,
88        _req: crate::model::RemovePublicKeyRequest,
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::CloudShellService::get_operation].
97    fn get_operation(
98        &self,
99        _req: longrunning::model::GetOperationRequest,
100        _options: gax::options::RequestOptions,
101    ) -> impl std::future::Future<
102        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
103    > + Send {
104        gaxi::unimplemented::unimplemented_stub()
105    }
106
107    /// Returns the polling error policy.
108    ///
109    /// When mocking, this method is typically irrelevant. Do not try to verify
110    /// it is called by your mocks.
111    fn get_polling_error_policy(
112        &self,
113        _options: &gax::options::RequestOptions,
114    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
115        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
116    }
117
118    /// Returns the polling backoff policy.
119    ///
120    /// When mocking, this method is typically irrelevant. Do not try to verify
121    /// it is called by your mocks.
122    fn get_polling_backoff_policy(
123        &self,
124        _options: &gax::options::RequestOptions,
125    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
126        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
127    }
128}