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
27use gax::error::Error;
28
29pub(crate) mod dynamic;
30
31/// Defines the trait used to implement [super::client::CloudShellService].
32///
33/// Application developers may need to implement this trait to mock
34/// `client::CloudShellService`.  In other use-cases, application developers only
35/// use `client::CloudShellService` and need not be concerned with this trait or
36/// its implementations.
37///
38/// Services gain new RPCs routinely. Consequently, this trait gains new methods
39/// too. To avoid breaking applications the trait provides a default
40/// implementation of each method. Most of these implementations just return an
41/// error.
42pub trait CloudShellService: std::fmt::Debug + Send + Sync {
43    /// Implements [super::client::CloudShellService::get_environment].
44    fn get_environment(
45        &self,
46        _req: crate::model::GetEnvironmentRequest,
47        _options: gax::options::RequestOptions,
48    ) -> impl std::future::Future<
49        Output = crate::Result<gax::response::Response<crate::model::Environment>>,
50    > + Send {
51        std::future::ready::<crate::Result<gax::response::Response<crate::model::Environment>>>(
52            Err(Error::other("unimplemented")),
53        )
54    }
55
56    /// Implements [super::client::CloudShellService::start_environment].
57    fn start_environment(
58        &self,
59        _req: crate::model::StartEnvironmentRequest,
60        _options: gax::options::RequestOptions,
61    ) -> impl std::future::Future<
62        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
63    > + Send {
64        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
65            Err(Error::other("unimplemented")),
66        )
67    }
68
69    /// Implements [super::client::CloudShellService::authorize_environment].
70    fn authorize_environment(
71        &self,
72        _req: crate::model::AuthorizeEnvironmentRequest,
73        _options: gax::options::RequestOptions,
74    ) -> impl std::future::Future<
75        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
76    > + Send {
77        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
78            Err(Error::other("unimplemented")),
79        )
80    }
81
82    /// Implements [super::client::CloudShellService::add_public_key].
83    fn add_public_key(
84        &self,
85        _req: crate::model::AddPublicKeyRequest,
86        _options: gax::options::RequestOptions,
87    ) -> impl std::future::Future<
88        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
89    > + Send {
90        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
91            Err(Error::other("unimplemented")),
92        )
93    }
94
95    /// Implements [super::client::CloudShellService::remove_public_key].
96    fn remove_public_key(
97        &self,
98        _req: crate::model::RemovePublicKeyRequest,
99        _options: gax::options::RequestOptions,
100    ) -> impl std::future::Future<
101        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
102    > + Send {
103        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
104            Err(Error::other("unimplemented")),
105        )
106    }
107
108    /// Implements [super::client::CloudShellService::get_operation].
109    fn get_operation(
110        &self,
111        _req: longrunning::model::GetOperationRequest,
112        _options: gax::options::RequestOptions,
113    ) -> impl std::future::Future<
114        Output = crate::Result<gax::response::Response<longrunning::model::Operation>>,
115    > + Send {
116        std::future::ready::<crate::Result<gax::response::Response<longrunning::model::Operation>>>(
117            Err(Error::other("unimplemented")),
118        )
119    }
120
121    /// Returns the polling error policy.
122    ///
123    /// When mocking, this method is typically irrelevant. Do not try to verify
124    /// it is called by your mocks.
125    fn get_polling_error_policy(
126        &self,
127        _options: &gax::options::RequestOptions,
128    ) -> std::sync::Arc<dyn gax::polling_error_policy::PollingErrorPolicy> {
129        std::sync::Arc::new(gax::polling_error_policy::Aip194Strict)
130    }
131
132    /// Returns the polling backoff policy.
133    ///
134    /// When mocking, this method is typically irrelevant. Do not try to verify
135    /// it is called by your mocks.
136    fn get_polling_backoff_policy(
137        &self,
138        _options: &gax::options::RequestOptions,
139    ) -> std::sync::Arc<dyn gax::polling_backoff_policy::PollingBackoffPolicy> {
140        std::sync::Arc::new(gax::exponential_backoff::ExponentialBackoff::default())
141    }
142}
google_cloud_shell_v1/stub.rs

google_cloud_shell_v1/
stub.rs
