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 batch process method.

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:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 175

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 [input_gcs_source] field in the
  #     request when the batch process started. The batch process is started by
  #     take snapshot of that document, since a user can move or change that
  #     document during the process.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the processing of the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The output_gcs_destination (in the request as 'output_gcs_destination')
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process is not triggered, this field will be empty. It has
  #     the same response type and metadata as the long running operation
  #     returned by 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:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 175

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 [input_gcs_source] field in the
  #     request when the batch process started. The batch process is started by
  #     take snapshot of that document, since a user can move or change that
  #     document during the process.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the processing of the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The output_gcs_destination (in the request as 'output_gcs_destination')
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process is not triggered, this field will be empty. It has
  #     the same response type and metadata as the long running operation
  #     returned by 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:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 175

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 [input_gcs_source] field in the
  #     request when the batch process started. The batch process is started by
  #     take snapshot of that document, since a user can move or change that
  #     document during the process.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the processing of the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The output_gcs_destination (in the request as 'output_gcs_destination')
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process is not triggered, this field will be empty. It has
  #     the same response type and metadata as the long running operation
  #     returned by 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.



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 175

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 [input_gcs_source] field in the
  #     request when the batch process started. The batch process is started by
  #     take snapshot of that document, since a user can move or change that
  #     document during the process.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the processing of the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The output_gcs_destination (in the request as 'output_gcs_destination')
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process is not triggered, this field will be empty. It has
  #     the same response type and metadata as the long running operation
  #     returned by 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:



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 175

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 [input_gcs_source] field in the
  #     request when the batch process started. The batch process is started by
  #     take snapshot of that document, since a user can move or change that
  #     document during the process.
  # @!attribute [rw] status
  #   @return [::Google::Rpc::Status]
  #     The status of the processing of the document.
  # @!attribute [rw] output_gcs_destination
  #   @return [::String]
  #     The output_gcs_destination (in the request as 'output_gcs_destination')
  #     of the processed document if it was successful, otherwise empty.
  # @!attribute [rw] human_review_operation
  #   @return [::String]
  #     The name of the operation triggered by the processed document. If the
  #     human review process is not triggered, this field will be empty. It has
  #     the same response type and metadata as the long running operation
  #     returned by 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