Class: Google::Cloud::OsLogin::V1::OsLoginService::Client
- Inherits:
-
Object
- Object
- Google::Cloud::OsLogin::V1::OsLoginService::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/os_login/v1/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
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client instance.
-
#delete_posix_account(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a POSIX account.
-
#delete_ssh_public_key(request, options = nil) {|response, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an SSH public key.
-
#get_login_profile(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
-
#get_ssh_public_key(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey
Retrieves an SSH public key.
-
#import_ssh_public_key(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse
Adds an SSH public key and returns the profile information.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new OsLoginService client object.
-
#update_ssh_public_key(request, options = nil) {|response, operation| ... } ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey
Updates an SSH public key and returns the profile information.
Methods included from Paths
#posix_account_path, #ssh_public_key_path, #user_path
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new OsLoginService client object.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 142 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/v1/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 == Client.configure.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::V1::OsLoginService::Stub, credentials: credentials, endpoint: @config.endpoint, channel_args: @config.channel_args, interceptors: @config.interceptors ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 59 def self.configure @configure ||= begin namespace = ["Google", "Cloud", "OsLogin", "V1"] parent_config = while namespace.any? parent_name = namespace.join "::" parent_const = const_get parent_name break parent_const.configure if parent_const.respond_to? :configure namespace.pop end default_config = Client::Configuration.new parent_config default_config.rpcs.delete_posix_account.timeout = 10.0 default_config.rpcs.delete_posix_account.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.get_login_profile.timeout = 10.0 default_config.rpcs.get_login_profile.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.
121 122 123 124 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 121 def configure yield @config if block_given? @config end |
#delete_posix_account(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_posix_account(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes a POSIX account.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 226 def delete_posix_account request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::DeletePosixAccountRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_posix_account..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_posix_account.timeout, metadata: , retry_policy: @config.rpcs.delete_posix_account.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :delete_posix_account, request, options: do |response, operation| yield response, operation if block_given? return response 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.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 313 def delete_ssh_public_key request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::DeleteSshPublicKeyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.delete_ssh_public_key..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.delete_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.delete_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :delete_ssh_public_key, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#get_login_profile(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile #get_login_profile(name: nil, project_id: nil, system_id: nil) ⇒ ::Google::Cloud::OsLogin::V1::LoginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 403 def get_login_profile request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::GetLoginProfileRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_login_profile..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_login_profile.timeout, metadata: , retry_policy: @config.rpcs.get_login_profile.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :get_login_profile, request, options: do |response, operation| yield response, operation if block_given? return response 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.
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 490 def get_ssh_public_key request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::GetSshPublicKeyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.get_ssh_public_key..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.get_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.get_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :get_ssh_public_key, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyResponse #import_ssh_public_key(parent: nil, ssh_public_key: nil, project_id: nil) ⇒ ::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.
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 581 def import_ssh_public_key request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::ImportSshPublicKeyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.import_ssh_public_key..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.import_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.import_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :import_ssh_public_key, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) 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.
673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 |
# File 'lib/google/cloud/os_login/v1/os_login_service/client.rb', line 673 def update_ssh_public_key request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::OsLogin::V1::UpdateSshPublicKeyRequest # Converts hash and nil to an options object = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.update_ssh_public_key..to_h # Set x-goog-api-client and x-goog-user-project headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Cloud::OsLogin::V1::VERSION [:"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("&") [:"x-goog-request-params"] ||= request_params_header .apply_defaults timeout: @config.rpcs.update_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.update_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.call_rpc :update_ssh_public_key, request, options: do |response, operation| yield response, operation if block_given? return response end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |