Class: Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client::Configuration

Inherits:
Object
  • Object
show all
Extended by:
Gapic::Config
Defined in:
lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb

Overview

Configuration class for the DocumentService REST API.

This class represents the configuration for DocumentService REST, 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
# update_dataset to 20 seconds,
# and all remaining timeouts to 10 seconds.
::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client.configure do |config|
  config.timeout = 10.0
  config.rpcs.update_dataset.timeout = 20.0
end

# Apply the above configuration only to a new client.
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Rest::Client.new do |config|
  config.timeout = 10.0
  config.rpcs.update_dataset.timeout = 20.0
end

Defined Under Namespace

Classes: Rpcs

Constant Summary collapse

DEFAULT_ENDPOINT = 
"documentai.googleapis.com"

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#credentials ⇒ ::Object

Credentials to send with calls. You may provide any of the following types:

  • (String) The path to a service account key file in JSON format
  • (Hash) A service account key as a Hash
  • (Google::Auth::Credentials) A googleauth credentials object (see the googleauth docs)
  • (Signet::OAuth2::Client) A signet oauth2 client object (see the signet docs)
  • (nil) indicating no credentials

Returns:

  • (::Object) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#endpoint ⇒ ::String

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

Returns:

  • (::String) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

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

Additional headers to be sent with the call.

Returns:

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


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_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) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


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
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
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 888

class Configuration
  extend ::Gapic::Config

  DEFAULT_ENDPOINT = "documentai.googleapis.com"

  config_attr :endpoint,      DEFAULT_ENDPOINT, ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

  # @private
  # Overrides for http bindings for the RPCs of this service
  # are only used when this service is used as mixin, and only
  # by the host service.
  # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
  config_attr :bindings_override, {}, ::Hash, nil

  # @private
  def initialize parent_config = nil
    @parent_config = parent_config unless parent_config.nil?

    yield self if block_given?
  end

  ##
  # Configurations for individual RPCs
  # @return [Rpcs]
  #
  def rpcs
    @rpcs ||= begin
      parent_rpcs = nil
      parent_rpcs = @parent_config.rpcs if defined?(@parent_config) && @parent_config.respond_to?(:rpcs)
      Rpcs.new parent_rpcs
    end
  end

  ##
  # Configuration RPC class for the DocumentService 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 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 `update_dataset`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset
    ##
    # RPC-specific configuration for `import_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :import_documents
    ##
    # RPC-specific configuration for `get_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_document
    ##
    # RPC-specific configuration for `list_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_documents
    ##
    # RPC-specific configuration for `batch_delete_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_delete_documents
    ##
    # RPC-specific configuration for `get_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :get_dataset_schema
    ##
    # RPC-specific configuration for `update_dataset_schema`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :update_dataset_schema

    # @private
    def initialize parent_rpcs = nil
      update_dataset_config = parent_rpcs.update_dataset if parent_rpcs.respond_to? :update_dataset
      @update_dataset = ::Gapic::Config::Method.new update_dataset_config
      import_documents_config = parent_rpcs.import_documents if parent_rpcs.respond_to? :import_documents
      @import_documents = ::Gapic::Config::Method.new import_documents_config
      get_document_config = parent_rpcs.get_document if parent_rpcs.respond_to? :get_document
      @get_document = ::Gapic::Config::Method.new get_document_config
      list_documents_config = parent_rpcs.list_documents if parent_rpcs.respond_to? :list_documents
      @list_documents = ::Gapic::Config::Method.new list_documents_config
      batch_delete_documents_config = parent_rpcs.batch_delete_documents if parent_rpcs.respond_to? :batch_delete_documents
      @batch_delete_documents = ::Gapic::Config::Method.new batch_delete_documents_config
      get_dataset_schema_config = parent_rpcs.get_dataset_schema if parent_rpcs.respond_to? :get_dataset_schema
      @get_dataset_schema = ::Gapic::Config::Method.new get_dataset_schema_config
      update_dataset_schema_config = parent_rpcs.update_dataset_schema if parent_rpcs.respond_to? :update_dataset_schema
      @update_dataset_schema = ::Gapic::Config::Method.new update_dataset_schema_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



924
925
926
927
928
929
930
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/rest/client.rb', line 924

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