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

Inherits:
Object
  • Object
show all
Includes:
Paths
Defined in:
lib/google/cloud/document_ai/v1beta3/document_service/client.rb

Overview

Client for the DocumentService service.

Service to call Cloud DocumentAI to manage document collection (dataset).

Defined Under Namespace

Classes: Configuration

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Paths

#dataset_path, #dataset_schema_path, #schema_path

Constructor Details

#initialize {|config| ... } ⇒ Client

Create a new DocumentService client object.

Examples:


# Create a client using the default configuration
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a client using a custom configuration
client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the DocumentService client.

Yield Parameters:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 110

def initialize
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "gapic/grpc"
  require "google/cloud/documentai/v1beta3/document_service_services_pb"

  # Create the configuration object
  @config = Configuration.new Client.configure

  # Yield the configuration if needed
  yield @config if block_given?

  # Create credentials
  credentials = @config.credentials
  # Use self-signed JWT if the endpoint is unchanged from default,
  # but only if the default endpoint does not have a region prefix.
  enable_self_signed_jwt = @config.endpoint == Configuration::DEFAULT_ENDPOINT &&
                           !@config.endpoint.split(".").first.include?("-")
  credentials ||= Credentials.default scope: @config.scope,
                                      enable_self_signed_jwt: enable_self_signed_jwt
  if credentials.is_a?(::String) || credentials.is_a?(::Hash)
    credentials = Credentials.new credentials, scope: @config.scope
  end
  @quota_project_id = @config.quota_project
  @quota_project_id ||= credentials.quota_project_id if credentials.respond_to? :quota_project_id

  @operations_client = Operations.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @location_client = Google::Cloud::Location::Locations::Client.new do |config|
    config.credentials = credentials
    config.quota_project = @quota_project_id
    config.endpoint = @config.endpoint
  end

  @document_service_stub = ::Gapic::ServiceStub.new(
    ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Stub,
    credentials:  credentials,
    endpoint:     @config.endpoint,
    channel_args: @config.channel_args,
    interceptors: @config.interceptors
  )
end

Instance Attribute Details

#location_client ⇒ Google::Cloud::Location::Locations::Client (readonly)

Get the associated client for mix-in of the Locations.

Returns:

  • (Google::Cloud::Location::Locations::Client) 


170
171
172
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 170

def location_client
  @location_client
end

#operations_client ⇒ ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Operations (readonly)

Get the associated client for long-running operations.

Returns:



163
164
165
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 163

def operations_client
  @operations_client
end

Class Method Details

.configure {|config| ... } ⇒ Client::Configuration

Configure the DocumentService Client class.

See Configuration for a description of the configuration fields.

Examples:


# Modify the configuration for all DocumentService clients
::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.configure do |config|
  config.timeout = 10.0
end

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 57

def self.configure
  @configure ||= begin
    namespace = ["Google", "Cloud", "DocumentAI", "V1beta3"]
    parent_config = while namespace.any?
                      parent_name = namespace.join "::"
                      parent_const = const_get parent_name
                      break parent_const.configure if parent_const.respond_to? :configure
                      namespace.pop
                    end
    default_config = Client::Configuration.new parent_config

    default_config
  end
  yield @configure if block_given?
  @configure
end

Instance Method Details

#batch_delete_documents(request, options = nil) ⇒ ::Gapic::Operation #batch_delete_documents(dataset: nil, dataset_documents: nil) ⇒ ::Gapic::Operation

Deletes a set of documents.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest.new

# Call the batch_delete_documents method.
result = client.batch_delete_documents request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #batch_delete_documents(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_delete_documents via a request object, either of type BatchDeleteDocumentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #batch_delete_documents(dataset: nil, dataset_documents: nil) ⇒ ::Gapic::Operation

    Pass arguments to batch_delete_documents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • dataset (::String) (defaults to: nil) —

      Required. The dataset resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset

    • dataset_documents (::Google::Cloud::DocumentAI::V1beta3::BatchDatasetDocuments, ::Hash) (defaults to: nil) —

      Required. Dataset documents input. If given filter, all documents satisfying the filter will be deleted. If given documentIds, a maximum of 50 documents can be deleted in a batch. The request will be rejected if more than 50 document_ids are provided.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 521

def batch_delete_documents request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::BatchDeleteDocumentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.batch_delete_documents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dataset
    header_params["dataset"] = request.dataset
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.batch_delete_documents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.batch_delete_documents.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :batch_delete_documents, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#configure {|config| ... } ⇒ Client::Configuration

Configure the DocumentService Client instance.

The configuration is set to the derived mode, meaning that values can be changed, but structural changes (adding new fields, etc.) are not allowed. Structural changes should be made on configure.

See Configuration for a description of the configuration fields.

Yields:

  • (config) —

    Configure the Client client.

Yield Parameters:

Returns:



89
90
91
92
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 89

def configure
  yield @config if block_given?
  @config
end

#get_dataset_schema(request, options = nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema #get_dataset_schema(name: nil, visible_fields_only: nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Gets the DatasetSchema of a Dataset.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::GetDatasetSchemaRequest.new

# Call the get_dataset_schema method.
result = client.get_dataset_schema request

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::DatasetSchema.
p result

