Package com.google.cloud.documentai.v1beta3

Class Document.Page.FormField

  • All Implemented Interfaces:
    Document.Page.FormFieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    Enclosing class:
    Document.Page
    public static final class Document.Page.FormField
extends com.google.protobuf.GeneratedMessageV3
implements Document.Page.FormFieldOrBuilder
     A form field detected on the page.
    Protobuf type google.cloud.documentai.v1beta3.Document.Page.FormField
    See Also:
    Serialized Form

    • Field Detail

      • FIELD_NAME_FIELD_NUMBER

        public static final int FIELD_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • FIELD_VALUE_FIELD_NUMBER

        public static final int FIELD_VALUE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NAME_DETECTED_LANGUAGES_FIELD_NUMBER

        public static final int NAME_DETECTED_LANGUAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALUE_DETECTED_LANGUAGES_FIELD_NUMBER

        public static final int VALUE_DETECTED_LANGUAGES_FIELD_NUMBER
        See Also:
        Constant Field Values

      • VALUE_TYPE_FIELD_NUMBER

        public static final int VALUE_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CORRECTED_KEY_TEXT_FIELD_NUMBER

        public static final int CORRECTED_KEY_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CORRECTED_VALUE_TEXT_FIELD_NUMBER

        public static final int CORRECTED_VALUE_TEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • PROVENANCE_FIELD_NUMBER

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

      • hasFieldName

        public boolean hasFieldName()
         [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1beta3.Document.Page.Layout field_name = 1;
        Specified by:
        hasFieldName in interface Document.Page.FormFieldOrBuilder
        Returns:
        Whether the fieldName field is set.

      • getFieldName

        public Document.Page.Layout getFieldName()
         [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1beta3.Document.Page.Layout field_name = 1;
        Specified by:
        getFieldName in interface Document.Page.FormFieldOrBuilder
        Returns:
        The fieldName.

      • getFieldNameOrBuilder

        public Document.Page.LayoutOrBuilder getFieldNameOrBuilder()
         [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1beta3.Document.Page.Layout field_name = 1;
        Specified by:
        getFieldNameOrBuilder in interface Document.Page.FormFieldOrBuilder

      • hasFieldValue

        public boolean hasFieldValue()
         [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 value.
        .google.cloud.documentai.v1beta3.Document.Page.Layout field_value = 2;
        Specified by:
        hasFieldValue in interface Document.Page.FormFieldOrBuilder
        Returns:
        Whether the fieldValue field is set.

      • getFieldValue

        public Document.Page.Layout getFieldValue()
         [Layout][google.cloud.documentai.v1beta3.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta3.Document.Page.FormField]
 value.
        .google.cloud.documentai.v1beta3.Document.Page.Layout field_value = 2;
        Specified by:
        getFieldValue in interface Document.Page.FormFieldOrBuilder
        Returns:
        The fieldValue.

      • getNameDetectedLanguagesCount

        public int getNameDetectedLanguagesCount()
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage name_detected_languages = 3;
        Specified by:
        getNameDetectedLanguagesCount in interface Document.Page.FormFieldOrBuilder

      • getValueDetectedLanguagesCount

        public int getValueDetectedLanguagesCount()
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1beta3.Document.Page.DetectedLanguage value_detected_languages = 4;
        Specified by:
        getValueDetectedLanguagesCount in interface Document.Page.FormFieldOrBuilder

      • getValueType

        public String getValueType()
         If the value is non-textual, this field represents the type. Current
 valid values are:

 - blank (this indicates the `field_value` is normal text)
 - `unfilled_checkbox`
 - `filled_checkbox`
        string value_type = 5;
        Specified by:
        getValueType in interface Document.Page.FormFieldOrBuilder
        Returns:
        The valueType.

      • getValueTypeBytes

        public com.google.protobuf.ByteString getValueTypeBytes()
         If the value is non-textual, this field represents the type. Current
 valid values are:

 - blank (this indicates the `field_value` is normal text)
 - `unfilled_checkbox`
 - `filled_checkbox`
        string value_type = 5;
        Specified by:
        getValueTypeBytes in interface Document.Page.FormFieldOrBuilder
        Returns:
        The bytes for valueType.

      • getCorrectedKeyText

        public String getCorrectedKeyText()
         Created for Labeling UI to export key text.
 If corrections were made to the text identified by the
 `field_name.text_anchor`, this field will contain the correction.
        string corrected_key_text = 6;
        Specified by:
        getCorrectedKeyText in interface Document.Page.FormFieldOrBuilder
        Returns:
        The correctedKeyText.

      • getCorrectedKeyTextBytes

        public com.google.protobuf.ByteString getCorrectedKeyTextBytes()
         Created for Labeling UI to export key text.
 If corrections were made to the text identified by the
 `field_name.text_anchor`, this field will contain the correction.
        string corrected_key_text = 6;
        Specified by:
        getCorrectedKeyTextBytes in interface Document.Page.FormFieldOrBuilder
        Returns:
        The bytes for correctedKeyText.

      • getCorrectedValueText

        public String getCorrectedValueText()
         Created for Labeling UI to export value text.
 If corrections were made to the text identified by the
 `field_value.text_anchor`, this field will contain the correction.
        string corrected_value_text = 7;
        Specified by:
        getCorrectedValueText in interface Document.Page.FormFieldOrBuilder
        Returns:
        The correctedValueText.

      • getCorrectedValueTextBytes

        public com.google.protobuf.ByteString getCorrectedValueTextBytes()
         Created for Labeling UI to export value text.
 If corrections were made to the text identified by the
 `field_value.text_anchor`, this field will contain the correction.
        string corrected_value_text = 7;
        Specified by:
        getCorrectedValueTextBytes in interface Document.Page.FormFieldOrBuilder
        Returns:
        The bytes for correctedValueText.

      • hasProvenance

        public boolean hasProvenance()
         The history of this annotation.
        .google.cloud.documentai.v1beta3.Document.Provenance provenance = 8;
        Specified by:
        hasProvenance in interface Document.Page.FormFieldOrBuilder
        Returns:
        Whether the provenance 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 Document.Page.FormField parseFrom​(ByteBuffer data)
                                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getParserForType

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