Class: Google::Cloud::OsLogin::V1beta::OsLoginService::Client

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

Overview

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 client object.

Examples:


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

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

Yields:

  • (config) —

    Configure the OsLoginService client.

Yield Parameters:



157
158
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 157

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/oslogin/v1beta/oslogin_services_pb"

  # 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 = ::Gapic::ServiceStub.new(
    ::Google::Cloud::OsLogin::V1beta::OsLoginService::Stub,
    credentials: credentials,
    endpoint: @config.endpoint,
    endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
    universe_domain: @config.universe_domain,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors,
    channel_pool_config: @config.channel_pool,
    logger: @config.logger
  )

  @os_login_service_stub.stub_logger&.info do |entry|
    entry.set_system_name
    entry.set_service
    entry.message = "Created client for #{entry.service}"
    entry.set_credentials_fields credentials
    entry.set "customEndpoint", @config.endpoint if @config.endpoint
    entry.set "defaultTimeout", @config.timeout if @config.timeout
    entry.set "quotaProject", @quota_project_id if @quota_project_id
  end
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::V1beta::OsLoginService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



65
66
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
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 65

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "OsLogin", "V1beta"]
    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:



127
128
129
130
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 127

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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 265

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::V1beta::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
  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
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.create_ssh_public_key.timeout,
                         metadata:     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.call_rpc :create_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 352

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1beta::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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     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.call_rpc :delete_posix_account, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 439

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::V1beta::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
  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
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.delete_ssh_public_key.timeout,
                         metadata:     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.call_rpc :delete_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_login_profile(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1beta::LoginProfile #get_login_profile(name: nil, project_id: nil, system_id: nil, view: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::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/v1beta"

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

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

# Call the get_login_profile method.
result = client. request

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

Overloads:

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

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

    Parameters:

    • request (::Google::Cloud::OsLogin::V1beta::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, view: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::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.

    • view (::Google::Cloud::OsLogin::V1beta::LoginProfileView) (defaults to: nil) —

      The view configures whether to retrieve security keys information.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 531

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1beta::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
  metadata = @config.rpcs..metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs..timeout,
                         metadata:     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.call_rpc :get_login_profile, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => 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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 618

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::V1beta::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
  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
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_ssh_public_key.timeout,
                         metadata:     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.call_rpc :get_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1beta::ImportSshPublicKeyResponse #import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil, view: nil, regions: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::ImportSshPublicKeyResponse.
p result

Overloads:

  • #import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1beta::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::V1beta::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, view: nil, regions: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::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:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 715

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::V1beta::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
  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
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.import_ssh_public_key.timeout,
                         metadata:     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.call_rpc :import_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#logger ⇒ Logger

The logger used for request/response debug logging.

Returns:

  • (Logger) 


213
214
215
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 213

def logger
  @os_login_service_stub.logger
end

#sign_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse #sign_ssh_public_key(ssh_public_key: nil, parent: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse

Signs an SSH public key for a user to authenticate to an instance.

Examples:

Basic example

require "google/cloud/os_login/v1beta"

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

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

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

# The returned object is of type Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse.
p result

Overloads:

  • #sign_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse

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

    Parameters:

    • request (::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyRequest, ::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.

  • #sign_ssh_public_key(ssh_public_key: nil, parent: nil) ⇒ ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse

    Pass arguments to sign_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:

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

      The SSH public key to sign.

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

      The parent project and region for the signing request.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 894

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

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyRequest

  # 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
  metadata = @config.rpcs.sign_ssh_public_key.metadata.to_h

  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.parent
    header_params["parent"] = request.parent
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

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

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

  @os_login_service_stub.call_rpc :sign_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#universe_domain ⇒ String

The effective universe domain

Returns:

  • (String) 


137
138
139
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 137

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/v1beta"

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

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::OsLogin::V1beta::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::V1beta::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:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

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

    if the RPC is aborted.



807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
 
# File 'lib/google/cloud/os_login/v1beta/os_login_service/client.rb', line 807

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::V1beta::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
  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
  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::V1beta::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_ssh_public_key.timeout,
                         metadata:     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.call_rpc :update_ssh_public_key, request, options: options do |response, operation|
    yield response, operation if block_given?
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end