Class Document.Provenance (2.49.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
Type Description
int

PARENTS_FIELD_NUMBER

public static final int PARENTS_FIELD_NUMBER
Field Value
Type Description
int

REVISION_FIELD_NUMBER

public static final int REVISION_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Document.Provenance getDefaultInstance()
Returns
Type Description
Document.Provenance

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Document.Provenance.Builder newBuilder()
Returns
Type Description
Document.Provenance.Builder

newBuilder(Document.Provenance prototype)

public static Document.Provenance.Builder newBuilder(Document.Provenance prototype)
Parameter
Name Description
prototype Document.Provenance
Returns
Type Description
Document.Provenance.Builder

parseDelimitedFrom(InputStream input)

public static Document.Provenance parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Document.Provenance parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Document.Provenance parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Document.Provenance parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Document.Provenance parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Document.Provenance parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Document.Provenance parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Provenance
Exceptions
Type Description
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Document.Provenance getDefaultInstanceForType()
Returns
Type Description
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=854

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

int32 id = 2 [deprecated = true];

Returns
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.cloud.documentai.v1beta2.Document.Provenance.ParentOrBuilder>

getParserForType()

public Parser<Document.Provenance> getParserForType()
Returns
Type Description
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=850

The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

Returns
Type Description
int

The revision.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getType()

public Document.Provenance.OperationType getType()

The type of provenance operation.

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

Returns
Type Description
Document.Provenance.OperationType

The type.

getTypeValue()

public int getTypeValue()

The type of provenance operation.

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

Returns
Type Description
int

The enum numeric value on the wire for type.

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Document.Provenance.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Document.Provenance.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public Document.Provenance.Builder toBuilder()
Returns
Type Description
Document.Provenance.Builder

writeTo(CodedOutputStream output)

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