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

Inherits:

Object

• Object
• Google::Cloud::DocumentAI::V1beta3::ReviewDocumentOperationMetadata

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

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

  The basic metadata of the long running operation.

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

  The creation time of the operation.

• #question_id ⇒ ::String

  The question ID.

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

  Used only when Operation.done is false.

• #state_message ⇒ ::String

  A message providing more details about the current state of processing.

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

  The last update time of the operation.

Instance Attribute Details

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

Returns The basic metadata of the long running operation.

Returns:

• (::Google::Cloud::DocumentAI::V1beta3::CommonOperationMetadata) —

  The basic metadata of the long running operation.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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:

• (::Google::Protobuf::Timestamp) —

  The creation time of the operation.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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

#question_id ⇒ ::String

Returns The question ID.

Returns:

• (::String) —

  The question ID.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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:

• (::Google::Cloud::DocumentAI::V1beta3::ReviewDocumentOperationMetadata::State) —

  Used only when Operation.done is false.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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:

• (::Google::Protobuf::Timestamp) —

  The last update time of the operation.

# File 'proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb', line 426

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