Class: Google::Cloud::Compute::V1::Zones::Rest::Client::Configuration
- Inherits:
-
Object
- Object
- Google::Cloud::Compute::V1::Zones::Rest::Client::Configuration
- Extended by:
- Gapic::Config
- Defined in:
- lib/google/cloud/compute/v1/zones/rest/client.rb
Overview
Configuration class for the Zones REST API.
This class represents the configuration for Zones REST, providing control over credentials, timeouts, retry behavior, logging.
Configuration can be applied globally to all clients, or to a single client on construction.
Examples
To modify the global config, setting the timeout for all calls to 10 seconds:
::Google::Cloud::Compute::V1::Zones::Client.configure do |config|
config.timeout = 10.0
end
To apply the above configuration only to a new client:
client = ::Google::Cloud::Compute::V1::Zones::Client.new do |config|
config.timeout = 10.0
end
Defined Under Namespace
Classes: Rpcs
Instance Attribute Summary collapse
-
#credentials ⇒ ::Object
Credentials to send with calls.
-
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint.
-
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging.
-
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging.
-
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional REST headers to be sent with the call.
-
#scope ⇒ ::Array<::String>
The OAuth scopes.
-
#timeout ⇒ ::Numeric
The call timeout in seconds.
Instance Method Summary collapse
-
#rpcs ⇒ Rpcs
Configurations for individual RPCs.
Instance Attribute Details
#credentials ⇒ ::Object
Credentials to send with calls. You may provide any of the following types:
- (
String
) The path to a service account key file in JSON format - (
Hash
) A service account key as a Hash - (
Google::Auth::Credentials
) A googleauth credentials object (see the googleauth docs) - (
Signet::OAuth2::Client
) A signet oauth2 client object (see the signet docs) - (
nil
) indicating no credentials
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint.
Defaults to "compute.googleapis.com"
.
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional REST headers to be sent with the call.
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#scope ⇒ ::Array<::String>
The OAuth scopes
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
#timeout ⇒ ::Numeric
The call timeout in seconds.
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 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 326 class Configuration extend ::Gapic::Config config_attr :endpoint, "compute.googleapis.com", ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed.any? { |klass| klass === value } end config_attr :scope, nil, ::String, ::Array, nil config_attr :lib_name, nil, ::String, nil config_attr :lib_version, nil, ::String, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil # @private def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end ## # Configurations for individual RPCs # @return [Rpcs] # def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end ## # Configuration RPC class for the Zones API. # # Includes fields providing the configuration for each RPC in this service. # Each configuration object is of type `Gapic::Config::Method` and includes # the following configuration fields: # # * `timeout` (*type:* `Numeric`) - The call timeout in seconds # # there is one other field (`retry_policy`) that can be set # but is currently not supported for REST Gapic libraries. # class Rpcs ## # RPC-specific configuration for `get` # @return [::Gapic::Config::Method] # attr_reader :get ## # RPC-specific configuration for `list` # @return [::Gapic::Config::Method] # attr_reader :list # @private def initialize parent_rpcs = nil get_config = parent_rpcs.get if parent_rpcs.respond_to? :get @get = ::Gapic::Config::Method.new get_config list_config = parent_rpcs.list if parent_rpcs.respond_to? :list @list = ::Gapic::Config::Method.new list_config yield self if block_given? end end end |
Instance Method Details
#rpcs ⇒ Rpcs
Configurations for individual RPCs
351 352 353 354 355 356 357 |
# File 'lib/google/cloud/compute/v1/zones/rest/client.rb', line 351 def rpcs @rpcs ||= begin parent_rpcs = nil parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs) Rpcs.new parent_rpcs end end |