Generated from protobuf messagegoogle.cloud.shell.v1.StartEnvironmentRequest
Namespace
Google \ Cloud \ Shell \ V1
Methods
__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 exampleusers/me/environments/defaultorusers/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 exampleusers/me/environments/defaultorusers/someone@example.com/environments/default.
Returns
Type
Description
string
setName
Name of the resource that should be started, for exampleusers/me/environments/defaultorusers/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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Shell V1 Client - Class StartEnvironmentRequest (2.0.5)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.5 (latest)](/php/docs/reference/cloud-shell/latest/V1.StartEnvironmentRequest)\n- [2.0.4](/php/docs/reference/cloud-shell/2.0.4/V1.StartEnvironmentRequest)\n- [1.3.5](/php/docs/reference/cloud-shell/1.3.5/V1.StartEnvironmentRequest)\n- [1.2.2](/php/docs/reference/cloud-shell/1.2.2/V1.StartEnvironmentRequest)\n- [1.1.1](/php/docs/reference/cloud-shell/1.1.1/V1.StartEnvironmentRequest)\n- [1.0.4](/php/docs/reference/cloud-shell/1.0.4/V1.StartEnvironmentRequest) \nReference documentation and code samples for the Google Cloud Shell V1 Client class StartEnvironmentRequest.\n\nRequest message for\n[StartEnvironment](/php/docs/reference/cloud-shell/latest/V1.Client.CloudShellServiceClient#_Google_Cloud_Shell_V1_Client_CloudShellServiceClient__startEnvironment__).\n\nGenerated from protobuf message `google.cloud.shell.v1.StartEnvironmentRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Shell \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nName of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.\n\n### setName\n\nName of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.\n\n### getAccessToken\n\nThe initial access token passed to the environment. If this is present and\nvalid, the environment will be pre-authenticated with gcloud so that the\nuser can run gcloud commands in Cloud Shell without having to log in. This\ncode can be updated later by calling AuthorizeEnvironment.\n\n### setAccessToken\n\nThe initial access token passed to the environment. If this is present and\nvalid, the environment will be pre-authenticated with gcloud so that the\nuser can run gcloud commands in Cloud Shell without having to log in. This\ncode can be updated later by calling AuthorizeEnvironment.\n\n### getPublicKeys\n\nPublic keys that should be added to the environment before it is started.\n\n### setPublicKeys\n\nPublic keys that should be added to the environment before it is started."]]
