Class DocumentMetadata (2.39.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
TypeDescription
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER
Field Value
TypeDescription
int

LABELING_STATE_FIELD_NUMBER

public static final int LABELING_STATE_FIELD_NUMBER
Field Value
TypeDescription
int

PAGE_COUNT_FIELD_NUMBER

public static final int PAGE_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentMetadata getDefaultInstance()
Returns
TypeDescription
DocumentMetadata

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DocumentMetadata.Builder newBuilder()
Returns
TypeDescription
DocumentMetadata.Builder

newBuilder(DocumentMetadata prototype)

public static DocumentMetadata.Builder newBuilder(DocumentMetadata prototype)
Parameter
NameDescription
prototypeDocumentMetadata
Returns
TypeDescription
DocumentMetadata.Builder

parseDelimitedFrom(InputStream input)

public static DocumentMetadata parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentMetadata parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentMetadata parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentMetadata parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentMetadata parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentMetadata parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentMetadata parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentMetadata
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentMetadata> parser()
Returns
TypeDescription
Parser<DocumentMetadata>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for datasetType.

getDefaultInstanceForType()

public DocumentMetadata getDefaultInstanceForType()
Returns
TypeDescription
DocumentMetadata

getDisplayName()

public String getDisplayName()

The display name of the document.

string display_name = 6;

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the document.

string display_name = 6;

Returns
TypeDescription
ByteString

The bytes for displayName.

getDocumentId()

public DocumentId getDocumentId()

Document identifier.

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

Returns
TypeDescription
DocumentId

The documentId.

getDocumentIdOrBuilder()

public DocumentIdOrBuilder getDocumentIdOrBuilder()

Document identifier.

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

Returns
TypeDescription
DocumentIdOrBuilder

getLabelingState()

public DocumentLabelingState getLabelingState()

Labelling state of the document.

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

Returns
TypeDescription
DocumentLabelingState

The labelingState.

getLabelingStateValue()

public int getLabelingStateValue()

Labelling state of the document.

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

Returns
TypeDescription
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
TypeDescription
int

The pageCount.

getParserForType()

public Parser<DocumentMetadata> getParserForType()
Returns
TypeDescription
Parser<DocumentMetadata>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hasDocumentId()

public boolean hasDocumentId()

Document identifier.

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

Returns
TypeDescription
boolean

Whether the documentId field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentMetadata.Builder newBuilderForType()
Returns
TypeDescription
DocumentMetadata.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentMetadata.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentMetadata.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentMetadata.Builder toBuilder()
Returns
TypeDescription
DocumentMetadata.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException