Class: Google::Cloud::DocumentAI::V1beta3::Document::Revision

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

Overview

Contains past or forward revisions of this document.

Defined Under Namespace

Classes: HumanReview

Instance Attribute Summary collapse

Instance Attribute Details

#agent ⇒ ::String

Returns If the change was made by a person specify the name or id of that person.

Returns:

  • (::String) —

    If the change was made by a person specify the name or id of that person.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

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

Returns The time that the revision was created.

Returns:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#human_review ⇒ ::Google::Cloud::DocumentAI::V1beta3::Document::Revision::HumanReview

Returns Human Review information of this revision.

Returns:



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#id ⇒ ::String

Returns Id of the revision. Unique within the context of the document.

Returns:

  • (::String) —

    Id of the revision. Unique within the context of the document.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent ⇒ ::Array<::Integer>

Returns The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

Returns:

  • (::Array<::Integer>) —

    The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#parent_ids ⇒ ::Array<::String>

Returns The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

Returns:

  • (::Array<::String>) —

    The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#processor ⇒ ::String

Returns If the annotation was made by processor identify the processor by its resource name.

Returns:

  • (::String) —

    If the annotation was made by processor identify the processor by its resource name.



863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
 
# File 'proto_docs/google/cloud/documentai/v1beta3/document.rb', line 863

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

  # Human Review information of the document.
  # @!attribute [rw] state
  #   @return [::String]
  #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
  # @!attribute [rw] state_message
  #   @return [::String]
  #     A message providing more details about the current state of processing.
  #     For example, the rejection reason when the state is `rejected`.
  class HumanReview
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end