Class DocumentMetadata (2.50.0)

public final class DocumentMetadata extends GeneratedMessageV3 implements DocumentMetadataOrBuilder

Metadata about a document.

Protobuf type google.cloud.documentai.v1beta3.DocumentMetadata

Static Fields

DATASET_TYPE_FIELD_NUMBER

public static final int DATASET_TYPE_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
Type Description
int

LABELING_STATE_FIELD_NUMBER

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

getDefaultInstance()

public static DocumentMetadata getDefaultInstance()
Returns
Type Description
DocumentMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static DocumentMetadata.Builder newBuilder()
Returns
Type Description
DocumentMetadata.Builder

newBuilder(DocumentMetadata prototype)

public static DocumentMetadata.Builder newBuilder(DocumentMetadata prototype)
Parameter
Name Description
prototype DocumentMetadata
Returns
Type Description
DocumentMetadata.Builder

parseDelimitedFrom(InputStream input)

public static DocumentMetadata parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentMetadata parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentMetadata parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentMetadata parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentMetadata parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentMetadata parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentMetadata> parser()
Returns
Type Description
Parser<DocumentMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDatasetType()

public DatasetSplitType getDatasetType()

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Returns
Type Description
DatasetSplitType

The datasetType.

getDatasetTypeValue()

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.

getDefaultInstanceForType()

public DocumentMetadata getDefaultInstanceForType()
Returns
Type Description
DocumentMetadata

getDisplayName()

public String getDisplayName()

The display name of the document.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the document.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getDocumentId()

public DocumentId getDocumentId()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentId

The documentId.

getDocumentIdOrBuilder()

public DocumentIdOrBuilder getDocumentIdOrBuilder()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentIdOrBuilder

getLabelingState()

public DocumentLabelingState getLabelingState()

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Returns
Type Description
DocumentLabelingState

The labelingState.

getLabelingStateValue()

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.

getParserForType()

public Parser<DocumentMetadata> getParserForType()
Returns
Type Description
Parser<DocumentMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasDocumentId()

public boolean hasDocumentId()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
boolean

Whether the documentId field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentMetadata.Builder newBuilderForType()
Returns
Type Description
DocumentMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentMetadata.Builder toBuilder()
Returns
Type Description
DocumentMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException