Package com.google.cloud.documentai.v1

Class ReviewDocumentRequest

  • All Implemented Interfaces:
    ReviewDocumentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReviewDocumentRequest
extends com.google.protobuf.GeneratedMessageV3
implements ReviewDocumentRequestOrBuilder
     Request message for the
 [ReviewDocument][google.cloud.documentai.v1.DocumentProcessorService.ReviewDocument]
 method.
    Protobuf type google.cloud.documentai.v1.ReviewDocumentRequest
    See Also:
    Serialized Form

    • Field Detail

      • INLINE_DOCUMENT_FIELD_NUMBER

        public static final int INLINE_DOCUMENT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • HUMAN_REVIEW_CONFIG_FIELD_NUMBER

        public static final int HUMAN_REVIEW_CONFIG_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER

        public static final int ENABLE_SCHEMA_VALIDATION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • DOCUMENT_SCHEMA_FIELD_NUMBER

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

      • hasInlineDocument

        public boolean hasInlineDocument()
         An inline document proto.
        .google.cloud.documentai.v1.Document inline_document = 4;
        Specified by:
        hasInlineDocument in interface ReviewDocumentRequestOrBuilder
        Returns:
        Whether the inlineDocument field is set.

      • getHumanReviewConfig

        public String getHumanReviewConfig()
         Required. The resource name of the
 [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the
 document will be reviewed with.
        string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getHumanReviewConfig in interface ReviewDocumentRequestOrBuilder
        Returns:
        The humanReviewConfig.

      • getHumanReviewConfigBytes

        public com.google.protobuf.ByteString getHumanReviewConfigBytes()
         Required. The resource name of the
 [HumanReviewConfig][google.cloud.documentai.v1.HumanReviewConfig] that the
 document will be reviewed with.
        string human_review_config = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
        Specified by:
        getHumanReviewConfigBytes in interface ReviewDocumentRequestOrBuilder
        Returns:
        The bytes for humanReviewConfig.

      • getEnableSchemaValidation

        public boolean getEnableSchemaValidation()
         Whether the validation should be performed on the ad-hoc review request.
        bool enable_schema_validation = 3;
        Specified by:
        getEnableSchemaValidation in interface ReviewDocumentRequestOrBuilder
        Returns:
        The enableSchemaValidation.

      • getPriorityValue

        public int getPriorityValue()
         The priority of the human review task.
        .google.cloud.documentai.v1.ReviewDocumentRequest.Priority priority = 5;
        Specified by:
        getPriorityValue in interface ReviewDocumentRequestOrBuilder
        Returns:
        The enum numeric value on the wire for priority.

      • hasDocumentSchema

        public boolean hasDocumentSchema()
         The document schema of the human review task.
        .google.cloud.documentai.v1.DocumentSchema document_schema = 6;
        Specified by:
        hasDocumentSchema in interface ReviewDocumentRequestOrBuilder
        Returns:
        Whether the documentSchema field is set.

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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