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: crate::RequestOptions,
46 ) -> impl std::future::Future<Output = crate::Result<crate::Response<crate::model::Environment>>>
47 + Send {
48 gaxi::unimplemented::unimplemented_stub()
49 }
50
51 /// Implements [super::client::CloudShellService::start_environment].
52 fn start_environment(
53 &self,
54 _req: crate::model::StartEnvironmentRequest,
55 _options: crate::RequestOptions,
56 ) -> impl std::future::Future<
57 Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
58 > + Send {
59 gaxi::unimplemented::unimplemented_stub()
60 }
61
62 /// Implements [super::client::CloudShellService::authorize_environment].
63 fn authorize_environment(
64 &self,
65 _req: crate::model::AuthorizeEnvironmentRequest,
66 _options: crate::RequestOptions,
67 ) -> impl std::future::Future<
68 Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
69 > + Send {
70 gaxi::unimplemented::unimplemented_stub()
71 }
72
73 /// Implements [super::client::CloudShellService::add_public_key].
74 fn add_public_key(
75 &self,
76 _req: crate::model::AddPublicKeyRequest,
77 _options: crate::RequestOptions,
78 ) -> impl std::future::Future<
79 Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
80 > + Send {
81 gaxi::unimplemented::unimplemented_stub()
82 }
83
84 /// Implements [super::client::CloudShellService::remove_public_key].
85 fn remove_public_key(
86 &self,
87 _req: crate::model::RemovePublicKeyRequest,
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::CloudShellService::get_operation].
96 fn get_operation(
97 &self,
98 _req: google_cloud_longrunning::model::GetOperationRequest,
99 _options: crate::RequestOptions,
100 ) -> impl std::future::Future<
101 Output = crate::Result<crate::Response<google_cloud_longrunning::model::Operation>>,
102 > + Send {
103 gaxi::unimplemented::unimplemented_stub()
104 }
105
106 /// Returns the polling error policy.
107 ///
108 /// When mocking, this method is typically irrelevant. Do not try to verify
109 /// it is called by your mocks.
110 fn get_polling_error_policy(
111 &self,
112 _options: &crate::RequestOptions,
113 ) -> std::sync::Arc<dyn google_cloud_gax::polling_error_policy::PollingErrorPolicy> {
114 std::sync::Arc::new(google_cloud_gax::polling_error_policy::Aip194Strict)
115 }
116
117 /// Returns the polling backoff policy.
118 ///
119 /// When mocking, this method is typically irrelevant. Do not try to verify
120 /// it is called by your mocks.
121 fn get_polling_backoff_policy(
122 &self,
123 _options: &crate::RequestOptions,
124 ) -> std::sync::Arc<dyn google_cloud_gax::polling_backoff_policy::PollingBackoffPolicy> {
125 std::sync::Arc::new(google_cloud_gax::exponential_backoff::ExponentialBackoff::default())
126 }
127}