Class: Google::Cloud::OsLogin::V1::OsLoginServiceClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/os_login/v1/os_login_service_client.rb

Overview

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.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"oslogin.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
GRPC_INTERCEPTORS =

The default set of gRPC interceptors.

[]
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/cloud-platform.read-only",
  "https://www.googleapis.com/auth/compute",
  "https://www.googleapis.com/auth/compute.readonly"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ OsLoginServiceClient

Returns a new instance of OsLoginServiceClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc) —

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>) —

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.

  • metadata (Hash) —

    Default metadata to be sent with each request. This can be overridden on a per call basis.

  • exception_transformer (Proc) —

    An optional proc that intercepts any exceptions raised during an API call to inject custom error handling.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 143

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    exception_transformer: nil,
    lib_name: nil,
    lib_version: ""
  # 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 "google/gax/grpc"
  require "google/cloud/oslogin/v1/oslogin_services_pb"

  credentials ||= Google::Cloud::OsLogin::V1::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::OsLogin::V1::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  package_version = Gem.loaded_specs['google-cloud-os_login'].version.version

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  headers.merge!(metadata) unless metadata.nil?
  client_config_file = Pathname.new(__dir__).join(
    "os_login_service_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.oslogin.v1.OsLoginService",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      metadata: headers
    )
  end

  # Allow overriding the service path/port in subclasses.
  service_path = self.class::SERVICE_ADDRESS
  port = self.class::DEFAULT_SERVICE_PORT
  interceptors = self.class::GRPC_INTERCEPTORS
  @os_login_service_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    interceptors: interceptors,
    &Google::Cloud::Oslogin::V1::OsLoginService::Stub.method(:new)
  )

  @delete_posix_account = Google::Gax.create_api_call(
    @os_login_service_stub.method(:delete_posix_account),
    defaults["delete_posix_account"],
    exception_transformer: exception_transformer
  )
  @delete_ssh_public_key = Google::Gax.create_api_call(
    @os_login_service_stub.method(:delete_ssh_public_key),
    defaults["delete_ssh_public_key"],
    exception_transformer: exception_transformer
  )
  @get_login_profile = Google::Gax.create_api_call(
    @os_login_service_stub.method(:get_login_profile),
    defaults["get_login_profile"],
    exception_transformer: exception_transformer
  )
  @get_ssh_public_key = Google::Gax.create_api_call(
    @os_login_service_stub.method(:get_ssh_public_key),
    defaults["get_ssh_public_key"],
    exception_transformer: exception_transformer
  )
  @import_ssh_public_key = Google::Gax.create_api_call(
    @os_login_service_stub.method(:import_ssh_public_key),
    defaults["import_ssh_public_key"],
    exception_transformer: exception_transformer
  )
  @update_ssh_public_key = Google::Gax.create_api_call(
    @os_login_service_stub.method(:update_ssh_public_key),
    defaults["update_ssh_public_key"],
    exception_transformer: exception_transformer
  )
end

Instance Attribute Details

#os_login_service_stub ⇒ Google::Cloud::Oslogin::V1::OsLoginService::Stub (readonly)

Returns:

  • (Google::Cloud::Oslogin::V1::OsLoginService::Stub) 


41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
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
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
305
306
307
308
309
310
311
312
313
314
315
316
317
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
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
392
393
394
395
396
397
398
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
434
435
436
437
438
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
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 41

