1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudshell_v1alpha1.html">Cloud Shell API</a> . <a href="cloudshell_v1alpha1.users.html">users</a> . <a href="cloudshell_v1alpha1.users.environments.html">environments</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="cloudshell_v1alpha1.users.environments.publicKeys.html">publicKeys()</a></code> 79</p> 80<p class="firstline">Returns the publicKeys Resource.</p> 81 82<p class="toc_element"> 83 <code><a href="#authorize">authorize(name, body, x__xgafv=None)</a></code></p> 84<p class="firstline">Sends OAuth credentials to a running environment on behalf of a user. When</p> 85<p class="toc_element"> 86 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 87<p class="firstline">Gets an environment. Returns NOT_FOUND if the environment does not exist.</p> 88<p class="toc_element"> 89 <code><a href="#patch">patch(name, body, updateMask=None, x__xgafv=None)</a></code></p> 90<p class="firstline">Updates an existing environment.</p> 91<p class="toc_element"> 92 <code><a href="#start">start(name, body, x__xgafv=None)</a></code></p> 93<p class="firstline">Starts an existing environment, allowing clients to connect to it. The</p> 94<h3>Method Details</h3> 95<div class="method"> 96 <code class="details" id="authorize">authorize(name, body, x__xgafv=None)</code> 97 <pre>Sends OAuth credentials to a running environment on behalf of a user. When 98this completes, the environment will be authorized to run various Google 99Cloud command line tools without requiring the user to manually 100authenticate. 101 102Args: 103 name: string, Name of the resource that should receive the credentials, for example 104`users/me/environments/default` or 105`users/someone@example.com/environments/default`. (required) 106 body: object, The request body. (required) 107 The object takes the form of: 108 109{ # Request message for AuthorizeEnvironment. 110 "expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from 111 # when the server received the request. 112 "idToken": "A String", # The OAuth ID token that should be sent to the environment. 113 "accessToken": "A String", # The OAuth access token that should be sent to the environment. 114 } 115 116 x__xgafv: string, V1 error format. 117 Allowed values 118 1 - v1 error format 119 2 - v2 error format 120 121Returns: 122 An object of the form: 123 124 { # A generic empty message that you can re-use to avoid defining duplicated 125 # empty messages in your APIs. A typical example is to use it as the request 126 # or the response type of an API method. For instance: 127 # 128 # service Foo { 129 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 130 # } 131 # 132 # The JSON representation for `Empty` is empty JSON object `{}`. 133 }</pre> 134</div> 135 136<div class="method"> 137 <code class="details" id="get">get(name, x__xgafv=None)</code> 138 <pre>Gets an environment. Returns NOT_FOUND if the environment does not exist. 139 140Args: 141 name: string, Name of the requested resource, for example `users/me/environments/default` 142or `users/someone@example.com/environments/default`. (required) 143 x__xgafv: string, V1 error format. 144 Allowed values 145 1 - v1 error format 146 2 - v2 error format 147 148Returns: 149 An object of the form: 150 151 { # A Cloud Shell environment, which is defined as the combination of a Docker 152 # image specifying what is installed on the environment and a home directory 153 # containing the user's data that will remain across sessions. Each user has a 154 # single environment with the ID "default". 155 "name": "A String", # Output only. Full name of this resource, in the format 156 # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the 157 # email address of the user to whom this environment belongs, and 158 # `{environment_id}` is the identifier of this environment. For example, 159 # `users/someone@example.com/environments/default`. 160 "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. 161 # "gcr.io/dev-con/cloud-devshell:latest". 162 "publicKeys": [ # Output only. Public keys associated with the environment. Clients can 163 # connect to this environment via SSH only if they possess a private key 164 # corresponding to at least one of these public keys. Keys can be added to or 165 # removed from the environment using the CreatePublicKey and DeletePublicKey 166 # methods. 167 { # A public SSH key, corresponding to a private SSH key held by the client. 168 "name": "A String", # Output only. Full name of this resource, in the format 169 # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. 170 # `{owner_email}` is the email address of the user to whom the key belongs. 171 # `{environment_id}` is the identifier of the environment to which the key 172 # grants access. `{key_id}` is the unique identifier of the key. For example, 173 # `users/someone@example.com/environments/default/publicKeys/myKey`. 174 "key": "A String", # Required. Content of this key. 175 "format": "A String", # Required. Format of this key's content. 176 }, 177 ], 178 "state": "A String", # Output only. Current execution state of this environment. 179 "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions 180 # with the environment. 181 "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions 182 # with the environment. 183 "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions 184 # with the environment. 185 "id": "A String", # Output only. The environment's identifier, which is always "default". 186 }</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="patch">patch(name, body, updateMask=None, x__xgafv=None)</code> 191 <pre>Updates an existing environment. 192 193Args: 194 name: string, Name of the resource to be updated, for example 195`users/me/environments/default` or 196`users/someone@example.com/environments/default`. (required) 197 body: object, The request body. (required) 198 The object takes the form of: 199 200{ # A Cloud Shell environment, which is defined as the combination of a Docker 201 # image specifying what is installed on the environment and a home directory 202 # containing the user's data that will remain across sessions. Each user has a 203 # single environment with the ID "default". 204 "name": "A String", # Output only. Full name of this resource, in the format 205 # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the 206 # email address of the user to whom this environment belongs, and 207 # `{environment_id}` is the identifier of this environment. For example, 208 # `users/someone@example.com/environments/default`. 209 "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. 210 # "gcr.io/dev-con/cloud-devshell:latest". 211 "publicKeys": [ # Output only. Public keys associated with the environment. Clients can 212 # connect to this environment via SSH only if they possess a private key 213 # corresponding to at least one of these public keys. Keys can be added to or 214 # removed from the environment using the CreatePublicKey and DeletePublicKey 215 # methods. 216 { # A public SSH key, corresponding to a private SSH key held by the client. 217 "name": "A String", # Output only. Full name of this resource, in the format 218 # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. 219 # `{owner_email}` is the email address of the user to whom the key belongs. 220 # `{environment_id}` is the identifier of the environment to which the key 221 # grants access. `{key_id}` is the unique identifier of the key. For example, 222 # `users/someone@example.com/environments/default/publicKeys/myKey`. 223 "key": "A String", # Required. Content of this key. 224 "format": "A String", # Required. Format of this key's content. 225 }, 226 ], 227 "state": "A String", # Output only. Current execution state of this environment. 228 "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions 229 # with the environment. 230 "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions 231 # with the environment. 232 "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions 233 # with the environment. 234 "id": "A String", # Output only. The environment's identifier, which is always "default". 235 } 236 237 updateMask: string, Mask specifying which fields in the environment should be updated. 238 x__xgafv: string, V1 error format. 239 Allowed values 240 1 - v1 error format 241 2 - v2 error format 242 243Returns: 244 An object of the form: 245 246 { # A Cloud Shell environment, which is defined as the combination of a Docker 247 # image specifying what is installed on the environment and a home directory 248 # containing the user's data that will remain across sessions. Each user has a 249 # single environment with the ID "default". 250 "name": "A String", # Output only. Full name of this resource, in the format 251 # `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the 252 # email address of the user to whom this environment belongs, and 253 # `{environment_id}` is the identifier of this environment. For example, 254 # `users/someone@example.com/environments/default`. 255 "dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g. 256 # "gcr.io/dev-con/cloud-devshell:latest". 257 "publicKeys": [ # Output only. Public keys associated with the environment. Clients can 258 # connect to this environment via SSH only if they possess a private key 259 # corresponding to at least one of these public keys. Keys can be added to or 260 # removed from the environment using the CreatePublicKey and DeletePublicKey 261 # methods. 262 { # A public SSH key, corresponding to a private SSH key held by the client. 263 "name": "A String", # Output only. Full name of this resource, in the format 264 # `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`. 265 # `{owner_email}` is the email address of the user to whom the key belongs. 266 # `{environment_id}` is the identifier of the environment to which the key 267 # grants access. `{key_id}` is the unique identifier of the key. For example, 268 # `users/someone@example.com/environments/default/publicKeys/myKey`. 269 "key": "A String", # Required. Content of this key. 270 "format": "A String", # Required. Format of this key's content. 271 }, 272 ], 273 "state": "A String", # Output only. Current execution state of this environment. 274 "sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions 275 # with the environment. 276 "sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions 277 # with the environment. 278 "sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions 279 # with the environment. 280 "id": "A String", # Output only. The environment's identifier, which is always "default". 281 }</pre> 282</div> 283 284<div class="method"> 285 <code class="details" id="start">start(name, body, x__xgafv=None)</code> 286 <pre>Starts an existing environment, allowing clients to connect to it. The 287returned operation will contain an instance of StartEnvironmentMetadata in 288its metadata field. Users can wait for the environment to start by polling 289this operation via GetOperation. Once the environment has finished starting 290and is ready to accept connections, the operation will contain a 291StartEnvironmentResponse in its response field. 292 293Args: 294 name: string, Name of the resource that should be started, for example 295`users/me/environments/default` or 296`users/someone@example.com/environments/default`. (required) 297 body: object, The request body. (required) 298 The object takes the form of: 299 300{ # Request message for StartEnvironment. 301 "accessToken": "A String", # The initial access token passed to the environment. If this is present and 302 # valid, the environment will be pre-authenticated with gcloud so that the 303 # user can run gcloud commands in Cloud Shell without having to log in. This 304 # code can be updated later by calling AuthorizeEnvironment. 305 } 306 307 x__xgafv: string, V1 error format. 308 Allowed values 309 1 - v1 error format 310 2 - v2 error format 311 312Returns: 313 An object of the form: 314 315 { # This resource represents a long-running operation that is the result of a 316 # network API call. 317 "response": { # The normal response of the operation in case of success. If the original 318 # method returns no data on success, such as `Delete`, the response is 319 # `google.protobuf.Empty`. If the original method is standard 320 # `Get`/`Create`/`Update`, the response should be the resource. For other 321 # methods, the response should have the type `XxxResponse`, where `Xxx` 322 # is the original method name. For example, if the original method name 323 # is `TakeSnapshot()`, the inferred response type is 324 # `TakeSnapshotResponse`. 325 "a_key": "", # Properties of the object. Contains field @type with type URL. 326 }, 327 "metadata": { # Service-specific metadata associated with the operation. It typically 328 # contains progress information and common metadata such as create time. 329 # Some services might not provide such metadata. Any method that returns a 330 # long-running operation should document the metadata type, if any. 331 "a_key": "", # Properties of the object. Contains field @type with type URL. 332 }, 333 "done": True or False, # If the value is `false`, it means the operation is still in progress. 334 # If `true`, the operation is completed, and either `error` or `response` is 335 # available. 336 "name": "A String", # The server-assigned name, which is only unique within the same service that 337 # originally returns it. If you use the default HTTP mapping, the 338 # `name` should be a resource name ending with `operations/{unique_id}`. 339 "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. 340 # different programming environments, including REST APIs and RPC APIs. It is 341 # used by [gRPC](https://github.com/grpc). Each `Status` message contains 342 # three pieces of data: error code, error message, and error details. 343 # 344 # You can find out more about this error model and how to work with it in the 345 # [API Design Guide](https://cloud.google.com/apis/design/errors). 346 "message": "A String", # A developer-facing error message, which should be in English. Any 347 # user-facing error message should be localized and sent in the 348 # google.rpc.Status.details field, or localized by the client. 349 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 350 "details": [ # A list of messages that carry the error details. There is a common set of 351 # message types for APIs to use. 352 { 353 "a_key": "", # Properties of the object. Contains field @type with type URL. 354 }, 355 ], 356 }, 357 }</pre> 358</div> 359 360</body></html>