Package com.google.cloud.documentai.v1

Class HumanReviewStatus

  • All Implemented Interfaces:
    HumanReviewStatusOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class HumanReviewStatus
extends com.google.protobuf.GeneratedMessageV3
implements HumanReviewStatusOrBuilder
     The status of human review on a processed document.
    Protobuf type google.cloud.documentai.v1.HumanReviewStatus
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  HumanReviewStatus.Builder
      The status of human review on a processed document.
      static class  HumanReviewStatus.State
      The final state of human review on a processed document.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int HUMAN_REVIEW_OPERATION_FIELD_NUMBER  
      static int STATE_FIELD_NUMBER  
      static int STATE_MESSAGE_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Field Detail

      • STATE_MESSAGE_FIELD_NUMBER

        public static final int STATE_MESSAGE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_REVIEW_OPERATION_FIELD_NUMBER

        public static final int HUMAN_REVIEW_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getStateValue

        public int getStateValue()
         The state of human review on the processing request.
        .google.cloud.documentai.v1.HumanReviewStatus.State state = 1;
        Specified by:
        getStateValue in interface HumanReviewStatusOrBuilder
        Returns:
        The enum numeric value on the wire for state.

      • getStateMessage

        public String getStateMessage()
         A message providing more details about the human review state.
        string state_message = 2;
        Specified by:
        getStateMessage in interface HumanReviewStatusOrBuilder
        Returns:
        The stateMessage.

      • getStateMessageBytes

        public com.google.protobuf.ByteString getStateMessageBytes()
         A message providing more details about the human review state.
        string state_message = 2;
        Specified by:
        getStateMessageBytes in interface HumanReviewStatusOrBuilder
        Returns:
        The bytes for stateMessage.

      • getHumanReviewOperation

        public String getHumanReviewOperation()
         The name of the operation triggered by the processed document. This field
 is populated only when the
 [state][google.cloud.documentai.v1.HumanReviewStatus.state] is
 `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as
 the long-running operation returned by
 [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument].
        string human_review_operation = 3;
        Specified by:
        getHumanReviewOperation in interface HumanReviewStatusOrBuilder
        Returns:
        The humanReviewOperation.

      • getHumanReviewOperationBytes

        public com.google.protobuf.ByteString getHumanReviewOperationBytes()
         The name of the operation triggered by the processed document. This field
 is populated only when the
 [state][google.cloud.documentai.v1.HumanReviewStatus.state] is
 `HUMAN_REVIEW_IN_PROGRESS`. It has the same response type and metadata as
 the long-running operation returned by
 [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument].
        string human_review_operation = 3;
        Specified by:
        getHumanReviewOperationBytes in interface HumanReviewStatusOrBuilder
        Returns:
        The bytes for humanReviewOperation.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static HumanReviewStatus parseFrom​(ByteBuffer data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(ByteBuffer data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(com.google.protobuf.ByteString data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(com.google.protobuf.ByteString data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(byte[] data)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(byte[] data,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static HumanReviewStatus parseFrom​(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
        Throws:
        IOException

      • newBuilderForType

        public HumanReviewStatus.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public HumanReviewStatus.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected HumanReviewStatus.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<HumanReviewStatus> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public HumanReviewStatus getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder