Class DocumentId (2.48.0)

Version 2.48.0

• 2.57.0 (latest)
• 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 DocumentId extends GeneratedMessageV3 implements DocumentIdOrBuilder

Document Identifier.

Protobuf type google.cloud.documentai.v1beta3.DocumentId

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentId

Implements

DocumentIdOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

GCS_MANAGED_DOC_ID_FIELD_NUMBER

public static final int GCS_MANAGED_DOC_ID_FIELD_NUMBER

Field Value
Type	Description
int

REVISION_REF_FIELD_NUMBER

public static final int REVISION_REF_FIELD_NUMBER

Field Value
Type	Description
int

UNMANAGED_DOC_ID_FIELD_NUMBER

public static final int UNMANAGED_DOC_ID_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static DocumentId getDefaultInstance()

Returns
Type	Description
DocumentId

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static DocumentId.Builder newBuilder()

Returns
Type	Description
DocumentId.Builder

newBuilder(DocumentId prototype)

public static DocumentId.Builder newBuilder(DocumentId prototype)

Parameter
Name	Description
prototype	DocumentId

Returns
Type	Description
DocumentId.Builder

parseDelimitedFrom(InputStream input)

public static DocumentId parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static DocumentId parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentId parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentId parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static DocumentId parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static DocumentId parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentId parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
DocumentId

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentId> parser()

Returns
Type	Description
Parser<DocumentId>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getDefaultInstanceForType()

public DocumentId getDefaultInstanceForType()

Returns
Type	Description
DocumentId

getGcsManagedDocId()

public DocumentId.GCSManagedDocumentId getGcsManagedDocId()

A document id within user-managed Cloud Storage.

.google.cloud.documentai.v1beta3.DocumentId.GCSManagedDocumentId gcs_managed_doc_id = 1;

Returns
Type	Description
DocumentId.GCSManagedDocumentId	The gcsManagedDocId.

getGcsManagedDocIdOrBuilder()

public DocumentId.GCSManagedDocumentIdOrBuilder getGcsManagedDocIdOrBuilder()

A document id within user-managed Cloud Storage.

.google.cloud.documentai.v1beta3.DocumentId.GCSManagedDocumentId gcs_managed_doc_id = 1;

Returns
Type	Description
DocumentId.GCSManagedDocumentIdOrBuilder

getParserForType()

public Parser<DocumentId> getParserForType()

Returns
Type	Description
Parser<DocumentId>

Overrides

GeneratedMessageV3.getParserForType()

getRevisionRef()

public RevisionRef getRevisionRef()

Points to a specific revision of the document if set.

.google.cloud.documentai.v1beta3.RevisionRef revision_ref = 3;

Returns
Type	Description
RevisionRef	The revisionRef.

getRevisionRefOrBuilder()

public RevisionRefOrBuilder getRevisionRefOrBuilder()

Points to a specific revision of the document if set.

.google.cloud.documentai.v1beta3.RevisionRef revision_ref = 3;

Returns
Type	Description
RevisionRefOrBuilder

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getTypeCase()

public DocumentId.TypeCase getTypeCase()

Returns
Type	Description
DocumentId.TypeCase

getUnmanagedDocId()

public DocumentId.UnmanagedDocumentId getUnmanagedDocId()

A document id within unmanaged dataset.

.google.cloud.documentai.v1beta3.DocumentId.UnmanagedDocumentId unmanaged_doc_id = 4;

Returns
Type	Description
DocumentId.UnmanagedDocumentId	The unmanagedDocId.

getUnmanagedDocIdOrBuilder()

public DocumentId.UnmanagedDocumentIdOrBuilder getUnmanagedDocIdOrBuilder()

A document id within unmanaged dataset.

.google.cloud.documentai.v1beta3.DocumentId.UnmanagedDocumentId unmanaged_doc_id = 4;

Returns
Type	Description
DocumentId.UnmanagedDocumentIdOrBuilder

hasGcsManagedDocId()

public boolean hasGcsManagedDocId()

A document id within user-managed Cloud Storage.

.google.cloud.documentai.v1beta3.DocumentId.GCSManagedDocumentId gcs_managed_doc_id = 1;

Returns
Type	Description
boolean	Whether the gcsManagedDocId field is set.

hasRevisionRef()

public boolean hasRevisionRef()

Points to a specific revision of the document if set.

.google.cloud.documentai.v1beta3.RevisionRef revision_ref = 3;

Returns
Type	Description
boolean	Whether the revisionRef field is set.

hasUnmanagedDocId()

public boolean hasUnmanagedDocId()

A document id within unmanaged dataset.

.google.cloud.documentai.v1beta3.DocumentId.UnmanagedDocumentId unmanaged_doc_id = 4;

Returns
Type	Description
boolean	Whether the unmanagedDocId field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public DocumentId.Builder newBuilderForType()

Returns
Type	Description
DocumentId.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentId.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
DocumentId.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public DocumentId.Builder toBuilder()

Returns
Type	Description
DocumentId.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException