Class: Google::Cloud::DocumentAI::V1beta3::ReviewDocumentOperationMetadata

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 review document method.

Defined Under Namespace

Modules: State

Instance Attribute Summary collapse

Instance Attribute Details

#common_metadata::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata

Returns The basic metadata of the long running operation.

Returns:



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
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 423

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#create_time::Google::Protobuf::Timestamp

Returns The creation time of the operation.

Returns:



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
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 423

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#state::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentOperationMetadata::State

Returns Used only when Operation.done is false.

Returns:



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
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 423

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  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.



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
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 423

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end

#update_time::Google::Protobuf::Timestamp

Returns The last update time of the operation.

Returns:



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
# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 423

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

  # State of the longrunning operation.
  module State
    # Unspecified state.
    STATE_UNSPECIFIED = 0

    # Operation is still running.
    RUNNING = 1

    # Operation is being cancelled.
    CANCELLING = 2

    # Operation succeeded.
    SUCCEEDED = 3

    # Operation failed.
    FAILED = 4

    # Operation is cancelled.
    CANCELLED = 5
  end
end