Package com.google.cloud.documentai.v1

Class Document.Page.FormField

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.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.GeneratedMessage implements Document.Page.FormFieldOrBuilder
 A form field detected on the page.
Protobuf type google.cloud.documentai.v1.Document.Page.FormField
See Also:

  • Field Details

    • FIELD_NAME_FIELD_NUMBER

      public static final int FIELD_NAME_FIELD_NUMBER
      See Also:

    • FIELD_VALUE_FIELD_NUMBER

      public static final int FIELD_VALUE_FIELD_NUMBER
      See Also:

    • NAME_DETECTED_LANGUAGES_FIELD_NUMBER

      public static final int NAME_DETECTED_LANGUAGES_FIELD_NUMBER
      See Also:

    • VALUE_DETECTED_LANGUAGES_FIELD_NUMBER

      public static final int VALUE_DETECTED_LANGUAGES_FIELD_NUMBER
      See Also:

    • VALUE_TYPE_FIELD_NUMBER

      public static final int VALUE_TYPE_FIELD_NUMBER
      See Also:

    • CORRECTED_KEY_TEXT_FIELD_NUMBER

      public static final int CORRECTED_KEY_TEXT_FIELD_NUMBER
      See Also:

    • CORRECTED_VALUE_TEXT_FIELD_NUMBER

      public static final int CORRECTED_VALUE_TEXT_FIELD_NUMBER
      See Also:

    • PROVENANCE_FIELD_NUMBER

      public static final int PROVENANCE_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasFieldName

      public boolean hasFieldName()
       [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 For example, `Address`, `Email`, `Grand total`, `Phone number`, etc.
      .google.cloud.documentai.v1.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.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 For example, `Address`, `Email`, `Grand total`, `Phone number`, etc.
      .google.cloud.documentai.v1.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.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 For example, `Address`, `Email`, `Grand total`, `Phone number`, etc.
      .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;
      Specified by:
      getFieldNameOrBuilder in interface Document.Page.FormFieldOrBuilder

    • hasFieldValue

      public boolean hasFieldValue()
       [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] value.
      .google.cloud.documentai.v1.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.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] value.
      .google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
      Specified by:
      getFieldValue in interface Document.Page.FormFieldOrBuilder
      Returns:
      The fieldValue.

    • getFieldValueOrBuilder

      public Document.Page.LayoutOrBuilder getFieldValueOrBuilder()
       [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] value.
      .google.cloud.documentai.v1.Document.Page.Layout field_value = 2;
      Specified by:
      getFieldValueOrBuilder in interface Document.Page.FormFieldOrBuilder

    • getNameDetectedLanguagesList

      public List<Document.Page.DetectedLanguage> getNameDetectedLanguagesList()
       A list of detected languages for name together with confidence.
      repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;
      Specified by:
      getNameDetectedLanguagesList in interface Document.Page.FormFieldOrBuilder

    • getNameDetectedLanguagesOrBuilderList

      public List<? extends Document.Page.DetectedLanguageOrBuilder> getNameDetectedLanguagesOrBuilderList()
       A list of detected languages for name together with confidence.
      repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;
      Specified by:
      getNameDetectedLanguagesOrBuilderList in interface Document.Page.FormFieldOrBuilder

    • getNameDetectedLanguagesCount

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

    • getNameDetectedLanguages

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

    • getNameDetectedLanguagesOrBuilder

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

    • getValueDetectedLanguagesList

      public List<Document.Page.DetectedLanguage> getValueDetectedLanguagesList()
       A list of detected languages for value together with confidence.
      repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;
      Specified by:
      getValueDetectedLanguagesList in interface Document.Page.FormFieldOrBuilder

    • getValueDetectedLanguagesOrBuilderList

      public List<? extends Document.Page.DetectedLanguageOrBuilder> getValueDetectedLanguagesOrBuilderList()
       A list of detected languages for value together with confidence.
      repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;
      Specified by:
      getValueDetectedLanguagesOrBuilderList in interface Document.Page.FormFieldOrBuilder

    • getValueDetectedLanguagesCount

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

    • getValueDetectedLanguages

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

    • getValueDetectedLanguagesOrBuilder

      public Document.Page.DetectedLanguageOrBuilder getValueDetectedLanguagesOrBuilder(int index)
       A list of detected languages for value together with confidence.
      repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;
      Specified by:
      getValueDetectedLanguagesOrBuilder 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.v1.Document.Provenance provenance = 8;
      Specified by:
      hasProvenance in interface Document.Page.FormFieldOrBuilder
      Returns:
      Whether the provenance field is set.

    • getProvenance

      public Document.Provenance getProvenance()
       The history of this annotation.
      .google.cloud.documentai.v1.Document.Provenance provenance = 8;
      Specified by:
      getProvenance in interface Document.Page.FormFieldOrBuilder
      Returns:
      The provenance.

    • getProvenanceOrBuilder

      public Document.ProvenanceOrBuilder getProvenanceOrBuilder()
       The history of this annotation.
      .google.cloud.documentai.v1.Document.Provenance provenance = 8;
      Specified by:
      getProvenanceOrBuilder in interface Document.Page.FormFieldOrBuilder

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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

    • parseFrom

      public static Document.Page.FormField parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Page.FormField parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.Page.FormField parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document.Page.FormField parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Page.FormField parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Document.Page.FormField parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • 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

    • newBuilder

      public static Document.Page.FormField.Builder newBuilder()

    • newBuilder

      public static Document.Page.FormField.Builder newBuilder(Document.Page.FormField prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Document.Page.FormField getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Document.Page.FormField> parser()

    • 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.GeneratedMessage

    • getDefaultInstanceForType

      public Document.Page.FormField getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder