Class: Google::Cloud::Dialogflow::V2::Agents::Client::Configuration

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

Overview

Configuration class for the Agents API.

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

To modify the global config, setting the timeout for get_agent to 20 seconds, and all remaining timeouts to 10 seconds:

Google::Cloud::Dialogflow::V2::Agents::Client.configure do |config|
  config.timeout = 10_000
  config.rpcs.get_agent.timeout = 20_000
end

To apply the above configuration only to a new client:

client = Google::Cloud::Dialogflow::V2::Agents::Client.new do |config|
  config.timeout = 10_000
  config.rpcs.get_agent.timeout = 20_000
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) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_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) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ String

The hostname or hostname:port of the service endpoint. Defaults to "dialogflow.googleapis.com".

Returns:

  • (String) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_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>) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ String

The library name as recorded in instrumentation and logging

Returns:

  • (String) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ String

The library version as recorded in instrumentation and logging

Returns:

  • (String) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_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}) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_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) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

#scope ⇒ Array<String>

The OAuth scopes

Returns:

  • (Array<String>) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ Numeric

The call timeout in milliseconds.

Returns:

  • (Numeric) 


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
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 936

class Configuration
  extend Gapic::Config

  config_attr :endpoint,     "dialogflow.googleapis.com", String
  config_attr :credentials,  nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::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

  # @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 @parent_config&.respond_to? :rpcs
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the Agents 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 milliseconds
  #  *  `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 `get_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_agent
    ##
    # RPC-specific configuration for `set_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :set_agent
    ##
    # RPC-specific configuration for `delete_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :delete_agent
    ##
    # RPC-specific configuration for `search_agents`
    # @return [Gapic::Config::Method]
    #
    attr_reader :search_agents
    ##
    # RPC-specific configuration for `train_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :train_agent
    ##
    # RPC-specific configuration for `export_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :export_agent
    ##
    # RPC-specific configuration for `import_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :import_agent
    ##
    # RPC-specific configuration for `restore_agent`
    # @return [Gapic::Config::Method]
    #
    attr_reader :restore_agent
    ##
    # RPC-specific configuration for `get_validation_result`
    # @return [Gapic::Config::Method]
    #
    attr_reader :get_validation_result

    # @private
    def initialize parent_rpcs = nil
      get_agent_config = parent_rpcs&.get_agent if parent_rpcs&.respond_to? :get_agent
      @get_agent = Gapic::Config::Method.new get_agent_config
      set_agent_config = parent_rpcs&.set_agent if parent_rpcs&.respond_to? :set_agent
      @set_agent = Gapic::Config::Method.new set_agent_config
      delete_agent_config = parent_rpcs&.delete_agent if parent_rpcs&.respond_to? :delete_agent
      @delete_agent = Gapic::Config::Method.new delete_agent_config
      search_agents_config = parent_rpcs&.search_agents if parent_rpcs&.respond_to? :search_agents
      @search_agents = Gapic::Config::Method.new search_agents_config
      train_agent_config = parent_rpcs&.train_agent if parent_rpcs&.respond_to? :train_agent
      @train_agent = Gapic::Config::Method.new train_agent_config
      export_agent_config = parent_rpcs&.export_agent if parent_rpcs&.respond_to? :export_agent
      @export_agent = Gapic::Config::Method.new export_agent_config
      import_agent_config = parent_rpcs&.import_agent if parent_rpcs&.respond_to? :import_agent
      @import_agent = Gapic::Config::Method.new import_agent_config
      restore_agent_config = parent_rpcs&.restore_agent if parent_rpcs&.respond_to? :restore_agent
      @restore_agent = Gapic::Config::Method.new restore_agent_config
      get_validation_result_config = parent_rpcs&.get_validation_result if parent_rpcs&.respond_to? :get_validation_result
      @get_validation_result = Gapic::Config::Method.new get_validation_result_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



965
966
967
968
969
970
971
 
# File 'lib/google/cloud/dialogflow/v2/agents/client.rb', line 965

def rpcs
  @rpcs ||= begin
    parent_rpcs = nil
    parent_rpcs = @parent_config.rpcs if @parent_config&.respond_to? :rpcs
    Rpcs.new parent_rpcs
  end
end