Class: Google::Cloud::OsLogin::V1beta::OsLoginService::Rest::Client
- Inherits:
-
Object
- Object
- Google::Cloud::OsLogin::V1beta::OsLoginService::Rest::Client
- Includes:
- Paths
- Defined in:
- lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb
Overview
REST client for the OsLoginService service.
Cloud OS Login API
The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client instance.
-
#create_ssh_public_key(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey
Create an SSH public key.
-
#delete_posix_account(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes a POSIX account.
-
#delete_ssh_public_key(request, options = nil) {|result, operation| ... } ⇒ ::Google::Protobuf::Empty
Deletes an SSH public key.
-
#get_login_profile(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsLogin::V1beta::LoginProfile
Retrieves the profile information used for logging in to a virtual machine on Google Compute Engine.
-
#get_ssh_public_key(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey
Retrieves an SSH public key.
-
#import_ssh_public_key(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsLogin::V1beta::ImportSshPublicKeyResponse
Adds an SSH public key and returns the profile information.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new OsLoginService REST client object.
-
#sign_ssh_public_key(request, options = nil) {|result, operation| ... } ⇒ ::Google::Cloud::OsLogin::V1beta::SignSshPublicKeyResponse
Signs an SSH public key for a user to authenticate to an instance.
-
#universe_domain ⇒ String
The effective universe domain.
-
#update_ssh_public_key(request, options = nil) {|result, 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 REST client object.
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 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 156 def initialize # Create the configuration object @config = Configuration.new Client.configure # Yield the configuration if needed yield @config if block_given? # Create credentials credentials = @config.credentials # Use self-signed JWT if the endpoint is unchanged from default, # but only if the default endpoint does not have a region prefix. enable_self_signed_jwt = @config.endpoint.nil? || (@config.endpoint == Configuration::DEFAULT_ENDPOINT && !@config.endpoint.split(".").first.include?("-")) credentials ||= Credentials.default scope: @config.scope, enable_self_signed_jwt: enable_self_signed_jwt if credentials.is_a?(::String) || credentials.is_a?(::Hash) credentials = Credentials.new credentials, scope: @config.scope end @quota_project_id = @config.quota_project @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id @os_login_service_stub = ::Google::Cloud::OsLogin::V1beta::OsLoginService::Rest::ServiceStub.new( endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, credentials: credentials ) end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the OsLoginService Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 64 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.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.
126 127 128 129 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 126 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
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 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 234 def create_ssh_public_key request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.create_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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.create_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.create_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.create_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_posix_account(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_posix_account(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes a POSIX account.
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 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 314 def delete_posix_account request, = 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 = ::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.delete_posix_account request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#delete_ssh_public_key(request, options = nil) ⇒ ::Google::Protobuf::Empty #delete_ssh_public_key(name: nil) ⇒ ::Google::Protobuf::Empty
Deletes an SSH public key.
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 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 394 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::V1beta::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.delete_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_login_profile(request, options = nil) ⇒ ::Google::Cloud::OsLogin::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.
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 479 def get_login_profile request, = 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 = ::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.get_login_profile request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#get_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey #get_ssh_public_key(name: nil) ⇒ ::Google::Cloud::OsLogin::Common::SshPublicKey
Retrieves an SSH public key.
559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 559 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::V1beta::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.get_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#import_ssh_public_key(request, options = nil) ⇒ ::Google::Cloud::OsLogin::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.
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 649 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::V1beta::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.import_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#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.
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 847 848 849 850 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 817 def sign_ssh_public_key request, = 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 = ::Gapic::CallOptions.new(**.to_h) if .respond_to? :to_h # Customize the options with defaults = @config.rpcs.sign_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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .apply_defaults timeout: @config.rpcs.sign_ssh_public_key.timeout, metadata: , retry_policy: @config.rpcs.sign_ssh_public_key.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @os_login_service_stub.sign_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
136 137 138 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 136 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.
734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 |
# File 'lib/google/cloud/os_login/v1beta/os_login_service/rest/client.rb', line 734 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::V1beta::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::V1beta::VERSION, transports_version_send: [:rest] [:"x-goog-user-project"] = @quota_project_id if @quota_project_id .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.update_ssh_public_key request, do |result, operation| yield result, operation if block_given? return result end rescue ::Gapic::Rest::Error => e raise ::Google::Cloud::Error.from_error(e) end |