Class: Google::Cloud::OsLogin::V1::OsLoginServiceClient
- Inherits:
-
Object
- Object
- Google::Cloud::OsLogin::V1::OsLoginServiceClient
- 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
Class Method Summary collapse
-
.fingerprint_path(user, fingerprint) ⇒ String
Returns a fully-qualified fingerprint resource name string.
-
.project_path(user, project) ⇒ String
Returns a fully-qualified project resource name string.
-
.user_path(user) ⇒ String
Returns a fully-qualified user resource name string.
Instance Method Summary collapse
-
#delete_posix_account(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes a POSIX account.
-
#delete_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes an SSH public key.
-
#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.
-
#get_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Oslogin::Common::SshPublicKey
Retrieves an SSH public key.
-
#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.
-
#initialize(credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, metadata: nil, exception_transformer: nil, lib_name: nil, lib_version: "") ⇒ OsLoginServiceClient
constructor
A new instance of OsLoginServiceClient.
-
#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.
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.
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 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 145 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!() unless .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, 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
.fingerprint_path(user, fingerprint) ⇒ String
Returns a fully-qualified fingerprint resource name string.
89 90 91 92 93 94 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 89 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.
100 101 102 103 104 105 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 100 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.
110 111 112 113 114 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 110 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.
290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 290 def delete_posix_account \ 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, , &block) nil end |
#delete_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Object
Deletes an SSH public key.
322 323 324 325 326 327 328 329 330 331 332 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 322 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, , &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.
354 355 356 357 358 359 360 361 362 363 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 354 def get_login_profile \ 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, , &block) end |
#get_ssh_public_key(name, options: nil) {|result, operation| ... } ⇒ Google::Cloud::Oslogin::Common::SshPublicKey
Retrieves an SSH public key.
386 387 388 389 390 391 392 393 394 395 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 386 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, , &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.
427 428 429 430 431 432 433 434 435 436 437 438 439 440 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 427 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, , &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.
475 476 477 478 479 480 481 482 483 484 485 486 487 488 |
# File 'lib/google/cloud/os_login/v1/os_login_service_client.rb', line 475 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, , &block) end |