Class DocumentId (2.38.0)

public final class DocumentId extends GeneratedMessageV3 implements DocumentIdOrBuilder

Document Identifier.

Protobuf type google.cloud.documentai.v1beta3.DocumentId

Implements

DocumentIdOrBuilder

Static Fields

GCS_MANAGED_DOC_ID_FIELD_NUMBER

public static final int GCS_MANAGED_DOC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_REF_FIELD_NUMBER

public static final int REVISION_REF_FIELD_NUMBER
Field Value
TypeDescription
int

UNMANAGED_DOC_ID_FIELD_NUMBER

public static final int UNMANAGED_DOC_ID_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentId getDefaultInstance()
Returns
TypeDescription
DocumentId

getDescriptor()

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

newBuilder()

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

newBuilder(DocumentId prototype)

public static DocumentId.Builder newBuilder(DocumentId prototype)
Parameter
NameDescription
prototypeDocumentId
Returns
TypeDescription
DocumentId.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public DocumentId getDefaultInstanceForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
DocumentId.GCSManagedDocumentIdOrBuilder

getParserForType()

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

getRevisionRef()

public RevisionRef getRevisionRef()

Points to a specific revision of the document if set.

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

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTypeCase()

public DocumentId.TypeCase getTypeCase()
Returns
TypeDescription
DocumentId.TypeCase

getUnmanagedDocId()

public DocumentId.UnmanagedDocumentId getUnmanagedDocId()

A document id within unmanaged dataset.

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

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

Whether the unmanagedDocId 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 DocumentId.Builder newBuilderForType()
Returns
TypeDescription
DocumentId.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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