Cloud Shell API - Module Google::Cloud::Shell (v1.1.0)

Reference documentation and code samples for the Cloud Shell API module Google::Cloud::Shell.

Methods

.cloud_shell_service

def self.cloud_shell_service(version: :v1, &block) -> CloudShellService::Client

Create a new client object for CloudShellService.

By default, this returns an instance of Google::Cloud::Shell::V1::CloudShellService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the CloudShellService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About CloudShellService

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.

Parameter
  • version (::String, ::Symbol) (defaults to: :v1) — The API version to connect to. Optional. Defaults to :v1.
Returns
  • (CloudShellService::Client) — A client object for the specified version.

.configure

def self.configure() -> ::Google::Cloud::Config

Configure the google-cloud-shell library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.
Yields
  • (::Google::Cloud.configure.shell)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

Constants

VERSION

value: "1.1.0"