Package com.google.cloud.documentai.v1beta1

Class Document.Page.FormField

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.FormField

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Page.FormField.Builder	A form field detected on the page.

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	FIELD_NAME_FIELD_NUMBER
static int	FIELD_VALUE_FIELD_NUMBER
static int	NAME_DETECTED_LANGUAGES_FIELD_NUMBER
static int	VALUE_DETECTED_LANGUAGES_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

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Document.Page.FormField	getDefaultInstance()
Document.Page.FormField	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
Document.Page.Layout	getFieldName()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] name.
Document.Page.LayoutOrBuilder	getFieldNameOrBuilder()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] name.
Document.Page.Layout	getFieldValue()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] value.
Document.Page.LayoutOrBuilder	getFieldValueOrBuilder()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] value.
Document.Page.DetectedLanguage	getNameDetectedLanguages(int index)	A list of detected languages for name together with confidence.
int	getNameDetectedLanguagesCount()	A list of detected languages for name together with confidence.
List<Document.Page.DetectedLanguage>	getNameDetectedLanguagesList()	A list of detected languages for name together with confidence.
Document.Page.DetectedLanguageOrBuilder	getNameDetectedLanguagesOrBuilder(int index)	A list of detected languages for name together with confidence.
List<? extends Document.Page.DetectedLanguageOrBuilder>	getNameDetectedLanguagesOrBuilderList()	A list of detected languages for name together with confidence.
com.google.protobuf.Parser<Document.Page.FormField>	getParserForType()
int	getSerializedSize()
Document.Page.DetectedLanguage	getValueDetectedLanguages(int index)	A list of detected languages for value together with confidence.
int	getValueDetectedLanguagesCount()	A list of detected languages for value together with confidence.
List<Document.Page.DetectedLanguage>	getValueDetectedLanguagesList()	A list of detected languages for value together with confidence.
Document.Page.DetectedLanguageOrBuilder	getValueDetectedLanguagesOrBuilder(int index)	A list of detected languages for value together with confidence.
List<? extends Document.Page.DetectedLanguageOrBuilder>	getValueDetectedLanguagesOrBuilderList()	A list of detected languages for value together with confidence.
boolean	hasFieldName()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] name.
boolean	hasFieldValue()	[Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField] value.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Page.FormField.Builder	newBuilder()
static Document.Page.FormField.Builder	newBuilder(Document.Page.FormField prototype)
Document.Page.FormField.Builder	newBuilderForType()
protected Document.Page.FormField.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.Page.FormField	parseDelimitedFrom(InputStream input)
static Document.Page.FormField	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.FormField	parseFrom(byte[] data)
static Document.Page.FormField	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.FormField	parseFrom(com.google.protobuf.ByteString data)
static Document.Page.FormField	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.FormField	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.Page.FormField	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.FormField	parseFrom(InputStream input)
static Document.Page.FormField	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.Page.FormField	parseFrom(ByteBuffer data)
static Document.Page.FormField	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.Page.FormField>	parser()
Document.Page.FormField.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

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

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.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
 

.google.cloud.documentai.v1beta1.Document.Page.Layout field_name = 1;

Specified by:

getFieldNameOrBuilder in interface Document.Page.FormFieldOrBuilder

hasFieldValue

public boolean hasFieldValue()

 [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 value.
 

.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 value.
 

.google.cloud.documentai.v1beta1.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.v1beta1.Document.Page.Layout] for the
 [FormField][google.cloud.documentai.v1beta1.Document.Page.FormField]
 value.
 

.google.cloud.documentai.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.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.v1beta1.Document.Page.DetectedLanguage value_detected_languages = 4;

Specified by:

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

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.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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