Overloads:

  • #get_dataset_schema(request, options = nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

    Pass arguments to get_dataset_schema via a request object, either of type GetDatasetSchemaRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DocumentAI::V1beta3::GetDatasetSchemaRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_dataset_schema(name: nil, visible_fields_only: nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

    Pass arguments to get_dataset_schema via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • name (::String) (defaults to: nil) —

      Required. The dataset schema resource name. Format: projects/{project}/locations/{location}/processors/{processor}/dataset/datasetSchema

    • visible_fields_only (::Boolean) (defaults to: nil) —

      If set, only returns the visible fields of the schema.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 611

def get_dataset_schema request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::GetDatasetSchemaRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_dataset_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.name
    header_params["name"] = request.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_dataset_schema.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_dataset_schema.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :get_dataset_schema, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#get_document(request, options = nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse #get_document(dataset: nil, document_id: nil, read_mask: nil, page_range: nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

Returns relevant fields present in the requested document.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest.new

# Call the get_document method.
result = client.get_document request

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse.
p result

Overloads:

  • #get_document(request, options = nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

    Pass arguments to get_document via a request object, either of type GetDocumentRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #get_document(dataset: nil, document_id: nil, read_mask: nil, page_range: nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::GetDocumentResponse

    Pass arguments to get_document via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

    • dataset (::String) (defaults to: nil) —

      Required. The resource name of the dataset that the document belongs to . Format: projects/{project}/locations/{location}/processors/{processor}/dataset

    • document_id (::Google::Cloud::DocumentAI::V1beta3::DocumentId, ::Hash) (defaults to: nil) —

      Required. Document identifier.

    • read_mask (::Google::Protobuf::FieldMask, ::Hash) (defaults to: nil) —

      If set, only fields listed here will be returned. Otherwise, all fields will be returned by default.

    • page_range (::Google::Cloud::DocumentAI::V1beta3::DocumentPageRange, ::Hash) (defaults to: nil) —

      List of pages for which the fields specified in the read_mask must be served.

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 422

def get_document request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::GetDocumentRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.get_document.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dataset
    header_params["dataset"] = request.dataset
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.get_document.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.get_document.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :get_document, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#import_documents(request, options = nil) ⇒ ::Gapic::Operation #import_documents(dataset: nil, batch_documents_import_configs: nil) ⇒ ::Gapic::Operation

Import documents into a dataset.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest.new

# Call the import_documents method.
result = client.import_documents request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #import_documents(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to import_documents via a request object, either of type ImportDocumentsRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #import_documents(dataset: nil, batch_documents_import_configs: nil) ⇒ ::Gapic::Operation

    Pass arguments to import_documents via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 326

def import_documents request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::ImportDocumentsRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.import_documents.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dataset
    header_params["dataset"] = request.dataset
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.import_documents.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.import_documents.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :import_documents, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_dataset(request, options = nil) ⇒ ::Gapic::Operation #update_dataset(dataset: nil, update_mask: nil) ⇒ ::Gapic::Operation

Updates metadata associated with a dataset.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::UpdateDatasetRequest.new

# Call the update_dataset method.
result = client.update_dataset request

# The returned object is of type Gapic::Operation. You can use it to
# check the status of an operation, cancel it, or wait for results.
# Here is how to wait for a response.
result.wait_until_done! timeout: 60
if result.response?
  p result.response
else
  puts "No response received."
end

Overloads:

  • #update_dataset(request, options = nil) ⇒ ::Gapic::Operation

    Pass arguments to update_dataset via a request object, either of type UpdateDatasetRequest or an equivalent Hash.

    Parameters:

    • request (::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetRequest, ::Hash) —

      A request object representing the call parameters. Required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash.

    • options (::Gapic::CallOptions, ::Hash) (defaults to: nil) —

      Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.

  • #update_dataset(dataset: nil, update_mask: nil) ⇒ ::Gapic::Operation

    Pass arguments to update_dataset via keyword arguments. Note that at least one keyword argument is required. To specify no parameters, or to keep all the default parameter values, pass an empty Hash as a request object (see above).

    Parameters:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

  • response (::Gapic::Operation)
  • operation (::GRPC::ActiveCall::Operation)

Returns:

  • (::Gapic::Operation)

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 228

def update_dataset request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_dataset.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dataset&.name
    header_params["dataset.name"] = request.dataset.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_dataset.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_dataset.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :update_dataset, request, options: options do |response, operation|
    response = ::Gapic::Operation.new response, @operations_client, options: options
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end

#update_dataset_schema(request, options = nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema #update_dataset_schema(dataset_schema: nil, update_mask: nil) ⇒ ::Google::Cloud::DocumentAI::V1beta3::DatasetSchema

Updates a DatasetSchema.

Examples:

Basic example

require "google/cloud/document_ai/v1beta3"

# Create a client object. The client can be reused for multiple calls.
client = Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new

# Create a request. To set request fields, pass in keyword arguments.
request = Google::Cloud::DocumentAI::V1beta3::UpdateDatasetSchemaRequest.new

# Call the update_dataset_schema method.
result = client.update_dataset_schema request

# The returned object is of type Google::Cloud::DocumentAI::V1beta3::DatasetSchema.
p result

Overloads:

Yields:

  • (response, operation) —

    Access the result along with the RPC operation

Yield Parameters:

Returns:

Raises:

  • (::Google::Cloud::Error) —

    if the RPC is aborted.



699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
 
# File 'lib/google/cloud/document_ai/v1beta3/document_service/client.rb', line 699

def update_dataset_schema request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?

  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::DocumentAI::V1beta3::UpdateDatasetSchemaRequest

  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h

  # Customize the options with defaults
  metadata = @config.rpcs.update_dataset_schema.metadata.to_h

  # Set x-goog-api-client and x-goog-user-project headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::DocumentAI::V1beta3::VERSION
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id

  header_params = {}
  if request.dataset_schema&.name
    header_params["dataset_schema.name"] = request.dataset_schema.name
  end

  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header

  options.apply_defaults timeout:      @config.rpcs.update_dataset_schema.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.update_dataset_schema.retry_policy

  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy

  @document_service_stub.call_rpc :update_dataset_schema, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end