google-apis-cloudshell_v1alpha1 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: f0b1032a2367a819ce4506096890081c2b32db4d2a6d73ce48734e2664c89759
4
+ data.tar.gz: 31a84da136cbea88dfba18eadf9607bf0940307520bfe7605f411d885bc1a75f
5
+ SHA512:
6
+ metadata.gz: 390c7b6ffa241580fd11e3b7cb38753a59a27fe24a5af47babd3c4c8318611686be0522f591d58912dffdc5947c4146cf9fafa753da9f7cc299c5813b23cbe3e
7
+ data.tar.gz: de9ca88480aec3a18193e913e40312c7d7f2fbcf895da9240dfbc634369d962e291dcd96906890de67d1a7c3364c1625cc831089ff14fbc4cc9686ba3e4ac9b5
@@ -0,0 +1,13 @@
1
+ --hide-void-return
2
+ --no-private
3
+ --verbose
4
+ --title=google-apis-cloudshell_v1alpha1
5
+ --markup-provider=redcarpet
6
+ --markup=markdown
7
+ --main OVERVIEW.md
8
+ lib/google/apis/cloudshell_v1alpha1/*.rb
9
+ lib/google/apis/cloudshell_v1alpha1.rb
10
+ -
11
+ OVERVIEW.md
12
+ CHANGELOG.md
13
+ LICENSE.md
@@ -0,0 +1,7 @@
1
+ # Release history for google-apis-cloudshell_v1alpha1
2
+
3
+ ### v0.1.0 (2021-01-07)
4
+
5
+ * Regenerated using generator version 0.1.1
6
+ * Regenerated from discovery document revision 20200803
7
+
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,96 @@
1
+ # Simple REST client for version V1alpha1 of the Cloud Shell API
2
+
3
+ This is a simple client library for version V1alpha1 of the Cloud Shell API. It provides:
4
+
5
+ * A client object that connects to the HTTP/JSON REST endpoint for the service.
6
+ * Ruby objects for data structures related to the service.
7
+ * Integration with the googleauth gem for authentication using OAuth, API keys, and service accounts.
8
+ * Control of retry, pagination, and timeouts.
9
+
10
+ Note that although this client library is supported and will continue to be updated to track changes to the service, it is otherwise considered complete and not under active development. Many Google services, especially Google Cloud Platform services, may provide a more modern client that is under more active development and improvement. See the section below titled *Which client should I use?* for more information.
11
+
12
+ ## Getting started
13
+
14
+ ### Before you begin
15
+
16
+ There are a few setup steps you need to complete before you can use this library:
17
+
18
+ 1. If you don't already have a Google account, [sign up](https://www.google.com/accounts).
19
+ 2. If you have never created a Google APIs Console project, read about [Managing Projects](https://cloud.google.com/resource-manager/docs/creating-managing-projects) and create a project in the [Google API Console](https://console.cloud.google.com/).
20
+ 3. Most APIs need to be enabled for your project. [Enable it](https://console.cloud.google.com/apis/library/cloudshell.googleapis.com) in the console.
21
+
22
+ ### Installation
23
+
24
+ Add this line to your application's Gemfile:
25
+
26
+ ```ruby
27
+ gem 'google-apis-cloudshell_v1alpha1', '~> 0.1'
28
+ ```
29
+
30
+ And then execute:
31
+
32
+ ```
33
+ $ bundle
34
+ ```
35
+
36
+ Or install it yourself as:
37
+
38
+ ```
39
+ $ gem install google-apis-cloudshell_v1alpha1
40
+ ```
41
+
42
+ ### Creating a client object
43
+
44
+ Once the gem is installed, you can load the client code and instantiate a client.
45
+
46
+ ```ruby
47
+ # Load the client
48
+ require "google/apis/cloudshell_v1alpha1"
49
+
50
+ # Create a client object
51
+ client = Google::Apis::CloudshellV1alpha1::CloudShellService.new
52
+
53
+ # Authenticate calls
54
+ client.authentication = # ... use the googleauth gem to create credentials
55
+ ```
56
+
57
+ See the class reference docs for information on the methods you can call from a client.
58
+
59
+ ## Documentation
60
+
61
+ More detailed descriptions of the Google simple REST clients are available in two documents.
62
+
63
+ * The [Usage Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/usage-guide.md) discusses how to make API calls, how to use the provided data structures, and how to work the various features of the client library, including media upload and download, error handling, retries, pagination, and logging.
64
+ * The [Auth Guide](https://github.com/googleapis/google-api-ruby-client/blob/master/docs/auth-guide.md) discusses authentication in the client libraries, including API keys, OAuth 2.0, service accounts, and environment variables.
65
+
66
+ (Note: the above documents are written for the simple REST clients in general, and their examples may not reflect the Cloudshell service in particular.)
67
+
68
+ For reference information on specific calls in the Cloud Shell API, see the {Google::Apis::CloudshellV1alpha1::CloudShellService class reference docs}.
69
+
70
+ ## Which client should I use?
71
+
72
+ Google provides two types of Ruby API client libraries: **simple REST clients** and **modern clients**.
73
+
74
+ This library, `google-apis-cloudshell_v1alpha1`, is a simple REST client. You can identify these clients by their gem names, which are always in the form `google-apis-<servicename>_<serviceversion>`. The simple REST clients connect to HTTP/JSON REST endpoints and are automatically generated from service discovery documents. They support most API functionality, but their class interfaces are sometimes awkward.
75
+
76
+ Modern clients are produced by a modern code generator, sometimes combined with hand-crafted functionality. Most modern clients connect to high-performance gRPC endpoints, although a few are backed by REST services. Modern clients are available for many Google services, especially Google Cloud Platform services, but do not yet support all the services covered by the simple clients.
77
+
78
+ Gem names for modern clients are often of the form `google-cloud-<service_name>`. (For example, [google-cloud-pubsub](https://rubygems.org/gems/google-cloud-pubsub).) Note that most modern clients also have corresponding "versioned" gems with names like `google-cloud-<service_name>-<version>`. (For example, [google-cloud-pubsub-v1](https://rubygems.org/gems/google-cloud-pubsub-v1).) The "versioned" gems can be used directly, but often provide lower-level interfaces. In most cases, the main gem is recommended.
79
+
80
+ **For most users, we recommend the modern client, if one is available.** Compared with simple clients, modern clients are generally much easier to use and more Ruby-like, support more advanced features such as streaming and long-running operations, and often provide much better performance. You may consider using a simple client instead, if a modern client is not yet available for the service you want to use, or if you are not able to use gRPC on your infrastructure.
81
+
82
+ The [product documentation](https://cloud.google.com/shell/docs/) may provide guidance regarding the preferred client library to use.
83
+
84
+ ## Supported Ruby versions
85
+
86
+ This library is supported on Ruby 2.5+.
87
+
88
+ Google provides official support for Ruby versions that are actively supported by Ruby Core -- that is, Ruby versions that are either in normal maintenance or in security maintenance, and not end of life. Currently, this means Ruby 2.5 and later. Older versions of Ruby _may_ still work, but are unsupported and not recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details about the Ruby support schedule.
89
+
90
+ ## License
91
+
92
+ This library is licensed under Apache 2.0. Full license text is available in the {file:LICENSE.md LICENSE}.
93
+
94
+ ## Support
95
+
96
+ Please [report bugs at the project on Github](https://github.com/google/google-api-ruby-client/issues). Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-api-ruby-client) about the client or APIs on [StackOverflow](http://stackoverflow.com).
@@ -0,0 +1,15 @@
1
+ # Copyright 2020 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
+ # http://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
+ require "google/apis/cloudshell_v1alpha1"
@@ -0,0 +1,37 @@
1
+ # Copyright 2020 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
+ # http://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
+ require 'google/apis/cloudshell_v1alpha1/service.rb'
16
+ require 'google/apis/cloudshell_v1alpha1/classes.rb'
17
+ require 'google/apis/cloudshell_v1alpha1/representations.rb'
18
+ require 'google/apis/cloudshell_v1alpha1/gem_version.rb'
19
+
20
+ module Google
21
+ module Apis
22
+ # Cloud Shell API
23
+ #
24
+ # Allows users to start, configure, and connect to interactive shell sessions
25
+ # running in the cloud.
26
+ #
27
+ # @see https://cloud.google.com/shell/docs/
28
+ module CloudshellV1alpha1
29
+ # Version of the Cloud Shell API this client connects to.
30
+ # This is NOT the gem version.
31
+ VERSION = 'V1alpha1'
32
+
33
+ # View and manage your data across Google Cloud Platform services
34
+ AUTH_CLOUD_PLATFORM = 'https://www.googleapis.com/auth/cloud-platform'
35
+ end
36
+ end
37
+ end
@@ -0,0 +1,408 @@
1
+ # Copyright 2020 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
+ # http://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
+ require 'date'
16
+ require 'google/apis/core/base_service'
17
+ require 'google/apis/core/json_representation'
18
+ require 'google/apis/core/hashable'
19
+ require 'google/apis/errors'
20
+
21
+ module Google
22
+ module Apis
23
+ module CloudshellV1alpha1
24
+
25
+ # Request message for AuthorizeEnvironment.
26
+ class AuthorizeEnvironmentRequest
27
+ include Google::Apis::Core::Hashable
28
+
29
+ # The OAuth access token that should be sent to the environment.
30
+ # Corresponds to the JSON property `accessToken`
31
+ # @return [String]
32
+ attr_accessor :access_token
33
+
34
+ # The time when the credentials expire. If not set, defaults to one hour from
35
+ # when the server received the request.
36
+ # Corresponds to the JSON property `expireTime`
37
+ # @return [String]
38
+ attr_accessor :expire_time
39
+
40
+ # The OAuth ID token that should be sent to the environment.
41
+ # Corresponds to the JSON property `idToken`
42
+ # @return [String]
43
+ attr_accessor :id_token
44
+
45
+ def initialize(**args)
46
+ update!(**args)
47
+ end
48
+
49
+ # Update properties of this object
50
+ def update!(**args)
51
+ @access_token = args[:access_token] if args.key?(:access_token)
52
+ @expire_time = args[:expire_time] if args.key?(:expire_time)
53
+ @id_token = args[:id_token] if args.key?(:id_token)
54
+ end
55
+ end
56
+
57
+ # Request message for CreatePublicKey.
58
+ class CreatePublicKeyRequest
59
+ include Google::Apis::Core::Hashable
60
+
61
+ # A public SSH key, corresponding to a private SSH key held by the client.
62
+ # Corresponds to the JSON property `key`
63
+ # @return [Google::Apis::CloudshellV1alpha1::PublicKey]
64
+ attr_accessor :key
65
+
66
+ def initialize(**args)
67
+ update!(**args)
68
+ end
69
+
70
+ # Update properties of this object
71
+ def update!(**args)
72
+ @key = args[:key] if args.key?(:key)
73
+ end
74
+ end
75
+
76
+ # A generic empty message that you can re-use to avoid defining duplicated empty
77
+ # messages in your APIs. A typical example is to use it as the request or the
78
+ # response type of an API method. For instance: service Foo ` rpc Bar(google.
79
+ # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for
80
+ # `Empty` is empty JSON object ````.
81
+ class Empty
82
+ include Google::Apis::Core::Hashable
83
+
84
+ def initialize(**args)
85
+ update!(**args)
86
+ end
87
+
88
+ # Update properties of this object
89
+ def update!(**args)
90
+ end
91
+ end
92
+
93
+ # A Cloud Shell environment, which is defined as the combination of a Docker
94
+ # image specifying what is installed on the environment and a home directory
95
+ # containing the user's data that will remain across sessions. Each user has a
96
+ # single environment with the ID "default".
97
+ class Environment
98
+ include Google::Apis::Core::Hashable
99
+
100
+ # Required. Full path to the Docker image used to run this environment, e.g. "
101
+ # gcr.io/dev-con/cloud-devshell:latest".
102
+ # Corresponds to the JSON property `dockerImage`
103
+ # @return [String]
104
+ attr_accessor :docker_image
105
+
106
+ # Output only. The environment's identifier, unique among the user's
107
+ # environments.
108
+ # Corresponds to the JSON property `id`
109
+ # @return [String]
110
+ attr_accessor :id
111
+
112
+ # Output only. Full name of this resource, in the format `users/`owner_email`/
113
+ # environments/`environment_id``. ``owner_email`` is the email address of the
114
+ # user to whom this environment belongs, and ``environment_id`` is the
115
+ # identifier of this environment. For example, `users/someone@example.com/
116
+ # environments/default`.
117
+ # Corresponds to the JSON property `name`
118
+ # @return [String]
119
+ attr_accessor :name
120
+
121
+ # Output only. Public keys associated with the environment. Clients can connect
122
+ # to this environment via SSH only if they possess a private key corresponding
123
+ # to at least one of these public keys. Keys can be added to or removed from the
124
+ # environment using the CreatePublicKey and DeletePublicKey methods.
125
+ # Corresponds to the JSON property `publicKeys`
126
+ # @return [Array<Google::Apis::CloudshellV1alpha1::PublicKey>]
127
+ attr_accessor :public_keys
128
+
129
+ # Indicates the size of the backing VM running the environment. If set to
130
+ # something other than DEFAULT, it will be reverted to the default VM size after
131
+ # vm_size_expire_time.
132
+ # Corresponds to the JSON property `size`
133
+ # @return [String]
134
+ attr_accessor :size
135
+
136
+ # Output only. Host to which clients can connect to initiate SSH sessions with
137
+ # the environment.
138
+ # Corresponds to the JSON property `sshHost`
139
+ # @return [String]
140
+ attr_accessor :ssh_host
141
+
142
+ # Output only. Port to which clients can connect to initiate SSH sessions with
143
+ # the environment.
144
+ # Corresponds to the JSON property `sshPort`
145
+ # @return [Fixnum]
146
+ attr_accessor :ssh_port
147
+
148
+ # Output only. Username that clients should use when initiating SSH sessions
149
+ # with the environment.
150
+ # Corresponds to the JSON property `sshUsername`
151
+ # @return [String]
152
+ attr_accessor :ssh_username
153
+
154
+ # Output only. Current execution state of this environment.
155
+ # Corresponds to the JSON property `state`
156
+ # @return [String]
157
+ attr_accessor :state
158
+
159
+ # Output only. The time when the Environment will expire back to the default VM
160
+ # size.
161
+ # Corresponds to the JSON property `vmSizeExpireTime`
162
+ # @return [String]
163
+ attr_accessor :vm_size_expire_time
164
+
165
+ # Output only. Host to which clients can connect to initiate HTTPS or WSS
166
+ # connections with the environment.
167
+ # Corresponds to the JSON property `webHost`
168
+ # @return [String]
169
+ attr_accessor :web_host
170
+
171
+ # Output only. Ports to which clients can connect to initiate HTTPS or WSS
172
+ # connections with the environment.
173
+ # Corresponds to the JSON property `webPorts`
174
+ # @return [Array<Fixnum>]
175
+ attr_accessor :web_ports
176
+
177
+ def initialize(**args)
178
+ update!(**args)
179
+ end
180
+
181
+ # Update properties of this object
182
+ def update!(**args)
183
+ @docker_image = args[:docker_image] if args.key?(:docker_image)
184
+ @id = args[:id] if args.key?(:id)
185
+ @name = args[:name] if args.key?(:name)
186
+ @public_keys = args[:public_keys] if args.key?(:public_keys)
187
+ @size = args[:size] if args.key?(:size)
188
+ @ssh_host = args[:ssh_host] if args.key?(:ssh_host)
189
+ @ssh_port = args[:ssh_port] if args.key?(:ssh_port)
190
+ @ssh_username = args[:ssh_username] if args.key?(:ssh_username)
191
+ @state = args[:state] if args.key?(:state)
192
+ @vm_size_expire_time = args[:vm_size_expire_time] if args.key?(:vm_size_expire_time)
193
+ @web_host = args[:web_host] if args.key?(:web_host)
194
+ @web_ports = args[:web_ports] if args.key?(:web_ports)
195
+ end
196
+ end
197
+
198
+ # This resource represents a long-running operation that is the result of a
199
+ # network API call.
200
+ class Operation
201
+ include Google::Apis::Core::Hashable
202
+
203
+ # If the value is `false`, it means the operation is still in progress. If `true`
204
+ # , the operation is completed, and either `error` or `response` is available.
205
+ # Corresponds to the JSON property `done`
206
+ # @return [Boolean]
207
+ attr_accessor :done
208
+ alias_method :done?, :done
209
+
210
+ # The `Status` type defines a logical error model that is suitable for different
211
+ # programming environments, including REST APIs and RPC APIs. It is used by [
212
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
213
+ # data: error code, error message, and error details. You can find out more
214
+ # about this error model and how to work with it in the [API Design Guide](https:
215
+ # //cloud.google.com/apis/design/errors).
216
+ # Corresponds to the JSON property `error`
217
+ # @return [Google::Apis::CloudshellV1alpha1::Status]
218
+ attr_accessor :error
219
+
220
+ # Service-specific metadata associated with the operation. It typically contains
221
+ # progress information and common metadata such as create time. Some services
222
+ # might not provide such metadata. Any method that returns a long-running
223
+ # operation should document the metadata type, if any.
224
+ # Corresponds to the JSON property `metadata`
225
+ # @return [Hash<String,Object>]
226
+ attr_accessor :metadata
227
+
228
+ # The server-assigned name, which is only unique within the same service that
229
+ # originally returns it. If you use the default HTTP mapping, the `name` should
230
+ # be a resource name ending with `operations/`unique_id``.
231
+ # Corresponds to the JSON property `name`
232
+ # @return [String]
233
+ attr_accessor :name
234
+
235
+ # The normal response of the operation in case of success. If the original
236
+ # method returns no data on success, such as `Delete`, the response is `google.
237
+ # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`,
238
+ # the response should be the resource. For other methods, the response should
239
+ # have the type `XxxResponse`, where `Xxx` is the original method name. For
240
+ # example, if the original method name is `TakeSnapshot()`, the inferred
241
+ # response type is `TakeSnapshotResponse`.
242
+ # Corresponds to the JSON property `response`
243
+ # @return [Hash<String,Object>]
244
+ attr_accessor :response
245
+
246
+ def initialize(**args)
247
+ update!(**args)
248
+ end
249
+
250
+ # Update properties of this object
251
+ def update!(**args)
252
+ @done = args[:done] if args.key?(:done)
253
+ @error = args[:error] if args.key?(:error)
254
+ @metadata = args[:metadata] if args.key?(:metadata)
255
+ @name = args[:name] if args.key?(:name)
256
+ @response = args[:response] if args.key?(:response)
257
+ end
258
+ end
259
+
260
+ # A public SSH key, corresponding to a private SSH key held by the client.
261
+ class PublicKey
262
+ include Google::Apis::Core::Hashable
263
+
264
+ # Required. Format of this key's content.
265
+ # Corresponds to the JSON property `format`
266
+ # @return [String]
267
+ attr_accessor :format
268
+
269
+ # Required. Content of this key.
270
+ # Corresponds to the JSON property `key`
271
+ # NOTE: Values are automatically base64 encoded/decoded in the client library.
272
+ # @return [String]
273
+ attr_accessor :key
274
+
275
+ # Output only. Full name of this resource, in the format `users/`owner_email`/
276
+ # environments/`environment_id`/publicKeys/`key_id``. ``owner_email`` is the
277
+ # email address of the user to whom the key belongs. ``environment_id`` is the
278
+ # identifier of the environment to which the key grants access. ``key_id`` is
279
+ # the unique identifier of the key. For example, `users/someone@example.com/
280
+ # environments/default/publicKeys/myKey`.
281
+ # Corresponds to the JSON property `name`
282
+ # @return [String]
283
+ attr_accessor :name
284
+
285
+ def initialize(**args)
286
+ update!(**args)
287
+ end
288
+
289
+ # Update properties of this object
290
+ def update!(**args)
291
+ @format = args[:format] if args.key?(:format)
292
+ @key = args[:key] if args.key?(:key)
293
+ @name = args[:name] if args.key?(:name)
294
+ end
295
+ end
296
+
297
+ # Message included in the metadata field of operations returned from
298
+ # StartEnvironment.
299
+ class StartEnvironmentMetadata
300
+ include Google::Apis::Core::Hashable
301
+
302
+ # Current state of the environment being started.
303
+ # Corresponds to the JSON property `state`
304
+ # @return [String]
305
+ attr_accessor :state
306
+
307
+ def initialize(**args)
308
+ update!(**args)
309
+ end
310
+
311
+ # Update properties of this object
312
+ def update!(**args)
313
+ @state = args[:state] if args.key?(:state)
314
+ end
315
+ end
316
+
317
+ # Request message for StartEnvironment.
318
+ class StartEnvironmentRequest
319
+ include Google::Apis::Core::Hashable
320
+
321
+ # The initial access token passed to the environment. If this is present and
322
+ # valid, the environment will be pre-authenticated with gcloud so that the user
323
+ # can run gcloud commands in Cloud Shell without having to log in. This code can
324
+ # be updated later by calling AuthorizeEnvironment.
325
+ # Corresponds to the JSON property `accessToken`
326
+ # @return [String]
327
+ attr_accessor :access_token
328
+
329
+ # Public keys that should be added to the environment before it is started.
330
+ # Corresponds to the JSON property `publicKeys`
331
+ # @return [Array<Google::Apis::CloudshellV1alpha1::PublicKey>]
332
+ attr_accessor :public_keys
333
+
334
+ def initialize(**args)
335
+ update!(**args)
336
+ end
337
+
338
+ # Update properties of this object
339
+ def update!(**args)
340
+ @access_token = args[:access_token] if args.key?(:access_token)
341
+ @public_keys = args[:public_keys] if args.key?(:public_keys)
342
+ end
343
+ end
344
+
345
+ # Message included in the response field of operations returned from
346
+ # StartEnvironment once the operation is complete.
347
+ class StartEnvironmentResponse
348
+ include Google::Apis::Core::Hashable
349
+
350
+ # A Cloud Shell environment, which is defined as the combination of a Docker
351
+ # image specifying what is installed on the environment and a home directory
352
+ # containing the user's data that will remain across sessions. Each user has a
353
+ # single environment with the ID "default".
354
+ # Corresponds to the JSON property `environment`
355
+ # @return [Google::Apis::CloudshellV1alpha1::Environment]
356
+ attr_accessor :environment
357
+
358
+ def initialize(**args)
359
+ update!(**args)
360
+ end
361
+
362
+ # Update properties of this object
363
+ def update!(**args)
364
+ @environment = args[:environment] if args.key?(:environment)
365
+ end
366
+ end
367
+
368
+ # The `Status` type defines a logical error model that is suitable for different
369
+ # programming environments, including REST APIs and RPC APIs. It is used by [
370
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
371
+ # data: error code, error message, and error details. You can find out more
372
+ # about this error model and how to work with it in the [API Design Guide](https:
373
+ # //cloud.google.com/apis/design/errors).
374
+ class Status
375
+ include Google::Apis::Core::Hashable
376
+
377
+ # The status code, which should be an enum value of google.rpc.Code.
378
+ # Corresponds to the JSON property `code`
379
+ # @return [Fixnum]
380
+ attr_accessor :code
381
+
382
+ # A list of messages that carry the error details. There is a common set of
383
+ # message types for APIs to use.
384
+ # Corresponds to the JSON property `details`
385
+ # @return [Array<Hash<String,Object>>]
386
+ attr_accessor :details
387
+
388
+ # A developer-facing error message, which should be in English. Any user-facing
389
+ # error message should be localized and sent in the google.rpc.Status.details
390
+ # field, or localized by the client.
391
+ # Corresponds to the JSON property `message`
392
+ # @return [String]
393
+ attr_accessor :message
394
+
395
+ def initialize(**args)
396
+ update!(**args)
397
+ end
398
+
399
+ # Update properties of this object
400
+ def update!(**args)
401
+ @code = args[:code] if args.key?(:code)
402
+ @details = args[:details] if args.key?(:details)
403
+ @message = args[:message] if args.key?(:message)
404
+ end
405
+ end
406
+ end
407
+ end
408
+ end