Class DocumentId (2.57.0) 

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

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

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

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

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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