Class: Google::Ads::GoogleAds::V14::Services::CustomerService::Client::Configuration
- Inherits:
-
Object
- Object
- Google::Ads::GoogleAds::V14::Services::CustomerService::Client::Configuration
- Extended by:
- Gapic::Config
- Defined in:
- lib/google/ads/google_ads/v14/services/customer_service/client.rb
Overview
Configuration class for the CustomerService API.
This class represents the configuration for CustomerService, providing control over timeouts, retry behavior, logging, transport parameters, and other low-level controls. Certain parameters can also be applied individually to specific RPCs. See Rpcs for a list of RPCs that can be configured independently.
Configuration can be applied globally to all clients, or to a single client on construction.
Defined Under Namespace
Classes: Rpcs
Constant Summary collapse
- DEFAULT_ENDPOINT =
"googleads.googleapis.com"
Instance Attribute Summary collapse
-
#channel_args ⇒ ::Hash
Extra parameters passed to the gRPC channel.
-
#credentials ⇒ ::Object
Credentials to send with calls.
-
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint.
-
#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
-
#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 gRPC headers to be sent with the call.
-
#quota_project ⇒ ::String
A separate project against which to charge quota.
-
#retry_policy ⇒ ::Hash
The retry policy.
-
#scope ⇒ ::Array<::String>
The OAuth scopes.
-
#timeout ⇒ ::Numeric
The call timeout in seconds.
Instance Method Summary collapse
-
#initialize(parent_config = nil) {|_self| ... } ⇒ Configuration
constructor
A new instance of Configuration.
-
#rpcs ⇒ Rpcs
Configurations for individual RPCs.
Constructor Details
#initialize(parent_config = nil) {|_self| ... } ⇒ Configuration
Returns a new instance of Configuration.
546 547 548 549 550 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 546 def initialize parent_config = nil @parent_config = parent_config unless parent_config.nil? yield self if block_given? end |
Instance Attribute Details
#channel_args ⇒ ::Hash
Extra parameters passed to the gRPC channel. Note: this is ignored if a ‘GRPC::Core::Channel` object is provided as the credential.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#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](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
* (`Signet::OAuth2::Client`) A signet oauth2 client object
(see the [signet docs](https://rubydoc.info/gems/signet/Signet/OAuth2/Client))
* (`GRPC::Core::Channel`) a gRPC channel with included credentials
* (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
* (`nil`) indicating no credentials
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#endpoint ⇒ ::String
The hostname or hostname:port of the service endpoint. Defaults to ‘“googleads.googleapis.com”`.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>
An array of interceptors that are run before calls are executed.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#lib_name ⇒ ::String
The library name as recorded in instrumentation and logging
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#lib_version ⇒ ::String
The library version as recorded in instrumentation and logging
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#metadata ⇒ ::Hash{::Symbol=>::String}
Additional gRPC headers to be sent with the call.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#quota_project ⇒ ::String
A separate project against which to charge quota.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#retry_policy ⇒ ::Hash
The retry policy. The value is a hash with the following keys:
* `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
* `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
* `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
* `:retry_codes` (*type:* `Array<String>`) - The error codes that should
trigger a retry.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#scope ⇒ ::Array<::String>
The OAuth scopes
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
#timeout ⇒ ::Numeric
The call timeout in seconds.
523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 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 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 523 class Configuration extend ::Gapic::Config DEFAULT_ENDPOINT = "googleads.googleapis.com" config_attr :endpoint, DEFAULT_ENDPOINT, ::String config_attr :credentials, nil do |value| allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil] allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC 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(:channel_args, { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil) config_attr :interceptors, nil, ::Array, nil config_attr :timeout, nil, ::Numeric, nil config_attr :metadata, nil, ::Hash, nil config_attr :retry_policy, nil, ::Hash, ::Proc, nil config_attr :quota_project, nil, ::String, 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 CustomerService 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 # * `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers # * `retry_policy (*type:* `Hash`) - The retry policy. The policy fields # include the following keys: # * `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds. # * `:max_delay` (*type:* `Numeric`) - The max delay in seconds. # * `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier. # * `:retry_codes` (*type:* `Array<String>`) - The error codes that should # trigger a retry. # class Rpcs ## # RPC-specific configuration for `mutate_customer` # @return [::Gapic::Config::Method] # attr_reader :mutate_customer ## # RPC-specific configuration for `list_accessible_customers` # @return [::Gapic::Config::Method] # attr_reader :list_accessible_customers ## # RPC-specific configuration for `create_customer_client` # @return [::Gapic::Config::Method] # attr_reader :create_customer_client # @private def initialize parent_rpcs = nil mutate_customer_config = parent_rpcs.mutate_customer if parent_rpcs.respond_to? :mutate_customer @mutate_customer = ::Gapic::Config::Method.new mutate_customer_config list_accessible_customers_config = parent_rpcs.list_accessible_customers if parent_rpcs.respond_to? :list_accessible_customers @list_accessible_customers = ::Gapic::Config::Method.new list_accessible_customers_config create_customer_client_config = parent_rpcs.create_customer_client if parent_rpcs.respond_to? :create_customer_client @create_customer_client = ::Gapic::Config::Method.new create_customer_client_config yield self if block_given? end end end |
Instance Method Details
#rpcs ⇒ Rpcs
Configurations for individual RPCs
556 557 558 559 560 561 562 |
# File 'lib/google/ads/google_ads/v14/services/customer_service/client.rb', line 556 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 |