Class: Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/os_login/v1/os_login_service/rest/client.rb

Overview

REST client for the OsLoginService service.

Cloud OS Login API

The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.

Defined Under Namespace

Classes: Configuration

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#posix_account_path, #ssh_public_key_path, #user_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new OsLoginService REST client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the OsLoginService client.

Yield Parameters:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 159

def initialize
  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint.nil? ||
                           (@config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-"))
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end

  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @os_login_service_stub = ::Google::Cloud::OsLogin::V1::OsLoginService::Rest::ServiceStub.new(
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    credentials: credentials
  )
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the OsLoginService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all OsLoginService clients
::Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 67

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "OsLogin", "V1"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config.rpcs..timeout = 10.0
    default_config.rpcs..retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.delete_ssh_public_key.timeout = 10.0
    default_config.rpcs.delete_ssh_public_key.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs..timeout = 10.0
    default_config.rpcs..retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.get_ssh_public_key.timeout = 10.0
    default_config.rpcs.get_ssh_public_key.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.import_ssh_public_key.timeout = 10.0
    default_config.rpcs.import_ssh_public_key.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config.rpcs.update_ssh_public_key.timeout = 10.0
    default_config.rpcs.update_ssh_public_key.retry_policy = {
      initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4]
    }

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#configure {|config| ... } ⇒ Client::Configuration

Configure the OsLoginService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



129
130
131
132
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 129

def configure
  yield @config if block_given?
  @config
end

#create_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey #create_ssh_public_key(parent: nil, ssh_public_key: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

Create an SSH public key

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest.new

# Call the create_ssh_public_key method.
result = client.create_ssh_public_key request

# The returned object is of type Google::Cloud::OsLogin::Common::SshPublicKey.
p result

Overloads:

  • #create_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to create_ssh_public_key via a request object, either of type CreateSshPublicKeyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #create_ssh_public_key(parent: nil, ssh_public_key: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to create_ssh_public_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The unique ID for the user in format users/{user}.

    • ssh_public_key (::Google::Cloud::OsLogin::Common::SshPublicKey, ::Hash) (defaults to: nil) —

      Required. The SSH public key and expiration time.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 237

