Blame - docs/dyn/cloudshell_v1alpha1.users.environments.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

83

<code><a href="#authorize">authorize(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<p class="firstline">Sends OAuth credentials to a running environment on behalf of a user. When</p>

85

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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

89

<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

90

<p class="firstline">Updates an existing environment.</p>

91

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

92

<code><a href="#start">start(name, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

93

<p class="firstline">Starts an existing environment, allowing clients to connect to it. The</p>

94

<h3>Method Details</h3>

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

<code class="details" id="authorize">authorize(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

97

<pre>Sends OAuth credentials to a running environment on behalf of a user. When

98

this completes, the environment will be authorized to run various Google

99

Cloud command line tools without requiring the user to manually

authenticate.

Args:

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)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

106

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

107

The object takes the form of:

108

109

{ # Request message for AuthorizeEnvironment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

110

"expireTime": "A String", # The time when the credentials expire. If not set, defaults to one hour from

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

111

# when the server received the request.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

112

"accessToken": "A String", # The OAuth access token that should be sent to the environment.

113

"idToken": "A String", # The OAuth ID token that should be sent to the environment.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

}

115

116

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<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

140

Args:

141

name: string, Name of the requested resource, for example `users/me/environments/default`

142

or `users/someone@example.com/environments/default`. (required)

143

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

150

151

{ # A Cloud Shell environment, which is defined as the combination of a Docker

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

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

"state": "A String", # Output only. Current execution state of this environment.

156

"name": "A String", # Output only. Full name of this resource, in the format

157

# `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the

158

# email address of the user to whom this environment belongs, and

159

# `{environment_id}` is the identifier of this environment. For example,

160

# `users/someone@example.com/environments/default`.

161

"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default

162

# VM size.

163

"id": "A String", # Output only. The environment's identifier, unique among the user's

164

# environments.

165

"size": "A String", # Indicates the size of the backing VM running the environment. If set to

166

# something other than DEFAULT, it will be reverted to the default VM size

167

# after vm_size_expire_time.

168

"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS

169

# connections with the environment.

170

"publicKeys": [ # Output only. Public keys associated with the environment. Clients can

171

# connect to this environment via SSH only if they possess a private key

172

# corresponding to at least one of these public keys. Keys can be added to or

173

# removed from the environment using the CreatePublicKey and DeletePublicKey

174

# methods.

175

{ # A public SSH key, corresponding to a private SSH key held by the client.

176

"name": "A String", # Output only. Full name of this resource, in the format

177

# `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.

178

# `{owner_email}` is the email address of the user to whom the key belongs.

179

# `{environment_id}` is the identifier of the environment to which the key

180

# grants access. `{key_id}` is the unique identifier of the key. For example,

181

# `users/someone@example.com/environments/default/publicKeys/myKey`.

182

"key": "A String", # Required. Content of this key.

183

"format": "A String", # Required. Format of this key's content.

184

},

185

],

186

"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.

187

# "gcr.io/dev-con/cloud-devshell:latest".

188

"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS

189

# connections with the environment.

190

42,

191

],

192

"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions

193

# with the environment.

194

"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions

195

# with the environment.

196

"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions

197

# with the environment.

198

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

202

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

203

<pre>Updates an existing environment.

204

205

Args:

206

name: string, Name of the resource to be updated, for example

207

`users/me/environments/default` or

208

`users/someone@example.com/environments/default`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

209

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

210

The object takes the form of:

211

212

{ # A Cloud Shell environment, which is defined as the combination of a Docker

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

213

# image specifying what is installed on the environment and a home directory

214

# containing the user's data that will remain across sessions. Each user has a

215

# single environment with the ID "default".

216

"state": "A String", # Output only. Current execution state of this environment.

217

"name": "A String", # Output only. Full name of this resource, in the format

218

# `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the

219

# email address of the user to whom this environment belongs, and

220

# `{environment_id}` is the identifier of this environment. For example,

221

# `users/someone@example.com/environments/default`.

222

"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default

223

# VM size.

224

"id": "A String", # Output only. The environment's identifier, unique among the user's

225

# environments.

226

"size": "A String", # Indicates the size of the backing VM running the environment. If set to

227

# something other than DEFAULT, it will be reverted to the default VM size

228

# after vm_size_expire_time.

229

"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS

230

# connections with the environment.

231

"publicKeys": [ # Output only. Public keys associated with the environment. Clients can

232

# connect to this environment via SSH only if they possess a private key

233

# corresponding to at least one of these public keys. Keys can be added to or

234

# removed from the environment using the CreatePublicKey and DeletePublicKey

235

# methods.

236

{ # A public SSH key, corresponding to a private SSH key held by the client.

237

"name": "A String", # Output only. Full name of this resource, in the format

238

# `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.

239

# `{owner_email}` is the email address of the user to whom the key belongs.

240

# `{environment_id}` is the identifier of the environment to which the key

241

# grants access. `{key_id}` is the unique identifier of the key. For example,

242

# `users/someone@example.com/environments/default/publicKeys/myKey`.

243

"key": "A String", # Required. Content of this key.

244

"format": "A String", # Required. Format of this key's content.

245

},

246

],

247

"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.

248

# "gcr.io/dev-con/cloud-devshell:latest".

249

"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS

250

# connections with the environment.

251

42,

252

],

253

"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions

254

# with the environment.

255

"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions

256

# with the environment.

257

"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions

258

# with the environment.

259

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

260

261

updateMask: string, Mask specifying which fields in the environment should be updated.

262

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

269

270

{ # A Cloud Shell environment, which is defined as the combination of a Docker

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

271

# image specifying what is installed on the environment and a home directory

272

# containing the user's data that will remain across sessions. Each user has a

273

# single environment with the ID "default".

274

"state": "A String", # Output only. Current execution state of this environment.

275

"name": "A String", # Output only. Full name of this resource, in the format

276

# `users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the

277

# email address of the user to whom this environment belongs, and

278

# `{environment_id}` is the identifier of this environment. For example,

279

# `users/someone@example.com/environments/default`.

280

"vmSizeExpireTime": "A String", # Output only. The time when the Environment will expire back to the default

281

# VM size.

282

"id": "A String", # Output only. The environment's identifier, unique among the user's

283

# environments.

284

"size": "A String", # Indicates the size of the backing VM running the environment. If set to

285

# something other than DEFAULT, it will be reverted to the default VM size

286

# after vm_size_expire_time.

287

"webHost": "A String", # Output only. Host to which clients can connect to initiate HTTPS or WSS

288

# connections with the environment.

289

"publicKeys": [ # Output only. Public keys associated with the environment. Clients can

290

# connect to this environment via SSH only if they possess a private key

291

# corresponding to at least one of these public keys. Keys can be added to or

292

# removed from the environment using the CreatePublicKey and DeletePublicKey

293

# methods.

294

{ # A public SSH key, corresponding to a private SSH key held by the client.

295

"name": "A String", # Output only. Full name of this resource, in the format

296

# `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.

297

# `{owner_email}` is the email address of the user to whom the key belongs.

298

# `{environment_id}` is the identifier of the environment to which the key

299

# grants access. `{key_id}` is the unique identifier of the key. For example,

300

# `users/someone@example.com/environments/default/publicKeys/myKey`.

301

"key": "A String", # Required. Content of this key.

302

"format": "A String", # Required. Format of this key's content.

303

},

304

],

305

"dockerImage": "A String", # Required. Full path to the Docker image used to run this environment, e.g.

306

# "gcr.io/dev-con/cloud-devshell:latest".

307

"webPorts": [ # Output only. Ports to which clients can connect to initiate HTTPS or WSS

308

# connections with the environment.

309

42,

310

],

311

"sshHost": "A String", # Output only. Host to which clients can connect to initiate SSH sessions

312

# with the environment.

313

"sshPort": 42, # Output only. Port to which clients can connect to initiate SSH sessions

314

# with the environment.

315

"sshUsername": "A String", # Output only. Username that clients should use when initiating SSH sessions

316

# with the environment.

317

}</pre>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

321

<code class="details" id="start">start(name, body=None, x__xgafv=None)</code>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

322

<pre>Starts an existing environment, allowing clients to connect to it. The

323

returned operation will contain an instance of StartEnvironmentMetadata in

324

its metadata field. Users can wait for the environment to start by polling

325

this operation via GetOperation. Once the environment has finished starting

326

and is ready to accept connections, the operation will contain a

327

StartEnvironmentResponse in its response field.

328

329

Args:

330

name: string, Name of the resource that should be started, for example

331

`users/me/environments/default` or

332

`users/someone@example.com/environments/default`. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

333

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

334

The object takes the form of:

335

336

{ # Request message for StartEnvironment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

337

"accessToken": "A String", # The initial access token passed to the environment. If this is present and

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

338

# valid, the environment will be pre-authenticated with gcloud so that the

339

# user can run gcloud commands in Cloud Shell without having to log in. This

340

# code can be updated later by calling AuthorizeEnvironment.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

341

"publicKeys": [ # Public keys that should be added to the environment before it is started.

342

{ # A public SSH key, corresponding to a private SSH key held by the client.

343

"name": "A String", # Output only. Full name of this resource, in the format

344

# `users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.

345

# `{owner_email}` is the email address of the user to whom the key belongs.

346

# `{environment_id}` is the identifier of the environment to which the key

347

# grants access. `{key_id}` is the unique identifier of the key. For example,

348

# `users/someone@example.com/environments/default/publicKeys/myKey`.

349

"key": "A String", # Required. Content of this key.

350

"format": "A String", # Required. Format of this key's content.

351

},

352

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

353

}

354

355

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

362

363

{ # This resource represents a long-running operation that is the result of a

364

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

365

"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.

366

# different programming environments, including REST APIs and RPC APIs. It is

367

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

368

# three pieces of data: error code, error message, and error details.

369

#

370

# You can find out more about this error model and how to work with it in the

371

# [API Design Guide](https://cloud.google.com/apis/design/errors).

372

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

373

"message": "A String", # A developer-facing error message, which should be in English. Any

374

# user-facing error message should be localized and sent in the

375

# google.rpc.Status.details field, or localized by the client.

376

"details": [ # A list of messages that carry the error details. There is a common set of

377

# message types for APIs to use.

378

{

379

"a_key": "", # Properties of the object. Contains field @type with type URL.

},

],

},

"metadata": { # Service-specific metadata associated with the operation. It typically

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

384

# contains progress information and common metadata such as create time.

385

# Some services might not provide such metadata. Any method that returns a

386

# long-running operation should document the metadata type, if any.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

387

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

388

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

389

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

390

# If `true`, the operation is completed, and either `error` or `response` is

391

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

392

"response": { # The normal response of the operation in case of success. If the original

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

393

# method returns no data on success, such as `Delete`, the response is

394

# `google.protobuf.Empty`. If the original method is standard

395

# `Get`/`Create`/`Update`, the response should be the resource. For other

396

# methods, the response should have the type `XxxResponse`, where `Xxx`

397

# is the original method name. For example, if the original method name

398

# is `TakeSnapshot()`, the inferred response type is

399

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

400

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

401

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

402

"name": "A String", # The server-assigned name, which is only unique within the same service that

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

403

# originally returns it. If you use the default HTTP mapping, the

404

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim