Package com.google.cloud.documentai.v1beta3

Class ProcessResponse

  • All Implemented Interfaces:
    ProcessResponseOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ProcessResponse
extends com.google.protobuf.GeneratedMessageV3
implements ProcessResponseOrBuilder
     Response message for the
 [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument]
 method.
    Protobuf type google.cloud.documentai.v1beta3.ProcessResponse
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ProcessResponse.Builder
      Response message for the [ProcessDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ProcessDocument] method.

      • 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 DOCUMENT_FIELD_NUMBER  
      static int HUMAN_REVIEW_OPERATION_FIELD_NUMBER  
      static int HUMAN_REVIEW_STATUS_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

      • HUMAN_REVIEW_OPERATION_FIELD_NUMBER

        public static final int HUMAN_REVIEW_OPERATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_REVIEW_STATUS_FIELD_NUMBER

        public static final int HUMAN_REVIEW_STATUS_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

      • hasDocument

        public boolean hasDocument()
         The document payload, will populate fields based on the processor's
 behavior.
        .google.cloud.documentai.v1beta3.Document document = 1;
        Specified by:
        hasDocument in interface ProcessResponseOrBuilder
        Returns:
        Whether the document field is set.

      • getDocument

        public Document getDocument()
         The document payload, will populate fields based on the processor's
 behavior.
        .google.cloud.documentai.v1beta3.Document document = 1;
        Specified by:
        getDocument in interface ProcessResponseOrBuilder
        Returns:
        The document.

      • getHumanReviewOperation

        @Deprecated
public String getHumanReviewOperation()
        Deprecated.
        google.cloud.documentai.v1beta3.ProcessResponse.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
         The name of the operation triggered by the processed document. If the human
 review process isn't triggered, this field is empty. It has the same
 response type and metadata as the long-running operation returned by
 [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument].
        string human_review_operation = 2 [deprecated = true];
        Specified by:
        getHumanReviewOperation in interface ProcessResponseOrBuilder
        Returns:
        The humanReviewOperation.

      • getHumanReviewOperationBytes

        @Deprecated
public com.google.protobuf.ByteString getHumanReviewOperationBytes()
        Deprecated.
        google.cloud.documentai.v1beta3.ProcessResponse.human_review_operation is deprecated. See google/cloud/documentai/v1beta3/document_processor_service.proto;l=451
         The name of the operation triggered by the processed document. If the human
 review process isn't triggered, this field is empty. It has the same
 response type and metadata as the long-running operation returned by
 [ReviewDocument][google.cloud.documentai.v1beta3.DocumentProcessorService.ReviewDocument].
        string human_review_operation = 2 [deprecated = true];
        Specified by:
        getHumanReviewOperationBytes in interface ProcessResponseOrBuilder
        Returns:
        The bytes for humanReviewOperation.

      • hasHumanReviewStatus

        public boolean hasHumanReviewStatus()
         The status of human review on the processed document.
        .google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 3;
        Specified by:
        hasHumanReviewStatus in interface ProcessResponseOrBuilder
        Returns:
        Whether the humanReviewStatus field is set.

      • getHumanReviewStatus

        public HumanReviewStatus getHumanReviewStatus()
         The status of human review on the processed document.
        .google.cloud.documentai.v1beta3.HumanReviewStatus human_review_status = 3;
        Specified by:
        getHumanReviewStatus in interface ProcessResponseOrBuilder
        Returns:
        The humanReviewStatus.

      • 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 ProcessResponse parseFrom​(ByteBuffer data)
                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • parser

        public static com.google.protobuf.Parser<ProcessResponse> parser()

      • getParserForType

        public com.google.protobuf.Parser<ProcessResponse> 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 ProcessResponse getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder