Package com.google.cloud.documentai.v1

Class Document.Page.FormField.Builder

    • Method Detail

      • 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.Builder<Document.Page.FormField.Builder>

      • clear

        public Document.Page.FormField.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • getDefaultInstanceForType

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

      • build

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

      • buildPartial

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

      • clone

        public Document.Page.FormField.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • clearField

        public Document.Page.FormField.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • clearOneof

        public Document.Page.FormField.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • setRepeatedField

        public Document.Page.FormField.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        int index,
                                                        Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • addRepeatedField

        public Document.Page.FormField.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                        Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • mergeFrom

        public Document.Page.FormField.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                          throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Page.FormField.Builder>
        Throws:
        IOException

      • hasFieldName

        public boolean hasFieldName()
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `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.
 e.g. `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.

      • setFieldName

        public Document.Page.FormField.Builder setFieldName​(Document.Page.Layout value)
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;

      • setFieldName

        public Document.Page.FormField.Builder setFieldName​(Document.Page.Layout.Builder builderForValue)
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;

      • mergeFieldName

        public Document.Page.FormField.Builder mergeFieldName​(Document.Page.Layout value)
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;

      • clearFieldName

        public Document.Page.FormField.Builder clearFieldName()
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;

      • getFieldNameBuilder

        public Document.Page.Layout.Builder getFieldNameBuilder()
         [Layout][google.cloud.documentai.v1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1.Document.Page.FormField] name.
 e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
        .google.cloud.documentai.v1.Document.Page.Layout field_name = 1;

      • 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.
 e.g. `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.

      • setFieldValue

        public Document.Page.FormField.Builder setFieldValue​(Document.Page.Layout value)
         [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;

      • setFieldValue

        public Document.Page.FormField.Builder setFieldValue​(Document.Page.Layout.Builder builderForValue)
         [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;

      • mergeFieldValue

        public Document.Page.FormField.Builder mergeFieldValue​(Document.Page.Layout value)
         [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;

      • clearFieldValue

        public Document.Page.FormField.Builder clearFieldValue()
         [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;

      • getFieldValueBuilder

        public Document.Page.Layout.Builder getFieldValueBuilder()
         [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;

      • 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

      • setNameDetectedLanguages

        public Document.Page.FormField.Builder setNameDetectedLanguages​(int index,
                                                                Document.Page.DetectedLanguage value)
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • addNameDetectedLanguages

        public Document.Page.FormField.Builder addNameDetectedLanguages​(int index,
                                                                Document.Page.DetectedLanguage value)
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • clearNameDetectedLanguages

        public Document.Page.FormField.Builder clearNameDetectedLanguages()
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • removeNameDetectedLanguages

        public Document.Page.FormField.Builder removeNameDetectedLanguages​(int index)
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • getNameDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder getNameDetectedLanguagesBuilder​(int index)
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • addNameDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder addNameDetectedLanguagesBuilder()
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • addNameDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder addNameDetectedLanguagesBuilder​(int index)
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • getNameDetectedLanguagesBuilderList

        public List<Document.Page.DetectedLanguage.Builder> getNameDetectedLanguagesBuilderList()
         A list of detected languages for name together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage name_detected_languages = 3;

      • 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

      • setValueDetectedLanguages

        public Document.Page.FormField.Builder setValueDetectedLanguages​(int index,
                                                                 Document.Page.DetectedLanguage value)
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • addValueDetectedLanguages

        public Document.Page.FormField.Builder addValueDetectedLanguages​(int index,
                                                                 Document.Page.DetectedLanguage value)
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • clearValueDetectedLanguages

        public Document.Page.FormField.Builder clearValueDetectedLanguages()
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • removeValueDetectedLanguages

        public Document.Page.FormField.Builder removeValueDetectedLanguages​(int index)
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • getValueDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder getValueDetectedLanguagesBuilder​(int index)
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • addValueDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder addValueDetectedLanguagesBuilder()
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • addValueDetectedLanguagesBuilder

        public Document.Page.DetectedLanguage.Builder addValueDetectedLanguagesBuilder​(int index)
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

      • getValueDetectedLanguagesBuilderList

        public List<Document.Page.DetectedLanguage.Builder> getValueDetectedLanguagesBuilderList()
         A list of detected languages for value together with confidence.
        repeated .google.cloud.documentai.v1.Document.Page.DetectedLanguage value_detected_languages = 4;

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

      • setValueType

        public Document.Page.FormField.Builder setValueType​(String value)
         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;
        Parameters:
        value - The valueType to set.
        Returns:
        This builder for chaining.

      • clearValueType

        public Document.Page.FormField.Builder clearValueType()
         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;
        Returns:
        This builder for chaining.

      • setValueTypeBytes

        public Document.Page.FormField.Builder setValueTypeBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for valueType to set.
        Returns:
        This builder for chaining.

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

      • setCorrectedKeyText

        public Document.Page.FormField.Builder setCorrectedKeyText​(String value)
         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;
        Parameters:
        value - The correctedKeyText to set.
        Returns:
        This builder for chaining.

      • clearCorrectedKeyText

        public Document.Page.FormField.Builder clearCorrectedKeyText()
         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;
        Returns:
        This builder for chaining.

      • setCorrectedKeyTextBytes

        public Document.Page.FormField.Builder setCorrectedKeyTextBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for correctedKeyText to set.
        Returns:
        This builder for chaining.

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

      • setCorrectedValueText

        public Document.Page.FormField.Builder setCorrectedValueText​(String value)
         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;
        Parameters:
        value - The correctedValueText to set.
        Returns:
        This builder for chaining.

      • clearCorrectedValueText

        public Document.Page.FormField.Builder clearCorrectedValueText()
         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;
        Returns:
        This builder for chaining.

      • setCorrectedValueTextBytes

        public Document.Page.FormField.Builder setCorrectedValueTextBytes​(com.google.protobuf.ByteString value)
         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;
        Parameters:
        value - The bytes for correctedValueText to set.
        Returns:
        This builder for chaining.

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

      • clearProvenance

        public Document.Page.FormField.Builder clearProvenance()
         The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 8;

      • getProvenanceBuilder

        public Document.Provenance.Builder getProvenanceBuilder()
         The history of this annotation.
        .google.cloud.documentai.v1.Document.Provenance provenance = 8;

      • setUnknownFields

        public final Document.Page.FormField.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>

      • mergeUnknownFields

        public final Document.Page.FormField.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Document.Page.FormField.Builder>