class OsLoginServiceClient
  attr_reader :os_login_service_stub

  # The default address of the service.
  SERVICE_ADDRESS = "oslogin.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  # The default set of gRPC interceptors.
  GRPC_INTERCEPTORS = []

  DEFAULT_TIMEOUT = 30

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/cloud-platform.read-only",
    "https://www.googleapis.com/auth/compute",
    "https://www.googleapis.com/auth/compute.readonly"
  ].freeze


  USER_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "users/{user}"
  )

  private_constant :USER_PATH_TEMPLATE

  PROJECT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "users/{user}/projects/{project}"
  )

  private_constant :PROJECT_PATH_TEMPLATE

  FINGERPRINT_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "users/{user}/sshPublicKeys/{fingerprint}"
  )

  private_constant :FINGERPRINT_PATH_TEMPLATE

  # Returns a fully-qualified user resource name string.
  # @param user [String]
  # @return [String]
  def self.user_path user
    USER_PATH_TEMPLATE.render(
      :"user" => user
    )
  end

  # Returns a fully-qualified project resource name string.
  # @param user [String]
  # @param project [String]
  # @return [String]
  def self.project_path user, project
    PROJECT_PATH_TEMPLATE.render(
      :"user" => user,
      :"project" => project
    )
  end

  # Returns a fully-qualified fingerprint resource name string.
  # @param user [String]
  # @param fingerprint [String]
  # @return [String]
  def self.fingerprint_path user, fingerprint
    FINGERPRINT_PATH_TEMPLATE.render(
      :"user" => user,
      :"fingerprint" => fingerprint
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  # @param metadata [Hash]
  #   Default metadata to be sent with each request. This can be overridden on a per call basis.
  # @param exception_transformer [Proc]
  #   An optional proc that intercepts any exceptions raised during an API call to inject
  #   custom error handling.
  def initialize \
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      metadata: nil,
      exception_transformer: nil,
      lib_name: nil,
      lib_version: ""
    # 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 "google/gax/grpc"
    require "google/cloud/oslogin/v1/oslogin_services_pb"

    credentials ||= Google::Cloud::OsLogin::V1::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::OsLogin::V1::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    package_version = Gem.loaded_specs['google-cloud-os_login'].version.version

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/#{package_version} gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    headers.merge!(metadata) unless metadata.nil?
    client_config_file = Pathname.new(__dir__).join(
      "os_login_service_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.cloud.oslogin.v1.OsLoginService",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        errors: Google::Gax::Grpc::API_ERRORS,
        metadata: headers
      )
    end

    # Allow overriding the service path/port in subclasses.
    service_path = self.class::SERVICE_ADDRESS
    port = self.class::DEFAULT_SERVICE_PORT
    interceptors = self.class::GRPC_INTERCEPTORS
    @os_login_service_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      interceptors: interceptors,
      &Google::Cloud::Oslogin::V1::OsLoginService::Stub.method(:new)
    )

    @delete_posix_account = Google::Gax.create_api_call(
      @os_login_service_stub.method(:delete_posix_account),
      defaults["delete_posix_account"],
      exception_transformer: exception_transformer
    )
    @delete_ssh_public_key = Google::Gax.create_api_call(
      @os_login_service_stub.method(:delete_ssh_public_key),
      defaults["delete_ssh_public_key"],
      exception_transformer: exception_transformer
    )
    @get_login_profile = Google::Gax.create_api_call(
      @os_login_service_stub.method(:get_login_profile),
      defaults["get_login_profile"],
      exception_transformer: exception_transformer
    )
    @get_ssh_public_key = Google::Gax.create_api_call(
      @os_login_service_stub.method(:get_ssh_public_key),
      defaults["get_ssh_public_key"],
      exception_transformer: exception_transformer
    )
    @import_ssh_public_key = Google::Gax.create_api_call(
      @os_login_service_stub.method(:import_ssh_public_key),
      defaults["import_ssh_public_key"],
      exception_transformer: exception_transformer
    )
    @update_ssh_public_key = Google::Gax.create_api_call(
      @os_login_service_stub.method(:update_ssh_public_key),
      defaults["update_ssh_public_key"],
      exception_transformer: exception_transformer
    )
  end

  # Service calls

  # Deletes a POSIX account.
  #
  # @param name [String]
  #   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}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.project_path("[USER]", "[PROJECT]")
  #   os_login_service_client.delete_posix_account(formatted_name)

  def  \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::DeletePosixAccountRequest)
    @delete_posix_account.call(req, options, &block)
    nil
  end

  # Deletes an SSH public key.
  #
  # @param name [String]
  #   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}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result []
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
  #   os_login_service_client.delete_ssh_public_key(formatted_name)

  def delete_ssh_public_key \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::DeleteSshPublicKeyRequest)
    @delete_ssh_public_key.call(req, options, &block)
    nil
  end

  # Retrieves the profile information used for logging in to a virtual machine
  # on Google Compute Engine.
  #
  # @param name [String]
  #   The unique ID for the user in format +users/{user}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Oslogin::V1::LoginProfile]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Oslogin::V1::LoginProfile]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.user_path("[USER]")
  #   response = os_login_service_client.get_login_profile(formatted_name)

  def  \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::GetLoginProfileRequest)
    @get_login_profile.call(req, options, &block)
  end

  # Retrieves an SSH public key.
  #
  # @param name [String]
  #   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}+.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Oslogin::Common::SshPublicKey]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
  #   response = os_login_service_client.get_ssh_public_key(formatted_name)

  def get_ssh_public_key \
      name,
      options: nil,
      &block
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::GetSshPublicKeyRequest)
    @get_ssh_public_key.call(req, options, &block)
  end

  # 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.
  #
  # @param parent [String]
  #   The unique ID for the user in format +users/{user}+.
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
  #   The SSH public key and expiration time.
  #   A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
  #   can also be provided.
  # @param project_id [String]
  #   The project ID of the Google Cloud Platform project.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Oslogin::V1::ImportSshPublicKeyResponse]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Oslogin::V1::ImportSshPublicKeyResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_parent = Google::Cloud::OsLogin::V1::OsLoginServiceClient.user_path("[USER]")
  #
  #   # TODO: Initialize +ssh_public_key+:
  #   ssh_public_key = {}
  #   response = os_login_service_client.import_ssh_public_key(formatted_parent, ssh_public_key)

  def import_ssh_public_key \
      parent,
      ssh_public_key,
      project_id: nil,
      options: nil,
      &block
    req = {
      parent: parent,
      ssh_public_key: ssh_public_key,
      project_id: project_id
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::ImportSshPublicKeyRequest)
    @import_ssh_public_key.call(req, options, &block)
  end

  # Updates an SSH public key and returns the profile information. This method
  # supports patch semantics.
  #
  # @param name [String]
  #   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}+.
  # @param ssh_public_key [Google::Cloud::Oslogin::Common::SshPublicKey | Hash]
  #   The SSH public key and expiration time.
  #   A hash of the same form as `Google::Cloud::Oslogin::Common::SshPublicKey`
  #   can also be provided.
  # @param update_mask [Google::Protobuf::FieldMask | Hash]
  #   Mask to control which fields get updated. Updates all if not present.
  #   A hash of the same form as `Google::Protobuf::FieldMask`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @yield [result, operation] Access the result along with the RPC operation
  # @yieldparam result [Google::Cloud::Oslogin::Common::SshPublicKey]
  # @yieldparam operation [GRPC::ActiveCall::Operation]
  # @return [Google::Cloud::Oslogin::Common::SshPublicKey]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/os_login"
  #
  #   os_login_service_client = Google::Cloud::OsLogin.new(version: :v1)
  #   formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
  #
  #   # TODO: Initialize +ssh_public_key+:
  #   ssh_public_key = {}
  #   response = os_login_service_client.update_ssh_public_key(formatted_name, ssh_public_key)

  def update_ssh_public_key \
      name,
      ssh_public_key,
      update_mask: nil,
      options: nil,
      &block
    req = {
      name: name,
      ssh_public_key: ssh_public_key,
      update_mask: update_mask
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::UpdateSshPublicKeyRequest)
    @update_ssh_public_key.call(req, options, &block)
  end
