Class: Google::Cloud::Retail::V2::UserEventService::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/retail/v2/user_event_service/client.rb

Overview

Configuration class for the UserEventService API.

This class represents the configuration for UserEventService, 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
# write_user_event to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::Retail::V2::UserEventService::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.write_user_event.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::Retail::V2::UserEventService::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.write_user_event.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

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) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_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)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (GRPC::Core::Channel) a gRPC channel with included credentials
  • (GRPC::Core::ChannelCredentials) a gRPC credentails object
  • (nil) indicating no credentials

Returns:

  • (::Object) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String?

A custom service endpoint, as a hostname or hostname:port. The default is nil, indicating to use the default endpoint in the current universe domain.

Returns:

  • (::String, nil) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_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>) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#logger ⇒ ::Logger, ...

A custom logger to use for request/response debug logging, or the value :default (the default) to construct a default logger, or nil to explicitly disable logging.

Returns:

  • (::Logger, :default, nil) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_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}) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_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) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

#universe_domain ⇒ ::String?

The universe domain within which to make requests. This determines the default endpoint URL. The default value of nil uses the environment universe (usually the default "googleapis.com" universe).

Returns:

  • (::String, nil) 


862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
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
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 862

class Configuration
  extend ::Gapic::Config

  # @private
  # The endpoint specific to the default "googleapis.com" universe. Deprecated.
  DEFAULT_ENDPOINT = "retail.googleapis.com"

  config_attr :endpoint,      nil, ::String, nil
  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
  config_attr :universe_domain, nil, ::String, nil
  config_attr :logger, :default, ::Logger, nil, :default

  # @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 for the channel pool
  # @return [::Gapic::ServiceStub::ChannelPool::Configuration]
  #
  def channel_pool
    @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
  end

  ##
  # Configuration RPC class for the UserEventService 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 `write_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :write_user_event
    ##
    # RPC-specific configuration for `collect_user_event`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :collect_user_event
    ##
    # RPC-specific configuration for `purge_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :purge_user_events
    ##
    # RPC-specific configuration for `import_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_user_events
    ##
    # RPC-specific configuration for `rejoin_user_events`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :rejoin_user_events

    # @private
    def initialize parent_rpcs = nil
      write_user_event_config = parent_rpcs.write_user_event if parent_rpcs.respond_to? :write_user_event
      @write_user_event = ::Gapic::Config::Method.new write_user_event_config
      collect_user_event_config = parent_rpcs.collect_user_event if parent_rpcs.respond_to? :collect_user_event
      @collect_user_event = ::Gapic::Config::Method.new collect_user_event_config
      purge_user_events_config = parent_rpcs.purge_user_events if parent_rpcs.respond_to? :purge_user_events
      @purge_user_events = ::Gapic::Config::Method.new purge_user_events_config
      import_user_events_config = parent_rpcs.import_user_events if parent_rpcs.respond_to? :import_user_events
      @import_user_events = ::Gapic::Config::Method.new import_user_events_config
      rejoin_user_events_config = parent_rpcs.rejoin_user_events if parent_rpcs.respond_to? :rejoin_user_events
      @rejoin_user_events = ::Gapic::Config::Method.new rejoin_user_events_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#channel_pool ⇒ ::Gapic::ServiceStub::ChannelPool::Configuration

Configuration for the channel pool

Returns:

  • (::Gapic::ServiceStub::ChannelPool::Configuration) 


910
911
912
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 910

def channel_pool
  @channel_pool ||= ::Gapic::ServiceStub::ChannelPool::Configuration.new
end

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



898
899
900
901
902
903
904
 
# File 'lib/google/cloud/retail/v2/user_event_service/client.rb', line 898

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