Class: Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

Overview

The long-running operation metadata for BatchProcessDocuments.

Defined Under Namespace

Modules: State Classes: IndividualProcessStatus

Instance Attribute Summary collapse

Instance Attribute Details

#create_time ⇒ ::Google::Protobuf::Timestamp

Returns The creation time of the operation.

Returns:



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 341

class BatchProcessMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a each individual document in the batch process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source of the document, same as the
  #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
  #     field in the request when the batch process started.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status processing the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The Cloud Storage output destination (in the request as
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process isn't triggered, this field will be empty. It has
  #     the same response type and metadata as the long-running operation
  #     returned by the
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
  #     method.
  # @!attribute [rw] human_review_status
  #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
  #     The status of human review on the processed document.
  class IndividualProcessStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of the batch processing operation.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # Request operation is waiting for scheduling.
    WAITING = 1

    # Request is being processed.
    RUNNING = 2

    # The batch processing completed successfully.
    SUCCEEDED = 3

    # The batch processing was being cancelled.
    CANCELLING = 4

    # The batch processing was cancelled.
    CANCELLED = 5

    # The batch processing has failed.
    FAILED = 6
  end
end

#individual_process_statuses ⇒ ::Array<::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus>

Returns The list of response details of each document.

Returns:



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 341

class BatchProcessMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a each individual document in the batch process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source of the document, same as the
  #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
  #     field in the request when the batch process started.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status processing the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The Cloud Storage output destination (in the request as
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process isn't triggered, this field will be empty. It has
  #     the same response type and metadata as the long-running operation
  #     returned by the
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
  #     method.
  # @!attribute [rw] human_review_status
  #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
  #     The status of human review on the processed document.
  class IndividualProcessStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of the batch processing operation.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # Request operation is waiting for scheduling.
    WAITING = 1

    # Request is being processed.
    RUNNING = 2

    # The batch processing completed successfully.
    SUCCEEDED = 3

    # The batch processing was being cancelled.
    CANCELLING = 4

    # The batch processing was cancelled.
    CANCELLED = 5

    # The batch processing has failed.
    FAILED = 6
  end
end

#state ⇒ ::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::State

Returns The state of the current batch processing.

Returns:



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 341

class BatchProcessMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a each individual document in the batch process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source of the document, same as the
  #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
  #     field in the request when the batch process started.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status processing the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The Cloud Storage output destination (in the request as
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process isn't triggered, this field will be empty. It has
  #     the same response type and metadata as the long-running operation
  #     returned by the
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
  #     method.
  # @!attribute [rw] human_review_status
  #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
  #     The status of human review on the processed document.
  class IndividualProcessStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of the batch processing operation.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # Request operation is waiting for scheduling.
    WAITING = 1

    # Request is being processed.
    RUNNING = 2

    # The batch processing completed successfully.
    SUCCEEDED = 3

    # The batch processing was being cancelled.
    CANCELLING = 4

    # The batch processing was cancelled.
    CANCELLED = 5

    # The batch processing has failed.
    FAILED = 6
  end
end

#state_message ⇒ ::String

Returns A message providing more details about the current state of processing. For example, the error message if the operation is failed.

Returns:

  • (::String) —

    A message providing more details about the current state of processing. For example, the error message if the operation is failed.



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 341

class BatchProcessMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a each individual document in the batch process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source of the document, same as the
  #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
  #     field in the request when the batch process started.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status processing the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The Cloud Storage output destination (in the request as
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process isn't triggered, this field will be empty. It has
  #     the same response type and metadata as the long-running operation
  #     returned by the
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
  #     method.
  # @!attribute [rw] human_review_status
  #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
  #     The status of human review on the processed document.
  class IndividualProcessStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of the batch processing operation.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # Request operation is waiting for scheduling.
    WAITING = 1

    # Request is being processed.
    RUNNING = 2

    # The batch processing completed successfully.
    SUCCEEDED = 3

    # The batch processing was being cancelled.
    CANCELLING = 4

    # The batch processing was cancelled.
    CANCELLED = 5

    # The batch processing has failed.
    FAILED = 6
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp

Returns The last update time of the operation.

Returns:



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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 341

class BatchProcessMetadata
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The status of a each individual document in the batch process.
  # @!attribute [rw] input_gcs_source
  #   @return [::String]
  #     The source of the document, same as the
  #     {::Google::Cloud::DocumentAI::V1beta3::BatchProcessMetadata::IndividualProcessStatus#input_gcs_source input_gcs_source}
  #     field in the request when the batch process started.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status processing the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The Cloud Storage output destination (in the request as
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentOutputConfig::GcsOutputConfig#gcs_uri DocumentOutputConfig.GcsOutputConfig.gcs_uri})
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process isn't triggered, this field will be empty. It has
  #     the same response type and metadata as the long-running operation
  #     returned by the
  #     {::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client#review_document ReviewDocument}
  #     method.
  # @!attribute [rw] human_review_status
  #   @return [::Google::Cloud::DocumentAI::V1beta3::HumanReviewStatus]
  #     The status of human review on the processed document.
  class IndividualProcessStatus
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Possible states of the batch processing operation.
  module State
    # The default value. This value is used if the state is omitted.
    STATE_UNSPECIFIED = 0

    # Request operation is waiting for scheduling.
    WAITING = 1

    # Request is being processed.
    RUNNING = 2

    # The batch processing completed successfully.
    SUCCEEDED = 3

    # The batch processing was being cancelled.
    CANCELLING = 4

    # The batch processing was cancelled.
    CANCELLED = 5

    # The batch processing has failed.
    FAILED = 6
  end
end