def create_ssh_public_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::CreateSshPublicKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.create_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.create_ssh_public_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.create_ssh_public_key.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub.create_ssh_public_key request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_posix_account(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_posix_account(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes a POSIX account.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::DeletePosixAccountRequest.new

# Call the delete_posix_account method.
result = client. request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_posix_account(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_posix_account via a request object, either of type DeletePosixAccountRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::DeletePosixAccountRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_posix_account(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_posix_account via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. A reference to the POSIX account to update. POSIX accounts are identified by the project ID they are associated with. A reference to the POSIX account is in format users/{user}/projects/{project}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 318

def  request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::DeletePosixAccountRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs..retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub. request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#delete_ssh_public_key(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_ssh_public_key(name: nil) ⇒ ::Google::Protobuf::Empty

Deletes an SSH public key.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::DeleteSshPublicKeyRequest.new

# Call the delete_ssh_public_key method.
result = client.delete_ssh_public_key request

# The returned object is of type Google::Protobuf::Empty.
p result

Overloads:

  • #delete_ssh_public_key(request, options = nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_ssh_public_key via a request object, either of type DeleteSshPublicKeyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::DeleteSshPublicKeyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #delete_ssh_public_key(name: nil) ⇒ ::Google::Protobuf::Empty

    Pass arguments to delete_ssh_public_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 399

def delete_ssh_public_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::DeleteSshPublicKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.delete_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.delete_ssh_public_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.delete_ssh_public_key.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub.delete_ssh_public_key request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_login_profile(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile #get_login_profile(name: nil, project_id: nil, system_id: nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile

Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::GetLoginProfileRequest.new

# Call the get_login_profile method.
result = client. request

# The returned object is of type Google::Cloud::OsLogin::V1::LoginProfile.
p result

Overloads:

  • #get_login_profile(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile

    Pass arguments to get_login_profile via a request object, either of type GetLoginProfileRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::GetLoginProfileRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_login_profile(name: nil, project_id: nil, system_id: nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile

    Pass arguments to get_login_profile via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The unique ID for the user in format users/{user}.

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

      The project ID of the Google Cloud Platform project.

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

      A system ID for filtering the results of the request.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 483

def  request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::GetLoginProfileRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs..retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub. request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey #get_ssh_public_key(name: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

Retrieves an SSH public key.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::GetSshPublicKeyRequest.new

# Call the get_ssh_public_key method.
result = client.get_ssh_public_key request

# The returned object is of type Google::Cloud::OsLogin::Common::SshPublicKey.
p result

Overloads:

  • #get_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to get_ssh_public_key via a request object, either of type GetSshPublicKeyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::GetSshPublicKeyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #get_ssh_public_key(name: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to get_ssh_public_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The fingerprint of the public key to retrieve. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 564

def get_ssh_public_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::GetSshPublicKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.get_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.get_ssh_public_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.get_ssh_public_key.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub.get_ssh_public_key request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse #import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil, regions: nil) ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse

Adds an SSH public key and returns the profile information. Default POSIX account information is set when no username and UID exist as part of the login profile.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::ImportSshPublicKeyRequest.new

# Call the import_ssh_public_key method.
result = client.import_ssh_public_key request

# The returned object is of type Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse.
p result

Overloads:

  • #import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse

    Pass arguments to import_ssh_public_key via a request object, either of type ImportSshPublicKeyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::ImportSshPublicKeyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil, regions: nil) ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse

    Pass arguments to import_ssh_public_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The unique ID for the user in format users/{user}.

    • ssh_public_key (::Google::Cloud::OsLogin::Common::SshPublicKey, ::Hash) (defaults to: nil) —

      Optional. The SSH public key and expiration time.

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

      The project ID of the Google Cloud Platform project.

    • regions (::Array<::String>) (defaults to: nil) —

      Optional. The regions to which to assert that the key was written. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 653

def import_ssh_public_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.import_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.import_ssh_public_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.import_ssh_public_key.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub.import_ssh_public_key request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


139
140
141
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 139

def universe_domain
  @os_login_service_stub.universe_domain
end

#update_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey #update_ssh_public_key(name: nil, ssh_public_key: nil, update_mask: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

Updates an SSH public key and returns the profile information. This method supports patch semantics.

Examples:

Basic example

require "google/cloud/os_login/v1"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::OsLogin::V1::OsLoginService::Rest::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1::UpdateSshPublicKeyRequest.new

# Call the update_ssh_public_key method.
result = client.update_ssh_public_key request

# The returned object is of type Google::Cloud::OsLogin::Common::SshPublicKey.
p result

Overloads:

  • #update_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to update_ssh_public_key via a request object, either of type UpdateSshPublicKeyRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::OsLogin::V1::UpdateSshPublicKeyRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries etc. Optional.

  • #update_ssh_public_key(name: nil, ssh_public_key: nil, update_mask: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey

    Pass arguments to update_ssh_public_key via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

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

      Required. The fingerprint of the public key to update. Public keys are identified by their SHA-256 fingerprint. The fingerprint of the public key is in format users/{user}/sshPublicKeys/{fingerprint}.

    • ssh_public_key (::Google::Cloud::OsLogin::Common::SshPublicKey, ::Hash) (defaults to: nil) —

      Required. The SSH public key and expiration time.

    • update_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      Mask to control which fields get updated. Updates all if not present.

Yields:

  • (result, operation) —

    Access the result along with the TransportOperation object

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the REST call is aborted.



739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'lib/google/cloud/os_login/v1/os_login_service/rest/client.rb', line 739

def update_ssh_public_key request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::UpdateSshPublicKeyRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  call_metadata = @config.rpcs.update_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  call_metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::OsLogin::V1::VERSION,
    transports_version_send: [:rest]

  call_metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  call_metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  options.apply_defaults timeout:      @config.rpcs.update_ssh_public_key.timeout,
                         metadata:     call_metadata,
                         retry_policy: @config.rpcs.update_ssh_public_key.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @os_login_service_stub.update_ssh_public_key request, options do |result, operation|
    yield result, operation if block_given?
    return result
  end
rescue ::Gapic::Rest::Error => e
  raise ::Google::Cloud::Error.from_error(e)
end