end

Class Method Details

.fingerprint_path(user, fingerprint) ⇒ String

Returns a fully-qualified fingerprint resource name string.

Parameters:

  • user (String)
  • fingerprint (String)

Returns:

  • (String) 


107
108
109
110
111
112
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 107

def self.fingerprint_path user, fingerprint
  FINGERPRINT_PATH_TEMPLATE.render(
    :"user" => user,
    :"fingerprint" => fingerprint
  )
end

.project_path(user, project) ⇒ String

Returns a fully-qualified project resource name string.

Parameters:

  • user (String)
  • project (String)

Returns:

  • (String) 


96
97
98
99
100
101
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 96

def self.project_path user, project
  PROJECT_PATH_TEMPLATE.render(
    :"user" => user,
    :"project" => project
  )
end

.user_path(user) ⇒ String

Returns a fully-qualified user resource name string.

Parameters:

  • user (String)

Returns:

  • (String) 


86
87
88
89
90
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 86

def self.user_path user
  USER_PATH_TEMPLATE.render(
    :"user" => user
  )
end

Instance Method Details

#delete_posix_account(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes a POSIX account.

Examples:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.project_path("[USER]", "[PROJECT]")
.(formatted_name)

Parameters:

  • name (String) —

    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+.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 270

def  \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::DeletePosixAccountRequest)
  @delete_posix_account.call(req, options, &block)
  nil
