Class: Google::Iam::Credentials::V1::IAMCredentials::Client
- Inherits:
-
Object
- Object
- Google::Iam::Credentials::V1::IAMCredentials::Client
- Includes:
- Paths
- Defined in:
- lib/google/iam/credentials/v1/iam_credentials/client.rb
Overview
Client for the IAMCredentials service.
A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user. Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved.
Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self-signed JSON Web Tokens (JWTs), and more.
Defined Under Namespace
Classes: Configuration
Class Method Summary collapse
-
.configure {|config| ... } ⇒ Client::Configuration
Configure the IAMCredentials Client class.
Instance Method Summary collapse
-
#configure {|config| ... } ⇒ Client::Configuration
Configure the IAMCredentials Client instance.
-
#generate_access_token(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::Credentials::V1::GenerateAccessTokenResponse
Generates an OAuth 2.0 access token for a service account.
-
#generate_id_token(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::Credentials::V1::GenerateIdTokenResponse
Generates an OpenID Connect ID token for a service account.
-
#initialize {|config| ... } ⇒ Client
constructor
Create a new IAMCredentials client object.
-
#logger ⇒ Logger
The logger used for request/response debug logging.
-
#sign_blob(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::Credentials::V1::SignBlobResponse
Signs a blob using a service account's system-managed private key.
-
#sign_jwt(request, options = nil) {|response, operation| ... } ⇒ ::Google::Iam::Credentials::V1::SignJwtResponse
Signs a JWT using a service account's system-managed private key.
-
#universe_domain ⇒ String
The effective universe domain.
Methods included from Paths
Constructor Details
#initialize {|config| ... } ⇒ Client
Create a new IAMCredentials client object.
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 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 152 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/iam/credentials/v1/iamcredentials_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.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 @iam_credentials_stub = ::Gapic::ServiceStub.new( ::Google::Iam::Credentials::V1::IAMCredentials::Stub, credentials: credentials, endpoint: @config.endpoint, endpoint_template: DEFAULT_ENDPOINT_TEMPLATE, universe_domain: @config.universe_domain, channel_args: @config.channel_args, interceptors: @config.interceptors, channel_pool_config: @config.channel_pool, logger: @config.logger ) @iam_credentials_stub.stub_logger&.info do |entry| entry.set_system_name entry.set_service entry. = "Created client for #{entry.service}" entry.set_credentials_fields credentials entry.set "customEndpoint", @config.endpoint if @config.endpoint entry.set "defaultTimeout", @config.timeout if @config.timeout entry.set "quotaProject", @quota_project_id if @quota_project_id end end |
Class Method Details
.configure {|config| ... } ⇒ Client::Configuration
Configure the IAMCredentials Client class.
See Configuration for a description of the configuration fields.
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 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 70 def self.configure @configure ||= begin namespace = ["Google", "Iam", "Credentials", "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.generate_access_token.timeout = 60.0 default_config.rpcs.generate_access_token.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.generate_id_token.timeout = 60.0 default_config.rpcs.generate_id_token.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.sign_blob.timeout = 60.0 default_config.rpcs.sign_blob.retry_policy = { initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [14, 4] } default_config.rpcs.sign_jwt.timeout = 60.0 default_config.rpcs.sign_jwt.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 IAMCredentials 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.
122 123 124 125 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 122 def configure yield @config if block_given? @config end |
#generate_access_token(request, options = nil) ⇒ ::Google::Iam::Credentials::V1::GenerateAccessTokenResponse #generate_access_token(name: nil, delegates: nil, scope: nil, lifetime: nil) ⇒ ::Google::Iam::Credentials::V1::GenerateAccessTokenResponse
Generates an OAuth 2.0 access token for a service account.
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 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 282 def generate_access_token request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::Credentials::V1::GenerateAccessTokenRequest # 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.generate_access_token..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Iam::Credentials::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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.generate_access_token.timeout, metadata: , retry_policy: @config.rpcs.generate_access_token.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @iam_credentials_stub.call_rpc :generate_access_token, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#generate_id_token(request, options = nil) ⇒ ::Google::Iam::Credentials::V1::GenerateIdTokenResponse #generate_id_token(name: nil, delegates: nil, audience: nil, include_email: nil) ⇒ ::Google::Iam::Credentials::V1::GenerateIdTokenResponse
Generates an OpenID Connect ID token for a service account.
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 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 387 def generate_id_token request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::Credentials::V1::GenerateIdTokenRequest # 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.generate_id_token..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Iam::Credentials::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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.generate_id_token.timeout, metadata: , retry_policy: @config.rpcs.generate_id_token.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @iam_credentials_stub.call_rpc :generate_id_token, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#logger ⇒ Logger
The logger used for request/response debug logging.
208 209 210 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 208 def logger @iam_credentials_stub.logger end |
#sign_blob(request, options = nil) ⇒ ::Google::Iam::Credentials::V1::SignBlobResponse #sign_blob(name: nil, delegates: nil, payload: nil) ⇒ ::Google::Iam::Credentials::V1::SignBlobResponse
Signs a blob using a service account's system-managed private key.
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 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 488 def sign_blob request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::Credentials::V1::SignBlobRequest # 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_blob..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Iam::Credentials::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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.sign_blob.timeout, metadata: , retry_policy: @config.rpcs.sign_blob.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @iam_credentials_stub.call_rpc :sign_blob, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#sign_jwt(request, options = nil) ⇒ ::Google::Iam::Credentials::V1::SignJwtResponse #sign_jwt(name: nil, delegates: nil, payload: nil) ⇒ ::Google::Iam::Credentials::V1::SignJwtResponse
Signs a JWT using a service account's system-managed private key.
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 621 622 623 624 625 626 627 628 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 589 def sign_jwt request, = nil raise ::ArgumentError, "request must be provided" if request.nil? request = ::Gapic::Protobuf.coerce request, to: ::Google::Iam::Credentials::V1::SignJwtRequest # 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_jwt..to_h # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers [:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \ lib_name: @config.lib_name, lib_version: @config.lib_version, gapic_version: ::Google::Iam::Credentials::V1::VERSION [:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty? [:"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.sign_jwt.timeout, metadata: , retry_policy: @config.rpcs.sign_jwt.retry_policy .apply_defaults timeout: @config.timeout, metadata: @config., retry_policy: @config.retry_policy @iam_credentials_stub.call_rpc :sign_jwt, request, options: do |response, operation| yield response, operation if block_given? end rescue ::GRPC::BadStatus => e raise ::Google::Cloud::Error.from_error(e) end |
#universe_domain ⇒ String
The effective universe domain
132 133 134 |
# File 'lib/google/iam/credentials/v1/iam_credentials/client.rb', line 132 def universe_domain @iam_credentials_stub.universe_domain end |