Package com.google.cloud.automl.v1

Class Document

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.automl.v1.Document

All Implemented Interfaces:

DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Document
extends com.google.protobuf.GeneratedMessageV3
implements DocumentOrBuilder

 A structured text document e.g. a PDF.
 

Protobuf type google.cloud.automl.v1.Document

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Document.Builder	A structured text document e.g.
static class	Document.Layout	Describes the layout information of a [text_segment][google.cloud.automl.v1.Document.Layout.text_segment] in the document.
static interface	Document.LayoutOrBuilder

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	DOCUMENT_DIMENSIONS_FIELD_NUMBER
static int	DOCUMENT_TEXT_FIELD_NUMBER
static int	INPUT_CONFIG_FIELD_NUMBER
static int	LAYOUT_FIELD_NUMBER
static int	PAGE_COUNT_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	getDefaultInstance()
Document	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentDimensions	getDocumentDimensions()	The dimensions of the page in the document.
DocumentDimensionsOrBuilder	getDocumentDimensionsOrBuilder()	The dimensions of the page in the document.
TextSnippet	getDocumentText()	The plain text version of this document.
TextSnippetOrBuilder	getDocumentTextOrBuilder()	The plain text version of this document.
DocumentInputConfig	getInputConfig()	An input config specifying the content of the document.
DocumentInputConfigOrBuilder	getInputConfigOrBuilder()	An input config specifying the content of the document.
Document.Layout	getLayout(int index)	Describes the layout of the document.
int	getLayoutCount()	Describes the layout of the document.
List<Document.Layout>	getLayoutList()	Describes the layout of the document.
Document.LayoutOrBuilder	getLayoutOrBuilder(int index)	Describes the layout of the document.
List<? extends Document.LayoutOrBuilder>	getLayoutOrBuilderList()	Describes the layout of the document.
int	getPageCount()	Number of pages in the document.
com.google.protobuf.Parser<Document>	getParserForType()
int	getSerializedSize()
boolean	hasDocumentDimensions()	The dimensions of the page in the document.
boolean	hasDocumentText()	The plain text version of this document.
int	hashCode()
boolean	hasInputConfig()	An input config specifying the content of the document.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Builder	newBuilder()
static Document.Builder	newBuilder(Document prototype)
Document.Builder	newBuilderForType()
protected Document.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document	parseDelimitedFrom(InputStream input)
static Document	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(byte[] data)
static Document	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(com.google.protobuf.ByteString data)
static Document	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(com.google.protobuf.CodedInputStream input)
static Document	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(InputStream input)
static Document	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(ByteBuffer data)
static Document	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document>	parser()
Document.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

INPUT_CONFIG_FIELD_NUMBER

public static final int INPUT_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_TEXT_FIELD_NUMBER

public static final int DOCUMENT_TEXT_FIELD_NUMBER

See Also:

Constant Field Values

LAYOUT_FIELD_NUMBER

public static final int LAYOUT_FIELD_NUMBER

See Also:

Constant Field Values

DOCUMENT_DIMENSIONS_FIELD_NUMBER

public static final int DOCUMENT_DIMENSIONS_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_COUNT_FIELD_NUMBER

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

hasInputConfig

public boolean hasInputConfig()

 An input config specifying the content of the document.
 

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

Specified by:

hasInputConfig in interface DocumentOrBuilder

Returns:

Whether the inputConfig field is set.

getInputConfig

public DocumentInputConfig getInputConfig()

 An input config specifying the content of the document.
 

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

Specified by:

getInputConfig in interface DocumentOrBuilder

Returns:

The inputConfig.

getInputConfigOrBuilder

public DocumentInputConfigOrBuilder getInputConfigOrBuilder()

 An input config specifying the content of the document.
 

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

Specified by:

getInputConfigOrBuilder in interface DocumentOrBuilder

hasDocumentText

public boolean hasDocumentText()

 The plain text version of this document.
 

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

Specified by:

hasDocumentText in interface DocumentOrBuilder

Returns:

Whether the documentText field is set.

getDocumentText

public TextSnippet getDocumentText()

 The plain text version of this document.
 

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

Specified by:

getDocumentText in interface DocumentOrBuilder

Returns:

The documentText.

getDocumentTextOrBuilder

public TextSnippetOrBuilder getDocumentTextOrBuilder()

 The plain text version of this document.
 

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

Specified by:

getDocumentTextOrBuilder in interface DocumentOrBuilder

getLayoutList

public List<Document.Layout> getLayoutList()

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

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

Specified by:

getLayoutList in interface DocumentOrBuilder

getLayoutOrBuilderList

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

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

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

Specified by:

getLayoutOrBuilderList in interface DocumentOrBuilder

getLayoutCount

public int getLayoutCount()

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

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

Specified by:

getLayoutCount in interface DocumentOrBuilder

getLayout

public Document.Layout getLayout(int index)

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

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

Specified by:

getLayout in interface DocumentOrBuilder

getLayoutOrBuilder

public Document.LayoutOrBuilder getLayoutOrBuilder(int index)

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

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

Specified by:

getLayoutOrBuilder in interface DocumentOrBuilder

hasDocumentDimensions

public boolean hasDocumentDimensions()

 The dimensions of the page in the document.
 

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

Specified by:

hasDocumentDimensions in interface DocumentOrBuilder

Returns:

Whether the documentDimensions field is set.

getDocumentDimensions

public DocumentDimensions getDocumentDimensions()

 The dimensions of the page in the document.
 

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

Specified by:

getDocumentDimensions in interface DocumentOrBuilder

Returns:

The documentDimensions.

getDocumentDimensionsOrBuilder

public DocumentDimensionsOrBuilder getDocumentDimensionsOrBuilder()

 The dimensions of the page in the document.
 

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

Specified by:

getDocumentDimensionsOrBuilder in interface DocumentOrBuilder

getPageCount

public int getPageCount()

 Number of pages in the document.
 

int32 page_count = 5;

Specified by:

getPageCount in interface DocumentOrBuilder

Returns:

The pageCount.

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 parseFrom(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document parseFrom(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document parseFrom(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document 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 parseFrom(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document parseFrom(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static Document parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static Document parseFrom(com.google.protobuf.CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public Document.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.Builder newBuilder()

newBuilder

public static Document.Builder newBuilder(Document prototype)

toBuilder

public Document.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<Document> 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 getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder