Reference documentation and code samples for the Google Cloud Shell V1 Client class CloudShellServiceClient.
Service Description: API for interacting with Google Cloud Shell. Each user of Cloud Shell has at least one environment, which has the ID "default". Environment consists of a Docker image defining what is installed on the environment and a home directory containing the user's data that will remain across sessions.
Clients use this API to start and fetch information about their environment, which can then be used to connect to that environment via a separate SSH client.
This class provides the ability to make remote calls to the backing service through method calls that map to API methods.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parseName method to extract the individual identifiers contained within formatted names that are returned by the API.
This class is currently experimental and may be subject to changes. See Google\Cloud\Shell\V1\CloudShellServiceClient for the stable implementation
Namespace
Google \ Cloud \ Shell \ V1 \ ClientMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
options |
array
Optional. Options for configuring the service API wrapper. |
↳ apiEndpoint |
string
The address of the API remote host. May optionally include the port, formatted as "
|
↳ credentials |
string|array|FetchAuthTokenInterface|CredentialsWrapper
The credentials to be used by the client to authorize API calls. This option accepts either a path to a credentials file, or a decoded credentials file as a PHP array. Advanced usage: In addition, this option can also accept a pre-constructed Google\Auth\FetchAuthTokenInterface object or Google\ApiCore\CredentialsWrapper object. Note that when one of these objects are provided, any settings in $credentialsConfig will be ignored. |
↳ credentialsConfig |
array
Options used to configure credentials, including auth token caching, for the client. For a full list of supporting configuration options, see Google\ApiCore\CredentialsWrapper::build() . |
↳ disableRetries |
bool
Determines whether or not retries defined by the client configuration should be disabled. Defaults to |
↳ clientConfig |
string|array
Client method configuration, including retry settings. This option can be either a path to a JSON file, or a PHP array containing the decoded JSON data. By default this settings points to the default client config file, which is provided in the resources folder. |
↳ transport |
string|TransportInterface
The transport used for executing network requests. May be either the string |
↳ transportConfig |
array
Configuration options that will be used to construct the transport. Options for each supported transport type should be passed in a key for that transport. For example: $transportConfig = [ 'grpc' => [...], 'rest' => [...], ]; See the Google\ApiCore\Transport\GrpcTransport::build() and Google\ApiCore\Transport\RestTransport::build() methods for the supported options. |
↳ clientCertSource |
callable
A callable which returns the client cert as a string. This can be used to provide a certificate and private key to the transport layer for mTLS. |
addPublicKey
Adds a public SSH key to an environment, allowing clients with the corresponding private key to connect to that environment via SSH. If a key with the same content already exists, this will error with ALREADY_EXISTS.
The async variant is Google\Cloud\Shell\V1\Client\CloudShellServiceClient::addPublicKeyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\AddPublicKeyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
authorizeEnvironment
Sends OAuth credentials to a running environment on behalf of a user. When this completes, the environment will be authorized to run various Google Cloud command line tools without requiring the user to manually authenticate.
The async variant is Google\Cloud\Shell\V1\Client\CloudShellServiceClient::authorizeEnvironmentAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\AuthorizeEnvironmentRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
getEnvironment
Gets an environment. Returns NOT_FOUND if the environment does not exist.
The async variant is Google\Cloud\Shell\V1\Client\CloudShellServiceClient::getEnvironmentAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\GetEnvironmentRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Shell\V1\Environment | |
removePublicKey
Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.
If a key with the same content is not present, this will error with NOT_FOUND.
The async variant is Google\Cloud\Shell\V1\Client\CloudShellServiceClient::removePublicKeyAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\RemovePublicKeyRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
startEnvironment
Starts an existing environment, allowing clients to connect to it. The returned operation will contain an instance of StartEnvironmentMetadata in its metadata field. Users can wait for the environment to start by polling this operation via GetOperation. Once the environment has finished starting and is ready to accept connections, the operation will contain a StartEnvironmentResponse in its response field.
The async variant is Google\Cloud\Shell\V1\Client\CloudShellServiceClient::startEnvironmentAsync() .
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\StartEnvironmentRequest
A request to house fields associated with the call. |
callOptions |
array
Optional. |
↳ retrySettings |
RetrySettings|array
Retry settings to use for this call. Can be a Google\ApiCore\RetrySettings object, or an associative array of retry settings parameters. See the documentation on Google\ApiCore\RetrySettings for example usage. |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
addPublicKeyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\AddPublicKeyRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface | |
authorizeEnvironmentAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\AuthorizeEnvironmentRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface | |
getEnvironmentAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\GetEnvironmentRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface | |
removePublicKeyAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\RemovePublicKeyRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface | |
startEnvironmentAsync
| Parameters | |
|---|---|
| Name | Description |
request |
Google\Cloud\Shell\V1\StartEnvironmentRequest
|
optionalArgs = [] |
array
|
| Returns | |
|---|---|
| Type | Description |
GuzzleHttp\Promise\PromiseInterface | |
getOperationsClient
Return an OperationsClient object with the same endpoint as $this.
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\LongRunning\OperationsClient | |
resumeOperation
Resume an existing long running operation that was previously started by a long running API method. If $methodName is not provided, or does not match a long running API method, then the operation can still be resumed, but the OperationResponse object will not deserialize the final response.
| Parameters | |
|---|---|
| Name | Description |
operationName |
string
The name of the long running operation |
methodName |
string
The name of the method used to start the operation |
| Returns | |
|---|---|
| Type | Description |
Google\ApiCore\OperationResponse | |
static::environmentName
Formats a string containing the fully-qualified path to represent a environment resource.
| Parameters | |
|---|---|
| Name | Description |
user |
string
|
environment |
string
|
| Returns | |
|---|---|
| Type | Description |
string | The formatted environment resource. |
static::parseName
Parses a formatted name string and returns an associative array of the components in the name.
The following name formats are supported: Template: Pattern
- environment: users/{user}/environments/{environment}
The optional $template argument can be supplied to specify a particular pattern, and must match one of the templates listed above. If no $template argument is provided, or if the $template argument does not match one of the templates listed, then parseName will check each of the supported templates, and return the first match.
| Parameters | |
|---|---|
| Name | Description |
formattedName |
string
The formatted name string |
template |
string
Optional name of template to match |
| Returns | |
|---|---|
| Type | Description |
array | An associative array from name component IDs to component values. |