Class Document (2.45.0)

Version 2.45.0

• 2.51.0 (latest)
• 2.49.0
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.18
• 2.2.3
• 2.1.23

public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder

A structured text document e.g. a PDF.

Protobuf type google.cloud.automl.v1beta1.Document

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Document

Implements

DocumentOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

DOCUMENT_DIMENSIONS_FIELD_NUMBER

public static final int DOCUMENT_DIMENSIONS_FIELD_NUMBER

Field Value
Type	Description
int

DOCUMENT_TEXT_FIELD_NUMBER

public static final int DOCUMENT_TEXT_FIELD_NUMBER

Field Value
Type	Description
int

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

Field Value
Type	Description
int

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER

Field Value
Type	Description
int

PAGE_COUNT_FIELD_NUMBER

public static final int PAGE_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Document getDefaultInstance()

Returns
Type	Description
Document

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Document.Builder newBuilder()

Returns
Type	Description
Document.Builder

newBuilder(Document prototype)

public static Document.Builder newBuilder(Document prototype)

Parameter
Name	Description
prototype	Document

Returns
Type	Description
Document.Builder

parseDelimitedFrom(InputStream input)

public static Document parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Document parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Document parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Document parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Document

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Document> parser()

Returns
Type	Description
Parser<Document>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public Document getDefaultInstanceForType()

Returns
Type	Description
Document

getDocumentDimensions()

public DocumentDimensions getDocumentDimensions()

The dimensions of the page in the document.

.google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;

Returns
Type	Description
DocumentDimensions	The documentDimensions.

getDocumentDimensionsOrBuilder()

public DocumentDimensionsOrBuilder getDocumentDimensionsOrBuilder()

The dimensions of the page in the document.

.google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;

Returns
Type	Description
DocumentDimensionsOrBuilder

getDocumentText()

public TextSnippet getDocumentText()

The plain text version of this document.

.google.cloud.automl.v1beta1.TextSnippet document_text = 2;

Returns
Type	Description
TextSnippet	The documentText.

getDocumentTextOrBuilder()

public TextSnippetOrBuilder getDocumentTextOrBuilder()

The plain text version of this document.

.google.cloud.automl.v1beta1.TextSnippet document_text = 2;

Returns
Type	Description
TextSnippetOrBuilder

getInputConfig()

public DocumentInputConfig getInputConfig()

An input config specifying the content of the document.

.google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;

Returns
Type	Description
DocumentInputConfig	The inputConfig.

getInputConfigOrBuilder()

public DocumentInputConfigOrBuilder getInputConfigOrBuilder()

An input config specifying the content of the document.

.google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;

Returns
Type	Description
DocumentInputConfigOrBuilder

getLayout(int index)

public Document.Layout getLayout(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.Layout

getLayoutCount()

public int getLayoutCount()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;

Returns
Type	Description
int

getLayoutList()

public List<Document.Layout> getLayoutList()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;

Returns
Type	Description
List<Layout>

getLayoutOrBuilder(int index)

public Document.LayoutOrBuilder getLayoutOrBuilder(int index)

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;

Parameter
Name	Description
index	int

Returns
Type	Description
Document.LayoutOrBuilder

getLayoutOrBuilderList()

public List<? extends Document.LayoutOrBuilder> getLayoutOrBuilderList()

Describes the layout of the document. Sorted by [page_number][].

repeated .google.cloud.automl.v1beta1.Document.Layout layout = 3;

Returns
Type	Description
List<? extends com.google.cloud.automl.v1beta1.Document.LayoutOrBuilder>

getPageCount()

public int getPageCount()

Number of pages in the document.

int32 page_count = 5;

Returns
Type	Description
int	The pageCount.

getParserForType()

public Parser<Document> getParserForType()

Returns
Type	Description
Parser<Document>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

hasDocumentDimensions()

public boolean hasDocumentDimensions()

The dimensions of the page in the document.

.google.cloud.automl.v1beta1.DocumentDimensions document_dimensions = 4;

Returns
Type	Description
boolean	Whether the documentDimensions field is set.

hasDocumentText()

public boolean hasDocumentText()

The plain text version of this document.

.google.cloud.automl.v1beta1.TextSnippet document_text = 2;

Returns
Type	Description
boolean	Whether the documentText field is set.

hasInputConfig()

public boolean hasInputConfig()

An input config specifying the content of the document.

.google.cloud.automl.v1beta1.DocumentInputConfig input_config = 1;

Returns
Type	Description
boolean	Whether the inputConfig field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Document.Builder newBuilderForType()

Returns
Type	Description
Document.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Document.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Document.Builder toBuilder()

Returns
Type	Description
Document.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException