Google Cloud Shell V1 Client - Class StartEnvironmentRequest (1.0.4)

Reference documentation and code samples for the Google Cloud Shell V1 Client class StartEnvironmentRequest.

Request message for StartEnvironment.

Generated from protobuf message google.cloud.shell.v1.StartEnvironmentRequest

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ name string

Name of the resource that should be started, for example users/me/environments/default or users/someone@example.com/environments/default.

↳ access_token string

The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment.

↳ public_keys array

Public keys that should be added to the environment before it is started.

getName

Name of the resource that should be started, for example users/me/environments/default or users/someone@example.com/environments/default.

Returns
TypeDescription
string

setName

Name of the resource that should be started, for example users/me/environments/default or users/someone@example.com/environments/default.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAccessToken

The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment.

Returns
TypeDescription
string

setAccessToken

The initial access token passed to the environment. If this is present and valid, the environment will be pre-authenticated with gcloud so that the user can run gcloud commands in Cloud Shell without having to log in. This code can be updated later by calling AuthorizeEnvironment.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPublicKeys

Public keys that should be added to the environment before it is started.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setPublicKeys

Public keys that should be added to the environment before it is started.

Parameter
NameDescription
var string[]
Returns
TypeDescription
$this