Document.Page (proto-google-cloud-document-ai-v1beta1 0.55.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.documentai.v1beta1.Document.Page

All Implemented Interfaces:

Document.PageOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

Enclosing class:

Document
```
public static final class Document.Page
extends com.google.protobuf.GeneratedMessageV3
implements Document.PageOrBuilder
```
```
 A page in a [Document][google.cloud.documentai.v1beta1.Document].
 
```
Protobuf type google.cloud.documentai.v1beta1.Document.Page
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Document.Page.Block` A block has a set of lines (collected into paragraphs) that have a common line-spacing and orientation.
`static interface`	`Document.Page.BlockOrBuilder`
`static class`	`Document.Page.Builder` A page in a [Document][google.cloud.documentai.v1beta1.Document].
`static class`	`Document.Page.DetectedLanguage` Detected language for a structural component.
`static interface`	`Document.Page.DetectedLanguageOrBuilder`
`static class`	`Document.Page.Dimension` Dimension for the page.
`static interface`	`Document.Page.DimensionOrBuilder`
`static class`	`Document.Page.FormField` A form field detected on the page.
`static interface`	`Document.Page.FormFieldOrBuilder`
`static class`	`Document.Page.Layout` Visual element describing a layout unit on a page.
`static interface`	`Document.Page.LayoutOrBuilder`
`static class`	`Document.Page.Line` A collection of tokens that a human would perceive as a line.
`static interface`	`Document.Page.LineOrBuilder`
`static class`	`Document.Page.Paragraph` A collection of lines that a human would perceive as a paragraph.
`static interface`	`Document.Page.ParagraphOrBuilder`
`static class`	`Document.Page.Table` A table representation similar to HTML table structure.
`static interface`	`Document.Page.TableOrBuilder`
`static class`	`Document.Page.Token` A detected token.
`static interface`	`Document.Page.TokenOrBuilder`
`static class`	`Document.Page.VisualElement` Detected non-text visual elements e.g.
`static interface`	`Document.Page.VisualElementOrBuilder`

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 and Description
`static int`	`BLOCKS_FIELD_NUMBER`
`static int`	`DETECTED_LANGUAGES_FIELD_NUMBER`
`static int`	`DIMENSION_FIELD_NUMBER`
`static int`	`FORM_FIELDS_FIELD_NUMBER`
`static int`	`LAYOUT_FIELD_NUMBER`
`static int`	`LINES_FIELD_NUMBER`
`static int`	`PAGE_NUMBER_FIELD_NUMBER`
`static int`	`PARAGRAPHS_FIELD_NUMBER`
`static int`	`TABLES_FIELD_NUMBER`
`static int`	`TOKENS_FIELD_NUMBER`
`static int`	`VISUAL_ELEMENTS_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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Document.Page.Block`	`getBlocks(int index)` A list of visually detected text blocks on the page.
`int`	`getBlocksCount()` A list of visually detected text blocks on the page.
`List<Document.Page.Block>`	`getBlocksList()` A list of visually detected text blocks on the page.
`Document.Page.BlockOrBuilder`	`getBlocksOrBuilder(int index)` A list of visually detected text blocks on the page.
`List<? extends Document.Page.BlockOrBuilder>`	`getBlocksOrBuilderList()` A list of visually detected text blocks on the page.
`static Document.Page`	`getDefaultInstance()`
`Document.Page`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Document.Page.DetectedLanguage`	`getDetectedLanguages(int index)` A list of detected languages together with confidence.
`int`	`getDetectedLanguagesCount()` A list of detected languages together with confidence.
`List<Document.Page.DetectedLanguage>`	`getDetectedLanguagesList()` A list of detected languages together with confidence.
`Document.Page.DetectedLanguageOrBuilder`	`getDetectedLanguagesOrBuilder(int index)` A list of detected languages together with confidence.
`List<? extends Document.Page.DetectedLanguageOrBuilder>`	`getDetectedLanguagesOrBuilderList()` A list of detected languages together with confidence.
`Document.Page.Dimension`	`getDimension()` Physical dimension of the page.
`Document.Page.DimensionOrBuilder`	`getDimensionOrBuilder()` Physical dimension of the page.
`Document.Page.FormField`	`getFormFields(int index)` A list of visually detected form fields on the page.
`int`	`getFormFieldsCount()` A list of visually detected form fields on the page.
`List<Document.Page.FormField>`	`getFormFieldsList()` A list of visually detected form fields on the page.
`Document.Page.FormFieldOrBuilder`	`getFormFieldsOrBuilder(int index)` A list of visually detected form fields on the page.
`List<? extends Document.Page.FormFieldOrBuilder>`	`getFormFieldsOrBuilderList()` A list of visually detected form fields on the page.
`Document.Page.Layout`	`getLayout()` [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the page.
`Document.Page.LayoutOrBuilder`	`getLayoutOrBuilder()` [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the page.
`Document.Page.Line`	`getLines(int index)` A list of visually detected text lines on the page.
`int`	`getLinesCount()` A list of visually detected text lines on the page.
`List<Document.Page.Line>`	`getLinesList()` A list of visually detected text lines on the page.
`Document.Page.LineOrBuilder`	`getLinesOrBuilder(int index)` A list of visually detected text lines on the page.
`List<? extends Document.Page.LineOrBuilder>`	`getLinesOrBuilderList()` A list of visually detected text lines on the page.
`int`	`getPageNumber()` 1-based index for current [Page][google.cloud.documentai.v1beta1.Document.Page] in a parent [Document][google.cloud.documentai.v1beta1.Document].
`Document.Page.Paragraph`	`getParagraphs(int index)` A list of visually detected text paragraphs on the page.
`int`	`getParagraphsCount()` A list of visually detected text paragraphs on the page.
`List<Document.Page.Paragraph>`	`getParagraphsList()` A list of visually detected text paragraphs on the page.
`Document.Page.ParagraphOrBuilder`	`getParagraphsOrBuilder(int index)` A list of visually detected text paragraphs on the page.
`List<? extends Document.Page.ParagraphOrBuilder>`	`getParagraphsOrBuilderList()` A list of visually detected text paragraphs on the page.
`com.google.protobuf.Parser<Document.Page>`	`getParserForType()`
`int`	`getSerializedSize()`
`Document.Page.Table`	`getTables(int index)` A list of visually detected tables on the page.
`int`	`getTablesCount()` A list of visually detected tables on the page.
`List<Document.Page.Table>`	`getTablesList()` A list of visually detected tables on the page.
`Document.Page.TableOrBuilder`	`getTablesOrBuilder(int index)` A list of visually detected tables on the page.
`List<? extends Document.Page.TableOrBuilder>`	`getTablesOrBuilderList()` A list of visually detected tables on the page.
`Document.Page.Token`	`getTokens(int index)` A list of visually detected tokens on the page.
`int`	`getTokensCount()` A list of visually detected tokens on the page.
`List<Document.Page.Token>`	`getTokensList()` A list of visually detected tokens on the page.
`Document.Page.TokenOrBuilder`	`getTokensOrBuilder(int index)` A list of visually detected tokens on the page.
`List<? extends Document.Page.TokenOrBuilder>`	`getTokensOrBuilderList()` A list of visually detected tokens on the page.
`Document.Page.VisualElement`	`getVisualElements(int index)` A list of detected non-text visual elements e.g.
`int`	`getVisualElementsCount()` A list of detected non-text visual elements e.g.
`List<Document.Page.VisualElement>`	`getVisualElementsList()` A list of detected non-text visual elements e.g.
`Document.Page.VisualElementOrBuilder`	`getVisualElementsOrBuilder(int index)` A list of detected non-text visual elements e.g.
`List<? extends Document.Page.VisualElementOrBuilder>`	`getVisualElementsOrBuilderList()` A list of detected non-text visual elements e.g.
`boolean`	`hasDimension()` Physical dimension of the page.
`int`	`hashCode()`
`boolean`	`hasLayout()` [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the page.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static Document.Page.Builder`	`newBuilder()`
`static Document.Page.Builder`	`newBuilder(Document.Page prototype)`
`Document.Page.Builder`	`newBuilderForType()`
`protected Document.Page.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static Document.Page`	`parseDelimitedFrom(InputStream input)`
`static Document.Page`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Document.Page`	`parseFrom(byte[] data)`
`static Document.Page`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Document.Page`	`parseFrom(ByteBuffer data)`
`static Document.Page`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Document.Page`	`parseFrom(com.google.protobuf.ByteString data)`
`static Document.Page`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Document.Page`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static Document.Page`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static Document.Page`	`parseFrom(InputStream input)`
`static Document.Page`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<Document.Page>`	`parser()`
`Document.Page.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- PAGE_NUMBER_FIELD_NUMBER
```
public static final int PAGE_NUMBER_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DIMENSION_FIELD_NUMBER
```
public static final int DIMENSION_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LAYOUT_FIELD_NUMBER
```
public static final int LAYOUT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DETECTED_LANGUAGES_FIELD_NUMBER
```
public static final int DETECTED_LANGUAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- BLOCKS_FIELD_NUMBER
```
public static final int BLOCKS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PARAGRAPHS_FIELD_NUMBER
```
public static final int PARAGRAPHS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LINES_FIELD_NUMBER
```
public static final int LINES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TOKENS_FIELD_NUMBER
```
public static final int TOKENS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- VISUAL_ELEMENTS_FIELD_NUMBER
```
public static final int VISUAL_ELEMENTS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TABLES_FIELD_NUMBER
```
public static final int TABLES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- FORM_FIELDS_FIELD_NUMBER
```
public static final int FORM_FIELDS_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

getPageNumber

public int getPageNumber()

 1-based index for current
 [Page][google.cloud.documentai.v1beta1.Document.Page] in a parent
 [Document][google.cloud.documentai.v1beta1.Document]. Useful when a page
 is taken out of a [Document][google.cloud.documentai.v1beta1.Document]
 for individual processing.

int32 page_number = 1;

Specified by:: getPageNumber in interface Document.PageOrBuilder
Returns:: The pageNumber.

hasDimension
```
public boolean hasDimension()
```
```
 Physical dimension of the page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Dimension dimension = 2;
Specified by:

hasDimension in interface Document.PageOrBuilder

Returns:

Whether the dimension field is set.

getDimension
```
public Document.Page.Dimension getDimension()
```
```
 Physical dimension of the page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Dimension dimension = 2;
Specified by:

getDimension in interface Document.PageOrBuilder

Returns:

The dimension.

getDimensionOrBuilder
```
public Document.Page.DimensionOrBuilder getDimensionOrBuilder()
```
```
 Physical dimension of the page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Dimension dimension = 2;
Specified by:

getDimensionOrBuilder in interface Document.PageOrBuilder

hasLayout
```
public boolean hasLayout()
```
```
 [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the
 page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Layout layout = 3;
Specified by:

hasLayout in interface Document.PageOrBuilder

Returns:

Whether the layout field is set.

getLayout
```
public Document.Page.Layout getLayout()
```
```
 [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the
 page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Layout layout = 3;
Specified by:

getLayout in interface Document.PageOrBuilder

Returns:

The layout.

getLayoutOrBuilder
```
public Document.Page.LayoutOrBuilder getLayoutOrBuilder()
```
```
 [Layout][google.cloud.documentai.v1beta1.Document.Page.Layout] for the
 page.
 
```
.google.cloud.documentai.v1beta1.Document.Page.Layout layout = 3;
Specified by:

getLayoutOrBuilder in interface Document.PageOrBuilder

getDetectedLanguagesList
```
public List<Document.Page.DetectedLanguage> getDetectedLanguagesList()
```
```
 A list of detected languages together with confidence.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage detected_languages = 4;
Specified by:

getDetectedLanguagesList in interface Document.PageOrBuilder

getDetectedLanguagesOrBuilderList
```
public List<? extends Document.Page.DetectedLanguageOrBuilder> getDetectedLanguagesOrBuilderList()
```
```
 A list of detected languages together with confidence.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage detected_languages = 4;
Specified by:

getDetectedLanguagesOrBuilderList in interface Document.PageOrBuilder

getDetectedLanguagesCount
```
public int getDetectedLanguagesCount()
```
```
 A list of detected languages together with confidence.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage detected_languages = 4;
Specified by:

getDetectedLanguagesCount in interface Document.PageOrBuilder

getDetectedLanguages
```
public Document.Page.DetectedLanguage getDetectedLanguages(int index)
```
```
 A list of detected languages together with confidence.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage detected_languages = 4;
Specified by:

getDetectedLanguages in interface Document.PageOrBuilder

getDetectedLanguagesOrBuilder
```
public Document.Page.DetectedLanguageOrBuilder getDetectedLanguagesOrBuilder(int index)
```
```
 A list of detected languages together with confidence.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.DetectedLanguage detected_languages = 4;
Specified by:

getDetectedLanguagesOrBuilder in interface Document.PageOrBuilder

getBlocksList

public List<Document.Page.Block> getBlocksList()

 A list of visually detected text blocks on the page.
 A block has a set of lines (collected into paragraphs) that have a common
 line-spacing and orientation.

repeated .google.cloud.documentai.v1beta1.Document.Page.Block blocks = 5;

Specified by:: getBlocksList in interface Document.PageOrBuilder

getBlocksOrBuilderList

public List<? extends Document.Page.BlockOrBuilder> getBlocksOrBuilderList()

 A list of visually detected text blocks on the page.
 A block has a set of lines (collected into paragraphs) that have a common
 line-spacing and orientation.

repeated .google.cloud.documentai.v1beta1.Document.Page.Block blocks = 5;

Specified by:: getBlocksOrBuilderList in interface Document.PageOrBuilder

getBlocksCount

public int getBlocksCount()

 A list of visually detected text blocks on the page.
 A block has a set of lines (collected into paragraphs) that have a common
 line-spacing and orientation.

repeated .google.cloud.documentai.v1beta1.Document.Page.Block blocks = 5;

Specified by:: getBlocksCount in interface Document.PageOrBuilder

getBlocks

public Document.Page.Block getBlocks(int index)

 A list of visually detected text blocks on the page.
 A block has a set of lines (collected into paragraphs) that have a common
 line-spacing and orientation.

repeated .google.cloud.documentai.v1beta1.Document.Page.Block blocks = 5;

Specified by:: getBlocks in interface Document.PageOrBuilder

getBlocksOrBuilder

public Document.Page.BlockOrBuilder getBlocksOrBuilder(int index)

 A list of visually detected text blocks on the page.
 A block has a set of lines (collected into paragraphs) that have a common
 line-spacing and orientation.

repeated .google.cloud.documentai.v1beta1.Document.Page.Block blocks = 5;

Specified by:: getBlocksOrBuilder in interface Document.PageOrBuilder

getParagraphsList

public List<Document.Page.Paragraph> getParagraphsList()

 A list of visually detected text paragraphs on the page.
 A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1beta1.Document.Page.Paragraph paragraphs = 6;

Specified by:: getParagraphsList in interface Document.PageOrBuilder

getParagraphsOrBuilderList

public List<? extends Document.Page.ParagraphOrBuilder> getParagraphsOrBuilderList()

 A list of visually detected text paragraphs on the page.
 A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1beta1.Document.Page.Paragraph paragraphs = 6;

Specified by:: getParagraphsOrBuilderList in interface Document.PageOrBuilder

getParagraphsCount
```
public int getParagraphsCount()
```
```
 A list of visually detected text paragraphs on the page.
 A collection of lines that a human would perceive as a paragraph.
 
```
repeated .google.cloud.documentai.v1beta1.Document.Page.Paragraph paragraphs = 6;
Specified by:

getParagraphsCount in interface Document.PageOrBuilder

getParagraphs

public Document.Page.Paragraph getParagraphs(int index)

 A list of visually detected text paragraphs on the page.
 A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1beta1.Document.Page.Paragraph paragraphs = 6;

Specified by:: getParagraphs in interface Document.PageOrBuilder

getParagraphsOrBuilder

public Document.Page.ParagraphOrBuilder getParagraphsOrBuilder(int index)

 A list of visually detected text paragraphs on the page.
 A collection of lines that a human would perceive as a paragraph.

repeated .google.cloud.documentai.v1beta1.Document.Page.Paragraph paragraphs = 6;

Specified by:: getParagraphsOrBuilder in interface Document.PageOrBuilder