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/compute"
].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, service_address: nil, service_port: 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) (defaults to: nil) —

    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>) (defaults to: ALL_SCOPES) —

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

  • client_config (Hash) (defaults to: {}) —

    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) (defaults to: DEFAULT_TIMEOUT) —

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

  • metadata (Hash) (defaults to: nil) —

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

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

    Override for the service hostname, or nil to leave as the default.

  • service_port (Integer) (defaults to: nil) —

    Override for the service port, or nil to leave as the default.

  • exception_transformer (Proc) (defaults to: nil) —

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



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
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 148

def initialize \
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    metadata: nil,
    service_address: nil,
    service_port: 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 = Google::Cloud::OsLogin::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 = service_address || self.class::SERVICE_ADDRESS
  port = service_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,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @get_login_profile = Google::Gax.create_api_call(
    @os_login_service_stub.method(:get_login_profile),
    defaults["get_login_profile"],
    exception_transformer: exception_transformer,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'parent' => request.parent}
    end
  )
  @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,
    params_extractor: proc do |request|
      {'name' => request.name}
    end
  )
end

Class Method Details

.posix_account_path(user, project) ⇒ String

Returns a fully-qualified posix_account resource name string.

Parameters:

  • user (String)
  • project (String)

Returns:

  • (String) 


88
89
90
91
92
93
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 88

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

.ssh_public_key_path(user, fingerprint) ⇒ String

Returns a fully-qualified ssh_public_key resource name string.

Parameters:

  • user (String)
  • fingerprint (String)

Returns:

  • (String) 


99
100
101
102
103
104
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 99

def self.ssh_public_key_path user, fingerprint
  SSH_PUBLIC_KEY_PATH_TEMPLATE.render(
    :"user" => user,
    :"fingerprint" => fingerprint
  )
end

.user_path(user) ⇒ String

Returns a fully-qualified user resource name string.

Parameters:

  • user (String)

Returns:

  • (String) 


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

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.("[USER]", "[PROJECT]")
.(formatted_name)

Parameters:

  • name (String) —

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 295

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.ssh_public_key_path("[USER]", "[FINGERPRINT]")
.delete_ssh_public_key(formatted_name)

Parameters:

  • name (String) —

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 327

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, project_id: nil, system_id: nil, 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) —

    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.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



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

def  \
    name,
    project_id: nil,
    system_id: nil,
    options: nil,
    &block
  req = {
    name: name,
    project_id: project_id,
    system_id: system_id
  }.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.ssh_public_key_path("[USER]", "[FINGERPRINT]")
response = .get_ssh_public_key(formatted_name)

Parameters:

  • name (String) —

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

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



399
400
401
402
403
404
405
406
407
408
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 399

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: nil, 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]")
response = .import_ssh_public_key(formatted_parent)

Parameters:

  • parent (String) —

    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. A hash of the same form as Google::Cloud::Oslogin::Common::SshPublicKey can also be provided.

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

    The project ID of the Google Cloud Platform project.

  • options (Google::Gax::CallOptions) (defaults to: nil) —

    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.



437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 437

def import_ssh_public_key \
    parent,
    ssh_public_key: nil,
    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.ssh_public_key_path("[USER]", "[FINGERPRINT]")

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

Parameters:

  • name (String) —

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

    Required. 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) (defaults to: nil) —

    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) (defaults to: nil) —

    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.



485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 485

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