com.google.cloud.documentai.v1beta3

Class DocumentId

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.DocumentId

All Implemented Interfaces:

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

public final class DocumentId
extends com.google.protobuf.GeneratedMessageV3
implements DocumentIdOrBuilder

 Document Identifier.
 

Protobuf type google.cloud.documentai.v1beta3.DocumentId

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DocumentId.Builder Document Identifier.
static class	DocumentId.GCSManagedDocumentId Identifies a document uniquely within the scope of a dataset in the user-managed Cloud Storage option.
static interface	DocumentId.GCSManagedDocumentIdOrBuilder
static class	DocumentId.TypeCase
static class	DocumentId.UnmanagedDocumentId Identifies a document uniquely within the scope of a dataset in unmanaged option.
static interface	DocumentId.UnmanagedDocumentIdOrBuilder

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	GCS_MANAGED_DOC_ID_FIELD_NUMBER
static int	REVISION_REF_FIELD_NUMBER
static int	UNMANAGED_DOC_ID_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)
static DocumentId	getDefaultInstance()
DocumentId	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
DocumentId.GCSManagedDocumentId	getGcsManagedDocId() A document id within user-managed Cloud Storage.
DocumentId.GCSManagedDocumentIdOrBuilder	getGcsManagedDocIdOrBuilder() A document id within user-managed Cloud Storage.
com.google.protobuf.Parser<DocumentId>	getParserForType()
RevisionRef	getRevisionRef() Points to a specific revision of the document if set.
RevisionRefOrBuilder	getRevisionRefOrBuilder() Points to a specific revision of the document if set.
int	getSerializedSize()
DocumentId.TypeCase	getTypeCase()
DocumentId.UnmanagedDocumentId	getUnmanagedDocId() A document id within unmanaged dataset.
DocumentId.UnmanagedDocumentIdOrBuilder	getUnmanagedDocIdOrBuilder() A document id within unmanaged dataset.
boolean	hasGcsManagedDocId() A document id within user-managed Cloud Storage.
int	hashCode()
boolean	hasRevisionRef() Points to a specific revision of the document if set.
boolean	hasUnmanagedDocId() A document id within unmanaged dataset.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static DocumentId.Builder	newBuilder()
static DocumentId.Builder	newBuilder(DocumentId prototype)
DocumentId.Builder	newBuilderForType()
protected DocumentId.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static DocumentId	parseDelimitedFrom(InputStream input)
static DocumentId	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentId	parseFrom(byte[] data)
static DocumentId	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentId	parseFrom(ByteBuffer data)
static DocumentId	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentId	parseFrom(com.google.protobuf.ByteString data)
static DocumentId	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentId	parseFrom(com.google.protobuf.CodedInputStream input)
static DocumentId	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static DocumentId	parseFrom(InputStream input)
static DocumentId	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<DocumentId>	parser()
DocumentId.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

GCS_MANAGED_DOC_ID_FIELD_NUMBER

public static final int GCS_MANAGED_DOC_ID_FIELD_NUMBER

See Also:

Constant Field Values

UNMANAGED_DOC_ID_FIELD_NUMBER

public static final int UNMANAGED_DOC_ID_FIELD_NUMBER

See Also:

Constant Field Values

REVISION_REF_FIELD_NUMBER

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

getTypeCase

public DocumentId.TypeCase getTypeCase()

Specified by:

getTypeCase in interface DocumentIdOrBuilder

hasGcsManagedDocId

public boolean hasGcsManagedDocId()

 A document id within user-managed Cloud Storage.
 

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

Specified by:

hasGcsManagedDocId in interface DocumentIdOrBuilder

Returns:

Whether the gcsManagedDocId field is set.

getGcsManagedDocId

public DocumentId.GCSManagedDocumentId getGcsManagedDocId()

 A document id within user-managed Cloud Storage.
 

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

Specified by:

getGcsManagedDocId in interface DocumentIdOrBuilder

Returns:

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;

Specified by:

getGcsManagedDocIdOrBuilder in interface DocumentIdOrBuilder

hasUnmanagedDocId

public boolean hasUnmanagedDocId()

 A document id within unmanaged dataset.
 

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

Specified by:

hasUnmanagedDocId in interface DocumentIdOrBuilder

Returns:

Whether the unmanagedDocId field is set.

getUnmanagedDocId

public DocumentId.UnmanagedDocumentId getUnmanagedDocId()

 A document id within unmanaged dataset.
 

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

Specified by:

getUnmanagedDocId in interface DocumentIdOrBuilder

Returns:

The unmanagedDocId.

getUnmanagedDocIdOrBuilder

public DocumentId.UnmanagedDocumentIdOrBuilder getUnmanagedDocIdOrBuilder()

 A document id within unmanaged dataset.
 

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

Specified by:

getUnmanagedDocIdOrBuilder in interface DocumentIdOrBuilder

hasRevisionRef

public boolean hasRevisionRef()

 Points to a specific revision of the document if set.
 

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

Specified by:

hasRevisionRef in interface DocumentIdOrBuilder

Returns:

Whether the revisionRef field is set.

getRevisionRef

public RevisionRef getRevisionRef()

 Points to a specific revision of the document if set.
 

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

Specified by:

getRevisionRef in interface DocumentIdOrBuilder

Returns:

The revisionRef.

getRevisionRefOrBuilder

public RevisionRefOrBuilder getRevisionRefOrBuilder()

 Points to a specific revision of the document if set.
 

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

Specified by:

getRevisionRefOrBuilder in interface DocumentIdOrBuilder

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 DocumentId parseFrom(ByteBuffer data)
                            throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static DocumentId parseFrom(InputStream input)
                            throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static DocumentId parseDelimitedFrom(InputStream input)
                                     throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public DocumentId.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static DocumentId.Builder newBuilder()

newBuilder

public static DocumentId.Builder newBuilder(DocumentId prototype)

toBuilder

public DocumentId.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

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

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static DocumentId getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<DocumentId> 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 DocumentId getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder