Class: Google::Ads::GoogleAds::V14::Services::ExperimentService::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/ads/google_ads/v14/services/experiment_service/client.rb

Overview

Configuration class for the ExperimentService API.

This class represents the configuration for ExperimentService, 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.

Examples:


# Modify the global config, setting the timeout for
# mutate_experiments to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Ads::GoogleAds::V14::Services::ExperimentService::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.mutate_experiments.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Ads::GoogleAds::V14::Services::ExperimentService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.mutate_experiments.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT = 
"googleads.googleapis.com"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parent_config = nil) {|_self| ... } ⇒ Configuration

Returns a new instance of Configuration.

Yields:

  • (_self)

Yield Parameters:



919
920
921
922
923
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 919

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.

Returns:

  • (::Hash) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_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

Returns:

  • (::Object) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_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”`.

Returns:

  • (::String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#interceptors ⇒ ::Array<::GRPC::ClientInterceptor>

An array of interceptors that are run before calls are executed.

Returns:

  • (::Array<::GRPC::ClientInterceptor>) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#metadata ⇒ ::Hash{::Symbol=>::String}

Additional gRPC headers to be sent with the call.

Returns:

  • (::Hash{::Symbol=>::String}) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_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.

Returns:

  • (::Hash) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 896

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 ExperimentService 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_experiments`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :mutate_experiments
    ##
    # RPC-specific configuration for `end_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :end_experiment
    ##
    # RPC-specific configuration for `list_experiment_async_errors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_experiment_async_errors
    ##
    # RPC-specific configuration for `graduate_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :graduate_experiment
    ##
    # RPC-specific configuration for `schedule_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :schedule_experiment
    ##
    # RPC-specific configuration for `promote_experiment`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :promote_experiment

    # @private
    def initialize parent_rpcs = nil
      mutate_experiments_config = parent_rpcs.mutate_experiments if parent_rpcs.respond_to? :mutate_experiments
      @mutate_experiments = ::Gapic::Config::Method.new mutate_experiments_config
      end_experiment_config = parent_rpcs.end_experiment if parent_rpcs.respond_to? :end_experiment
      @end_experiment = ::Gapic::Config::Method.new end_experiment_config
      list_experiment_async_errors_config = parent_rpcs.list_experiment_async_errors if parent_rpcs.respond_to? :list_experiment_async_errors
      @list_experiment_async_errors = ::Gapic::Config::Method.new list_experiment_async_errors_config
      graduate_experiment_config = parent_rpcs.graduate_experiment if parent_rpcs.respond_to? :graduate_experiment
      @graduate_experiment = ::Gapic::Config::Method.new graduate_experiment_config
      schedule_experiment_config = parent_rpcs.schedule_experiment if parent_rpcs.respond_to? :schedule_experiment
      @schedule_experiment = ::Gapic::Config::Method.new schedule_experiment_config
      promote_experiment_config = parent_rpcs.promote_experiment if parent_rpcs.respond_to? :promote_experiment
      @promote_experiment = ::Gapic::Config::Method.new promote_experiment_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



929
930
931
932
933
934
935
 
# File 'lib/google/ads/google_ads/v14/services/experiment_service/client.rb', line 929

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