Class: Google::Cloud::DocumentAI::V1::Document::Revision

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/documentai/v1/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.

Note: The following fields are mutually exclusive: agent, processor. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

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

    Note: The following fields are mutually exclusive: agent, processor. If a field in that set is populated, all other fields in the set will automatically be cleared.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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, internally generated by doc proto storage at the time of create.

Returns:



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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::V1::Document::Revision::HumanReview

Returns Human Review information of this revision.

Returns:



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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, internally generated by doc proto storage. Unique within the context of the document.

Returns:

  • (::String) —

    Id of the revision, internally generated by doc proto storage. Unique within the context of the document.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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>

Deprecated.

This field is deprecated and may be removed in the next major version update.

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.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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.

Note: The following fields are mutually exclusive: processor, agent. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns:

  • (::String) —

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

    Note: The following fields are mutually exclusive: processor, agent. If a field in that set is populated, all other fields in the set will automatically be cleared.



1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
 
# File 'proto_docs/google/cloud/documentai/v1/document.rb', line 1036

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