Class Document.Provenance (2.33.0)

public static final class Document.Provenance extends GeneratedMessageV3 implements Document.ProvenanceOrBuilder

Structure to identify provenance relationships between annotations in different revisions.

Protobuf type google.cloud.documentai.v1beta2.Document.Provenance

Static Fields

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENTS_FIELD_NUMBER

public static final int PARENTS_FIELD_NUMBER
Field Value
TypeDescription
int

REVISION_FIELD_NUMBER

public static final int REVISION_FIELD_NUMBER
Field Value
TypeDescription
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Document.Provenance getDefaultInstance()
Returns
TypeDescription
Document.Provenance

getDescriptor()

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

newBuilder()

public static Document.Provenance.Builder newBuilder()
Returns
TypeDescription
Document.Provenance.Builder

newBuilder(Document.Provenance prototype)

public static Document.Provenance.Builder newBuilder(Document.Provenance prototype)
Parameter
NameDescription
prototypeDocument.Provenance
Returns
TypeDescription
Document.Provenance.Builder

parseDelimitedFrom(InputStream input)

public static Document.Provenance parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Provenance
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static Document.Provenance parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Document.Provenance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static Document.Provenance parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Document.Provenance
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static Document.Provenance parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Document.Provenance
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static Document.Provenance parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Document.Provenance
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<Document.Provenance> parser()
Returns
TypeDescription
Parser<Provenance>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public Document.Provenance getDefaultInstanceForType()
Returns
TypeDescription
Document.Provenance

getId() (deprecated)

public int getId()

Deprecated. google.cloud.documentai.v1beta2.Document.Provenance.id is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=853

The Id of this operation. Needs to be unique within the scope of the revision.

int32 id = 2 [deprecated = true];

Returns
TypeDescription
int

The id.

getParents(int index)

public Document.Provenance.Parent getParents(int index)

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1beta2.Document.Provenance.Parent parents = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Provenance.Parent

getParentsCount()

public int getParentsCount()

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1beta2.Document.Provenance.Parent parents = 3;

Returns
TypeDescription
int

getParentsList()

public List<Document.Provenance.Parent> getParentsList()

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1beta2.Document.Provenance.Parent parents = 3;

Returns
TypeDescription
List<Parent>

getParentsOrBuilder(int index)

public Document.Provenance.ParentOrBuilder getParentsOrBuilder(int index)

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1beta2.Document.Provenance.Parent parents = 3;

Parameter
NameDescription
indexint
Returns
TypeDescription
Document.Provenance.ParentOrBuilder

getParentsOrBuilderList()

public List<? extends Document.Provenance.ParentOrBuilder> getParentsOrBuilderList()

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1beta2.Document.Provenance.Parent parents = 3;

Returns
TypeDescription
List<? extends com.google.cloud.documentai.v1beta2.Document.Provenance.ParentOrBuilder>

getParserForType()

public Parser<Document.Provenance> getParserForType()
Returns
TypeDescription
Parser<Provenance>
Overrides

getRevision() (deprecated)

public int getRevision()

Deprecated. google.cloud.documentai.v1beta2.Document.Provenance.revision is deprecated. See google/cloud/documentai/v1beta2/document.proto;l=849

The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

Returns
TypeDescription
int

The revision.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getType()

public Document.Provenance.OperationType getType()

The type of provenance operation.

.google.cloud.documentai.v1beta2.Document.Provenance.OperationType type = 4;

Returns
TypeDescription
Document.Provenance.OperationType

The type.

getTypeValue()

public int getTypeValue()

The type of provenance operation.

.google.cloud.documentai.v1beta2.Document.Provenance.OperationType type = 4;

Returns
TypeDescription
int

The enum numeric value on the wire for type.

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 Document.Provenance.Builder newBuilderForType()
Returns
TypeDescription
Document.Provenance.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Document.Provenance.Builder toBuilder()
Returns
TypeDescription
Document.Provenance.Builder

writeTo(CodedOutputStream output)

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