Class: Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client::Configuration

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

Overview

Configuration class for the DocumentProcessorService API.

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

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

Defined Under Namespace

Classes: Rpcs

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#channel_args ⇒ ::Hash

Extra parameters passed to the gRPC channel. Note: this is ignored if a GRPC::Core::Channel object is provided as the credential.

Returns:

  • (::Hash) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_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) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_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) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_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>) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

#lib_name ⇒ ::String

The library name as recorded in instrumentation and logging

Returns:

  • (::String) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

#lib_version ⇒ ::String

The library version as recorded in instrumentation and logging

Returns:

  • (::String) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_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}) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

#quota_project ⇒ ::String

A separate project against which to charge quota.

Returns:

  • (::String) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_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) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

#scope ⇒ ::Array<::String>

The OAuth scopes

Returns:

  • (::Array<::String>) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

#timeout ⇒ ::Numeric

The call timeout in seconds.

Returns:

  • (::Numeric) 


1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1115

class Configuration
  extend ::Gapic::Config

  config_attr :endpoint,      "documentai.googleapis.com", ::String
  config_attr :credentials,   nil do |value|
    allowed = [::String, ::Hash, ::Proc, ::Symbol, ::Google::Auth::Credentials, ::Signet::OAuth2::Client, nil]
    allowed += [::GRPC::Core::Channel, ::GRPC::Core::ChannelCredentials] if defined? ::GRPC
    allowed.any? { |klass| klass === value }
  end
  config_attr :scope,         nil, ::String, ::Array, nil
  config_attr :lib_name,      nil, ::String, nil
  config_attr :lib_version,   nil, ::String, nil
  config_attr(:channel_args,  { "grpc.service_config_disable_resolution" => 1 }, ::Hash, nil)
  config_attr :interceptors,  nil, ::Array, nil
  config_attr :timeout,       nil, ::Numeric, nil
  config_attr :metadata,      nil, ::Hash, nil
  config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
  config_attr :quota_project, nil, ::String, nil

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

    yield self if block_given?
  end

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

  ##
  # Configuration RPC class for the DocumentProcessorService API.
  #
  # Includes fields providing the configuration for each RPC in this service.
  # Each configuration object is of type `Gapic::Config::Method` and includes
  # the following configuration fields:
  #
  #  *  `timeout` (*type:* `Numeric`) - The call timeout in seconds
  #  *  `metadata` (*type:* `Hash{Symbol=>String}`) - Additional gRPC headers
  #  *  `retry_policy (*type:* `Hash`) - The retry policy. The policy fields
  #     include the following keys:
  #      *  `:initial_delay` (*type:* `Numeric`) - The initial delay in seconds.
  #      *  `:max_delay` (*type:* `Numeric`) - The max delay in seconds.
  #      *  `:multiplier` (*type:* `Numeric`) - The incremental backoff multiplier.
  #      *  `:retry_codes` (*type:* `Array<String>`) - The error codes that should
  #         trigger a retry.
  #
  class Rpcs
    ##
    # RPC-specific configuration for `process_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :process_document
    ##
    # RPC-specific configuration for `batch_process_documents`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :batch_process_documents
    ##
    # RPC-specific configuration for `fetch_processor_types`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :fetch_processor_types
    ##
    # RPC-specific configuration for `list_processors`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :list_processors
    ##
    # RPC-specific configuration for `create_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :create_processor
    ##
    # RPC-specific configuration for `delete_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :delete_processor
    ##
    # RPC-specific configuration for `enable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :enable_processor
    ##
    # RPC-specific configuration for `disable_processor`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :disable_processor
    ##
    # RPC-specific configuration for `review_document`
    # @return [::Gapic::Config::Method]
    #
    attr_reader :review_document

    # @private
    def initialize parent_rpcs = nil
      process_document_config = parent_rpcs.process_document if parent_rpcs.respond_to? :process_document
      @process_document = ::Gapic::Config::Method.new process_document_config
      batch_process_documents_config = parent_rpcs.batch_process_documents if parent_rpcs.respond_to? :batch_process_documents
      @batch_process_documents = ::Gapic::Config::Method.new batch_process_documents_config
      fetch_processor_types_config = parent_rpcs.fetch_processor_types if parent_rpcs.respond_to? :fetch_processor_types
      @fetch_processor_types = ::Gapic::Config::Method.new fetch_processor_types_config
      list_processors_config = parent_rpcs.list_processors if parent_rpcs.respond_to? :list_processors
      @list_processors = ::Gapic::Config::Method.new list_processors_config
      create_processor_config = parent_rpcs.create_processor if parent_rpcs.respond_to? :create_processor
      @create_processor = ::Gapic::Config::Method.new create_processor_config
      delete_processor_config = parent_rpcs.delete_processor if parent_rpcs.respond_to? :delete_processor
      @delete_processor = ::Gapic::Config::Method.new delete_processor_config
      enable_processor_config = parent_rpcs.enable_processor if parent_rpcs.respond_to? :enable_processor
      @enable_processor = ::Gapic::Config::Method.new enable_processor_config
      disable_processor_config = parent_rpcs.disable_processor if parent_rpcs.respond_to? :disable_processor
      @disable_processor = ::Gapic::Config::Method.new disable_processor_config
      review_document_config = parent_rpcs.review_document if parent_rpcs.respond_to? :review_document
      @review_document = ::Gapic::Config::Method.new review_document_config

      yield self if block_given?
    end
  end
end

Instance Method Details

#rpcs ⇒ Rpcs

Configurations for individual RPCs

Returns:



1145
1146
1147
1148
1149
1150
1151
 
# File 'lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb', line 1145

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