Class: Google::Apis::CloudshellV1alpha1::CloudShellService

Inherits:
Google::Apis::Core::BaseService
  • Object
show all
Defined in:
generated/google/apis/cloudshell_v1alpha1/service.rb

Overview

Cloud Shell API

Allows users to start, configure, and connect to interactive shell sessions running in the cloud.

Examples:

require 'google/apis/cloudshell_v1alpha1'

Cloudshell = Google::Apis::CloudshellV1alpha1 # Alias the module
service = Cloudshell::CloudShellService.new

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ CloudShellService

Returns a new instance of CloudShellService.



46
47
48
49
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 46

def initialize
  super('https://cloudshell.googleapis.com/', '')
  @batch_path = 'batch'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

  • (String) —

    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.



39
40
41
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 39

def key
  @key
end

#quota_user ⇒ String

Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Returns:

  • (String) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.



44
45
46
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 44

def quota_user
  @quota_user
end

Instance Method Details

#authorize_environment(name, authorize_environment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::Empty

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.

Parameters:

  • name (String) —

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

  • authorize_environment_request_object (Google::Apis::CloudshellV1alpha1::AuthorizeEnvironmentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



75
76
77
78
79
80
81
82
83
84
85
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 75

def authorize_environment(name, authorize_environment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+name}:authorize', options)
  command.request_representation = Google::Apis::CloudshellV1alpha1::AuthorizeEnvironmentRequest::Representation
  command.request_object = authorize_environment_request_object
  command.response_representation = Google::Apis::CloudshellV1alpha1::Empty::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#create_public_key(parent, create_public_key_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::PublicKey

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 format and content already exists, this will return the existing key.

Parameters:

  • parent (String) —

    Parent resource name, e.g. users/me/environments/default.

  • create_public_key_request_object (Google::Apis::CloudshellV1alpha1::CreatePublicKeyRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



218
219
220
221
222
223
224
225
226
227
228
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 218

def create_public_key(parent, create_public_key_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+parent}/publicKeys', options)
  command.request_representation = Google::Apis::CloudshellV1alpha1::CreatePublicKeyRequest::Representation
  command.request_object = create_public_key_request_object
  command.response_representation = Google::Apis::CloudshellV1alpha1::PublicKey::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::PublicKey
  command.params['parent'] = parent unless parent.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#delete_user_environment_public_key(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::Empty

Removes a public SSH key from an environment. Clients will no longer be able to connect to the environment using the corresponding private key.

Parameters:

  • name (String) —

    Name of the resource to be deleted, e.g. users/me/environments/default/ publicKeys/my-key.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



252
253
254
255
256
257
258
259
260
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 252

def delete_user_environment_public_key(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:delete, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::CloudshellV1alpha1::Empty::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::Empty
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#get_user_environment(name, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::Environment

Gets an environment. Returns NOT_FOUND if the environment does not exist.

Parameters:

  • name (String) —

    Name of the requested resource, for example users/me/environments/default or users/someone@example.com/environments/default.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



108
109
110
111
112
113
114
115
116
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 108

def get_user_environment(name, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:get, 'v1alpha1/{+name}', options)
  command.response_representation = Google::Apis::CloudshellV1alpha1::Environment::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::Environment
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#patch_user_environment(name, environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::Environment

Updates an existing environment.

Parameters:

  • name (String) —

    Name of the resource to be updated, for example users/me/environments/default or users/someone@example.com/environments/default.

  • environment_object (Google::Apis::CloudshellV1alpha1::Environment) (defaults to: nil)
  • update_mask (String) (defaults to: nil) —

    Mask specifying which fields in the environment should be updated.

  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 142

def patch_user_environment(name, environment_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:patch, 'v1alpha1/{+name}', options)
  command.request_representation = Google::Apis::CloudshellV1alpha1::Environment::Representation
  command.request_object = environment_object
  command.response_representation = Google::Apis::CloudshellV1alpha1::Environment::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::Environment
  command.params['name'] = name unless name.nil?
  command.query['updateMask'] = update_mask unless update_mask.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end

#start_environment(name, start_environment_request_object = nil, fields: nil, quota_user: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::CloudshellV1alpha1::Operation

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.

Parameters:

  • name (String) —

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

  • start_environment_request_object (Google::Apis::CloudshellV1alpha1::StartEnvironmentRequest) (defaults to: nil)
  • fields (String) (defaults to: nil) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) (defaults to: nil) —

    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

  • options (Google::Apis::RequestOptions) (defaults to: nil) —

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:

  • (Google::Apis::ServerError) —

    An error occurred on the server and the request can be retried

  • (Google::Apis::ClientError) —

    The request is invalid and should not be retried without modification

  • (Google::Apis::AuthorizationError) —

    Authorization is required



182
183
184
185
186
187
188
189
190
191
192
 
# File 'generated/google/apis/cloudshell_v1alpha1/service.rb', line 182

def start_environment(name, start_environment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
  command = make_simple_command(:post, 'v1alpha1/{+name}:start', options)
  command.request_representation = Google::Apis::CloudshellV1alpha1::StartEnvironmentRequest::Representation
  command.request_object = start_environment_request_object
  command.response_representation = Google::Apis::CloudshellV1alpha1::Operation::Representation
  command.response_class = Google::Apis::CloudshellV1alpha1::Operation
  command.params['name'] = name unless name.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  execute_or_queue_command(command, &block)
end