com.google.cloud.documentai.v1beta3

Class DocumentMetadata

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.DocumentMetadata

All Implemented Interfaces:

DocumentMetadataOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class DocumentMetadata
extends com.google.protobuf.GeneratedMessageV3
implements DocumentMetadataOrBuilder

 Metadata about a document.
 

Protobuf type google.cloud.documentai.v1beta3.DocumentMetadata

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentMetadata.Builder Metadata about a document.

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	DATASET_TYPE_FIELD_NUMBER
static int	DISPLAY_NAME_FIELD_NUMBER
static int	DOCUMENT_ID_FIELD_NUMBER
static int	LABELING_STATE_FIELD_NUMBER
static int	PAGE_COUNT_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

Modifier and Type	Method and Description
boolean	equals(Object obj)
DatasetSplitType	getDatasetType() Type of the dataset split to which the document belongs.
int	getDatasetTypeValue() Type of the dataset split to which the document belongs.
static DocumentMetadata	getDefaultInstance()
DocumentMetadata	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getDisplayName() The display name of the document.
com.google.protobuf.ByteString	getDisplayNameBytes() The display name of the document.
DocumentId	getDocumentId() Document identifier.
DocumentIdOrBuilder	getDocumentIdOrBuilder() Document identifier.
DocumentLabelingState	getLabelingState() Labeling state of the document.
int	getLabelingStateValue() Labeling state of the document.
int	getPageCount() Number of pages in the document.
com.google.protobuf.Parser<DocumentMetadata>	getParserForType()
int	getSerializedSize()
boolean	hasDocumentId() Document identifier.
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentMetadata.Builder	newBuilder()
static DocumentMetadata.Builder	newBuilder(DocumentMetadata prototype)
DocumentMetadata.Builder	newBuilderForType()
protected DocumentMetadata.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentMetadata	parseDelimitedFrom(InputStream input)
static DocumentMetadata	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMetadata	parseFrom(byte[] data)
static DocumentMetadata	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMetadata	parseFrom(ByteBuffer data)
static DocumentMetadata	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMetadata	parseFrom(com.google.protobuf.ByteString data)
static DocumentMetadata	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentMetadata	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentMetadata	parseFrom(InputStream input)
static DocumentMetadata	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentMetadata>	parser()
DocumentMetadata.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

DOCUMENT_ID_FIELD_NUMBER

public static final int DOCUMENT_ID_FIELD_NUMBER

See Also:

Constant Field Values

PAGE_COUNT_FIELD_NUMBER

public static final int PAGE_COUNT_FIELD_NUMBER

See Also:

Constant Field Values

DATASET_TYPE_FIELD_NUMBER

public static final int DATASET_TYPE_FIELD_NUMBER

See Also:

Constant Field Values

LABELING_STATE_FIELD_NUMBER

public static final int LABELING_STATE_FIELD_NUMBER

See Also:

Constant Field Values

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_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

hasDocumentId

public boolean hasDocumentId()

 Document identifier.
 

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

Specified by:

hasDocumentId in interface DocumentMetadataOrBuilder

Returns:

Whether the documentId field is set.

getDocumentId

public DocumentId getDocumentId()

 Document identifier.
 

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

Specified by:

getDocumentId in interface DocumentMetadataOrBuilder

Returns:

The documentId.

getDocumentIdOrBuilder

public DocumentIdOrBuilder getDocumentIdOrBuilder()

 Document identifier.
 

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

Specified by:

getDocumentIdOrBuilder in interface DocumentMetadataOrBuilder

getPageCount

public int getPageCount()

 Number of pages in the document.
 

int32 page_count = 2;

Specified by:

getPageCount in interface DocumentMetadataOrBuilder

Returns:

The pageCount.

getDatasetTypeValue

public int getDatasetTypeValue()

 Type of the dataset split to which the document belongs.
 

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

Specified by:

getDatasetTypeValue in interface DocumentMetadataOrBuilder

Returns:

The enum numeric value on the wire for datasetType.

getDatasetType

public DatasetSplitType getDatasetType()

 Type of the dataset split to which the document belongs.
 

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

Specified by:

getDatasetType in interface DocumentMetadataOrBuilder

Returns:

The datasetType.

getLabelingStateValue

public int getLabelingStateValue()

 Labeling state of the document.
 

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

Specified by:

getLabelingStateValue in interface DocumentMetadataOrBuilder

Returns:

The enum numeric value on the wire for labelingState.

getLabelingState

public DocumentLabelingState getLabelingState()

 Labeling state of the document.
 

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

Specified by:

getLabelingState in interface DocumentMetadataOrBuilder

Returns:

The labelingState.

getDisplayName

public String getDisplayName()

 The display name of the document.
 

string display_name = 6;

Specified by:

getDisplayName in interface DocumentMetadataOrBuilder

Returns:

The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

 The display name of the document.
 

string display_name = 6;

Specified by:

getDisplayNameBytes in interface DocumentMetadataOrBuilder

Returns:

The bytes for displayName.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static DocumentMetadata parseFrom(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentMetadata parseFrom(InputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DocumentMetadata parseFrom(InputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentMetadata parseDelimitedFrom(InputStream input)
                                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static DocumentMetadata parseDelimitedFrom(InputStream input,
                                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                           throws IOException

Throws:

IOException

parseFrom

public static DocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input)
                                  throws IOException

Throws:

IOException

parseFrom

public static DocumentMetadata parseFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException

Throws:

IOException

newBuilderForType

public DocumentMetadata.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentMetadata.Builder newBuilder()

newBuilder

public static DocumentMetadata.Builder newBuilder(DocumentMetadata prototype)

toBuilder

public DocumentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected DocumentMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentMetadata getDefaultInstance()

parser

public static com.google.protobuf.Parser<DocumentMetadata> parser()

getParserForType

public com.google.protobuf.Parser<DocumentMetadata> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public DocumentMetadata getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder