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
Namespace
Google \ Cloud \ Shell \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Name of the resource that should be started, for example |
↳ 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 | |
|---|---|
| Type | Description |
string |
|
setName
Name of the resource that should be started, for example
users/me/environments/default or
users/someone@example.com/environments/default.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPublicKeys
Public keys that should be added to the environment before it is started.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPublicKeys
Public keys that should be added to the environment before it is started.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|