Class DocumentMetadata (2.80.0)
2.91.0 (latest)
2.89.0
2.87.0
2.86.0
2.85.0
2.84.0
2.82.0
2.80.0
2.79.0
2.78.0
2.77.0
2.76.0
2.74.0
2.72.0
2.71.0
2.68.0
2.67.0
2.66.0
2.64.0
2.63.0
2.62.0
2.61.0
2.60.0
2.59.0
2.58.0
2.57.0
2.56.0
2.55.0
2.53.0
2.52.0
2.51.0
2.50.0
2.49.0
2.48.0
2.47.0
2.46.0
2.45.0
2.44.0
2.43.0
2.41.0
2.40.0
2.39.0
2.38.0
2.37.0
2.36.0
2.35.0
2.34.0
2.33.0
2.32.0
2.31.0
2.28.0
2.27.0
2.26.0
2.25.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.13.0
2.12.0
2.11.0
2.10.0
2.9.0
2.8.0
2.7.5
2.6.2
2.5.1
2.4.3
2.3.1
2.2.1
2.1.9
public final class DocumentMetadata extends GeneratedMessageV3 implements DocumentMetadataOrBuilder
Metadata about a document.
Protobuf type google.cloud.documentai.v1beta3.DocumentMetadata
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int DATASET_TYPE_FIELD_NUMBER
Field Value
Type
Description
int
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type
Description
int
public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
Type
Description
int
public static final int LABELING_STATE_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
public static DocumentMetadata getDefaultInstance ()
public static final Descriptors . Descriptor getDescriptor ()
public static DocumentMetadata . Builder newBuilder ()
public static DocumentMetadata . Builder newBuilder ( DocumentMetadata prototype )
public static DocumentMetadata parseDelimitedFrom ( InputStream input )
public static DocumentMetadata parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentMetadata parseFrom ( byte [] data )
Parameter
Name
Description
data
byte []
public static DocumentMetadata parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
public static DocumentMetadata parseFrom ( ByteString data )
public static DocumentMetadata parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static DocumentMetadata parseFrom ( CodedInputStream input )
public static DocumentMetadata parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentMetadata parseFrom ( InputStream input )
public static DocumentMetadata parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
public static DocumentMetadata parseFrom ( ByteBuffer data )
public static DocumentMetadata parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
public static Parser<DocumentMetadata> parser ()
Methods
public boolean equals ( Object obj )
Parameter
Name
Description
obj
Object
Overrides
public DatasetSplitType getDatasetType ()
Type of the dataset split to which the document belongs.
.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;
public int getDatasetTypeValue ()
Type of the dataset split to which the document belongs.
.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;
Returns
Type
Description
int
The enum numeric value on the wire for datasetType.
public DocumentMetadata getDefaultInstanceForType ()
public String getDisplayName ()
The display name of the document.
string display_name = 6;
Returns
Type
Description
String
The displayName.
public ByteString getDisplayNameBytes ()
The display name of the document.
string display_name = 6;
Returns
Type
Description
ByteString
The bytes for displayName.
public DocumentId getDocumentId ()
Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 1;
Returns
Type
Description
DocumentId
The documentId.
public DocumentIdOrBuilder getDocumentIdOrBuilder ()
Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 1;
public DocumentLabelingState getLabelingState ()
Labeling state of the document.
.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;
public int getLabelingStateValue ()
Labeling state of the document.
.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;
Returns
Type
Description
int
The enum numeric value on the wire for labelingState.
getPageCount()
public int getPageCount ()
Number of pages in the document.
int32 page_count = 2;
Returns
Type
Description
int
The pageCount.
public Parser<DocumentMetadata> getParserForType ()
Overrides
public int getSerializedSize ()
Returns
Type
Description
int
Overrides
public boolean hasDocumentId ()
Document identifier.
.google.cloud.documentai.v1beta3.DocumentId document_id = 1;
Returns
Type
Description
boolean
Whether the documentId field is set.
Returns
Type
Description
int
Overrides
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
public final boolean isInitialized ()
Overrides
public DocumentMetadata . Builder newBuilderForType ()
protected DocumentMetadata . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type
Description
Object
Overrides
public DocumentMetadata . Builder toBuilder ()
public void writeTo ( CodedOutputStream output )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-03-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-03-14 UTC."],[],[]]