end

#delete_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Object

Deletes an SSH public key.

Examples:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
.delete_ssh_public_key(formatted_name)

Parameters:

  • name (String) —

    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+.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • result —

    []

  • operation (GRPC::ActiveCall::Operation)

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 302

def delete_ssh_public_key \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::DeleteSshPublicKeyRequest)
  @delete_ssh_public_key.call(req, options, &block)
  nil
end

#get_login_profile(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Oslogin::V1::LoginProfile

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

Examples:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.user_path("[USER]")
response = .(formatted_name)

Parameters:

  • name (String) —

    The unique ID for the user in format +users/user+.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



334
335
336
337
338
339
340
341
342
343
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 334

def  \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::GetLoginProfileRequest)
  @get_login_profile.call(req, options, &block)
end

#get_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Oslogin::Common::SshPublicKey

Retrieves an SSH public key.

Examples:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")
response = .get_ssh_public_key(formatted_name)

Parameters:

  • name (String) —

    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+.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



366
367
368
369
370
371
372
373
374
375
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 366

def get_ssh_public_key \
    name,
    options: nil,
    &block
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::GetSshPublicKeyRequest)
  @get_ssh_public_key.call(req, options, &block)
end

#import_ssh_public_key(parent, ssh_public_key, project_id: nil, options: nil) {|result, operation| ... } ⇒ 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:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_parent = Google::Cloud::OsLogin::V1::OsLoginServiceClient.user_path("[USER]")

# TODO: Initialize +ssh_public_key+:
ssh_public_key = {}
response = .import_ssh_public_key(formatted_parent, ssh_public_key)

Parameters:

  • parent (String) —

    The unique ID for the user in format +users/user+.

  • ssh_public_key (Google::Cloud::Oslogin::Common::SshPublicKey | Hash) —

    The SSH public key and expiration time. A hash of the same form as Google::Cloud::Oslogin::Common::SshPublicKey can also be provided.

  • project_id (String) —

    The project ID of the Google Cloud Platform project.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 407

def import_ssh_public_key \
    parent,
    ssh_public_key,
    project_id: nil,
    options: nil,
    &block
  req = {
    parent: parent,
    ssh_public_key: ssh_public_key,
    project_id: project_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::ImportSshPublicKeyRequest)
  @import_ssh_public_key.call(req, options, &block)
end

#update_ssh_public_key(name, ssh_public_key, update_mask: nil, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Oslogin::Common::SshPublicKey

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

Examples:

require "google/cloud/os_login"

 = Google::Cloud::OsLogin.new(version: :v1)
formatted_name = Google::Cloud::OsLogin::V1::OsLoginServiceClient.fingerprint_path("[USER]", "[FINGERPRINT]")

# TODO: Initialize +ssh_public_key+:
ssh_public_key = {}
response = .update_ssh_public_key(formatted_name, ssh_public_key)

Parameters:

  • name (String) —

    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) —

    The SSH public key and expiration time. A hash of the same form as Google::Cloud::Oslogin::Common::SshPublicKey can also be provided.

  • update_mask (Google::Protobuf::FieldMask | Hash) —

    Mask to control which fields get updated. Updates all if not present. A hash of the same form as Google::Protobuf::FieldMask can also be provided.

  • options (Google::Gax::CallOptions) —

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

Yields:

  • (result, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 455

def update_ssh_public_key \
    name,
    ssh_public_key,
    update_mask: nil,
    options: nil,
    &block
  req = {
    name: name,
    ssh_public_key: ssh_public_key,
    update_mask: update_mask
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Cloud::Oslogin::V1::UpdateSshPublicKeyRequest)
  @update_ssh_public_key.call(req, options, &block)
end