Document (proto-google-cloud-document-ai-v1beta2 0.38.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.documentai.v1beta2.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

 Document represents the canonical document resource in Document AI. It is an
 interchange format that provides insights into documents and allows for
 collaboration between users and Document AI to iterate and optimize for
 quality.

Protobuf type google.cloud.documentai.v1beta2.Document

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Document.Builder` Document represents the canonical document resource in Document AI.
`static class`	`Document.Entity` An entity that could be a phrase in the text or a property that belongs to the document.
`static interface`	`Document.EntityOrBuilder`
`static class`	`Document.EntityRelation` Relationship between [Entities][google.cloud.documentai.v1beta2.Document.Entity].
`static interface`	`Document.EntityRelationOrBuilder`
`static class`	`Document.Label` Label attaches schema information and/or other metadata to segments within a [Document][google.cloud.documentai.v1beta2.Document].
`static interface`	`Document.LabelOrBuilder`
`static class`	`Document.Page` A page in a [Document][google.cloud.documentai.v1beta2.Document].
`static class`	`Document.PageAnchor` Referencing the visual context of the entity in the [Document.pages][google.cloud.documentai.v1beta2.Document.pages].
`static interface`	`Document.PageAnchorOrBuilder`
`static interface`	`Document.PageOrBuilder`
`static class`	`Document.Provenance` Structure to identify provenance relationships between annotations in different revisions.
`static interface`	`Document.ProvenanceOrBuilder`
`static class`	`Document.Revision` Contains past or forward revisions of this document.
`static interface`	`Document.RevisionOrBuilder`
`static class`	`Document.ShardInfo` For a large document, sharding may be performed to produce several document shards.
`static interface`	`Document.ShardInfoOrBuilder`
`static class`	`Document.SourceCase`
`static class`	`Document.Style` Annotation for common text style attributes.
`static interface`	`Document.StyleOrBuilder`
`static class`	`Document.TextAnchor` Text reference indexing into the [Document.text][google.cloud.documentai.v1beta2.Document.text].
`static interface`	`Document.TextAnchorOrBuilder`
`static class`	`Document.TextChange` This message is used for text changes aka.
`static interface`	`Document.TextChangeOrBuilder`

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`	`CONTENT_FIELD_NUMBER`
`static int`	`ENTITIES_FIELD_NUMBER`
`static int`	`ENTITY_RELATIONS_FIELD_NUMBER`
`static int`	`ERROR_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`MIME_TYPE_FIELD_NUMBER`
`static int`	`PAGES_FIELD_NUMBER`
`static int`	`REVISIONS_FIELD_NUMBER`
`static int`	`SHARD_INFO_FIELD_NUMBER`
`static int`	`TEXT_CHANGES_FIELD_NUMBER`
`static int`	`TEXT_FIELD_NUMBER`
`static int`	`TEXT_STYLES_FIELD_NUMBER`
`static int`	`URI_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 Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`com.google.protobuf.ByteString`	`getContent()` Optional.
`static Document`	`getDefaultInstance()`
`Document`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`Document.Entity`	`getEntities(int index)` A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
`int`	`getEntitiesCount()` A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
`List<Document.Entity>`	`getEntitiesList()` A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
`Document.EntityOrBuilder`	`getEntitiesOrBuilder(int index)` A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
`List<? extends Document.EntityOrBuilder>`	`getEntitiesOrBuilderList()` A list of entities detected on [Document.text][google.cloud.documentai.v1beta2.Document.text].
`Document.EntityRelation`	`getEntityRelations(int index)` Placeholder.
`int`	`getEntityRelationsCount()` Placeholder.
`List<Document.EntityRelation>`	`getEntityRelationsList()` Placeholder.
`Document.EntityRelationOrBuilder`	`getEntityRelationsOrBuilder(int index)` Placeholder.
`List<? extends Document.EntityRelationOrBuilder>`	`getEntityRelationsOrBuilderList()` Placeholder.
`com.google.rpc.Status`	`getError()` Any error that occurred while processing this document.
`com.google.rpc.StatusOrBuilder`	`getErrorOrBuilder()` Any error that occurred while processing this document.
`Document.Label`	`getLabels(int index)` [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
`int`	`getLabelsCount()` [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
`List<Document.Label>`	`getLabelsList()` [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
`Document.LabelOrBuilder`	`getLabelsOrBuilder(int index)` [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
`List<? extends Document.LabelOrBuilder>`	`getLabelsOrBuilderList()` [Label][google.cloud.documentai.v1beta2.Document.Label]s for this document.
`String`	`getMimeType()` An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
`com.google.protobuf.ByteString`	`getMimeTypeBytes()` An IANA published [media type (MIME type)](https://www.iana.org/assignments/media-types/media-types.xhtml).
`Document.Page`	`getPages(int index)` Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
`int`	`getPagesCount()` Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
`List<Document.Page>`	`getPagesList()` Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
`Document.PageOrBuilder`	`getPagesOrBuilder(int index)` Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
`List<? extends Document.PageOrBuilder>`	`getPagesOrBuilderList()` Visual page layout for the [Document][google.cloud.documentai.v1beta2.Document].
`com.google.protobuf.Parser<Document>`	`getParserForType()`
`Document.Revision`	`getRevisions(int index)` Placeholder.
`int`	`getRevisionsCount()` Placeholder.
`List<Document.Revision>`	`getRevisionsList()` Placeholder.
`Document.RevisionOrBuilder`	`getRevisionsOrBuilder(int index)` Placeholder.
`List<? extends Document.RevisionOrBuilder>`	`getRevisionsOrBuilderList()` Placeholder.
`int`	`getSerializedSize()`
`Document.ShardInfo`	`getShardInfo()` Information about the sharding if this document is sharded part of a larger document.
`Document.ShardInfoOrBuilder`	`getShardInfoOrBuilder()` Information about the sharding if this document is sharded part of a larger document.
`Document.SourceCase`	`getSourceCase()`
`String`	`getText()` Optional.
`com.google.protobuf.ByteString`	`getTextBytes()` Optional.
`Document.TextChange`	`getTextChanges(int index)` Placeholder.
`int`	`getTextChangesCount()` Placeholder.
`List<Document.TextChange>`	`getTextChangesList()` Placeholder.
`Document.TextChangeOrBuilder`	`getTextChangesOrBuilder(int index)` Placeholder.
`List<? extends Document.TextChangeOrBuilder>`	`getTextChangesOrBuilderList()` Placeholder.
`Document.Style`	`getTextStyles(int index)` Deprecated.
`int`	`getTextStylesCount()` Deprecated.
`List<Document.Style>`	`getTextStylesList()` Deprecated.
`Document.StyleOrBuilder`	`getTextStylesOrBuilder(int index)` Deprecated.
`List<? extends Document.StyleOrBuilder>`	`getTextStylesOrBuilderList()` Deprecated.
`String`	`getUri()` Optional.
`com.google.protobuf.ByteString`	`getUriBytes()` Optional.
`boolean`	`hasContent()` Optional.
`boolean`	`hasError()` Any error that occurred while processing this document.
`int`	`hashCode()`
`boolean`	`hasShardInfo()` Information about the sharding if this document is sharded part of a larger document.
`boolean`	`hasUri()` Optional.
`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(ByteBuffer data)`
`static Document`	`parseFrom(ByteBuffer 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 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.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
- URI_FIELD_NUMBER
```
public static final int URI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CONTENT_FIELD_NUMBER
```
public static final int CONTENT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- MIME_TYPE_FIELD_NUMBER
```
public static final int MIME_TYPE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TEXT_FIELD_NUMBER
```
public static final int TEXT_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TEXT_STYLES_FIELD_NUMBER
```
public static final int TEXT_STYLES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- PAGES_FIELD_NUMBER
```
public static final int PAGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENTITIES_FIELD_NUMBER
```
public static final int ENTITIES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENTITY_RELATIONS_FIELD_NUMBER
```
public static final int ENTITY_RELATIONS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- TEXT_CHANGES_FIELD_NUMBER
```
public static final int TEXT_CHANGES_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SHARD_INFO_FIELD_NUMBER
```
public static final int SHARD_INFO_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ERROR_FIELD_NUMBER
```
public static final int ERROR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- REVISIONS_FIELD_NUMBER
```
public static final int REVISIONS_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

getSourceCase
```
public Document.SourceCase getSourceCase()
```
Specified by:

getSourceCase in interface DocumentOrBuilder

hasUri

public boolean hasUri()

 Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).

string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: hasUri in interface DocumentOrBuilder
Returns:: Whether the uri field is set.

getUri

public String getUri()

 Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).

string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getUri in interface DocumentOrBuilder
Returns:: The uri.

getUriBytes

public com.google.protobuf.ByteString getUriBytes()

 Optional. Currently supports Google Cloud Storage URI of the form
 `gs://bucket_name/object_name`. Object versioning is not supported.
 For more information, refer to [Google Cloud Storage Request
 URIs](https://cloud.google.com/storage/docs/reference-uris).

string uri = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getUriBytes in interface DocumentOrBuilder
Returns:: The bytes for uri.

hasContent

public boolean hasContent()

 Optional. Inline document content, represented as a stream of bytes.
 Note: As with all `bytes` fields, protobuffers use a pure binary
 representation, whereas JSON representations use base64.

bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: hasContent in interface DocumentOrBuilder
Returns:: Whether the content field is set.

getContent

public com.google.protobuf.ByteString getContent()

 Optional. Inline document content, represented as a stream of bytes.
 Note: As with all `bytes` fields, protobuffers use a pure binary
 representation, whereas JSON representations use base64.

bytes content = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:: getContent in interface DocumentOrBuilder
Returns:: The content.

getMimeType

public String getMimeType()

 An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).

string mime_type = 3;

Specified by:: getMimeType in interface DocumentOrBuilder
Returns:: The mimeType.

getMimeTypeBytes

public com.google.protobuf.ByteString getMimeTypeBytes()

 An IANA published [media type (MIME
 type)](https://www.iana.org/assignments/media-types/media-types.xhtml).

string mime_type = 3;

Specified by:: getMimeTypeBytes in interface DocumentOrBuilder
Returns:: The bytes for mimeType.

getText
```
public String getText()
```
```
 Optional. UTF-8 encoded text in reading order from the document.
 
```
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getText in interface DocumentOrBuilder

Returns:

The text.

getTextBytes
```
public com.google.protobuf.ByteString getTextBytes()
```
```
 Optional. UTF-8 encoded text in reading order from the document.
 
```
string text = 4 [(.google.api.field_behavior) = OPTIONAL];
Specified by:

getTextBytes in interface DocumentOrBuilder

Returns:

The bytes for text.

getTextStylesList
```
@Deprecated
public List<Document.Style> getTextStylesList()
```
Deprecated.
```
 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];
Specified by:

getTextStylesList in interface DocumentOrBuilder

getTextStylesOrBuilderList
```
@Deprecated
public List<? extends Document.StyleOrBuilder> getTextStylesOrBuilderList()
```
Deprecated.
```
 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];
Specified by:

getTextStylesOrBuilderList in interface DocumentOrBuilder

getTextStylesCount
```
@Deprecated
public int getTextStylesCount()
```
Deprecated.
```
 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];
Specified by:

getTextStylesCount in interface DocumentOrBuilder

getTextStyles
```
@Deprecated
public Document.Style getTextStyles(int index)
```
Deprecated.
```
 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];
Specified by:

getTextStyles in interface DocumentOrBuilder

getTextStylesOrBuilder
```
@Deprecated
public Document.StyleOrBuilder getTextStylesOrBuilder(int index)
```
Deprecated.
```
 Styles for the
 [Document.text][google.cloud.documentai.v1beta2.Document.text].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Style text_styles = 5 [deprecated = true];
Specified by:

getTextStylesOrBuilder in interface DocumentOrBuilder

getPagesList

public List<Document.Page> getPagesList()

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

Specified by:: getPagesList in interface DocumentOrBuilder

getPagesOrBuilderList

public List<? extends Document.PageOrBuilder> getPagesOrBuilderList()

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

Specified by:: getPagesOrBuilderList in interface DocumentOrBuilder

getPagesCount
```
public int getPagesCount()
```
```
 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].
 
```
repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;
Specified by:

getPagesCount in interface DocumentOrBuilder

getPages

public Document.Page getPages(int index)

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

Specified by:: getPages in interface DocumentOrBuilder

getPagesOrBuilder

public Document.PageOrBuilder getPagesOrBuilder(int index)

 Visual page layout for the
 [Document][google.cloud.documentai.v1beta2.Document].

repeated .google.cloud.documentai.v1beta2.Document.Page pages = 6;

Specified by:: getPagesOrBuilder in interface DocumentOrBuilder