Class Document.Revision (2.41.0)

public static final class Document.Revision extends GeneratedMessageV3 implements Document.RevisionOrBuilder

Contains past or forward revisions of this document.

Protobuf type google.cloud.documentai.v1.Document.Revision

Static Fields

AGENT_FIELD_NUMBER

public static final int AGENT_FIELD_NUMBER
Field Value
TypeDescription
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
TypeDescription
int

HUMAN_REVIEW_FIELD_NUMBER

public static final int HUMAN_REVIEW_FIELD_NUMBER
Field Value
TypeDescription
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
TypeDescription
int

PARENT_IDS_FIELD_NUMBER

public static final int PARENT_IDS_FIELD_NUMBER
Field Value
TypeDescription
int

PROCESSOR_FIELD_NUMBER

public static final int PROCESSOR_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(Document.Revision prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAgent()

public String getAgent()

If the change was made by a person specify the name or id of that person.

string agent = 4;

Returns
TypeDescription
String

The agent.

getAgentBytes()

public ByteString getAgentBytes()

If the change was made by a person specify the name or id of that person.

string agent = 4;

Returns
TypeDescription
ByteString

The bytes for agent.

getCreateTime()

public Timestamp getCreateTime()

The time that the revision was created, internally generated by doc proto storage at the time of create.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

The time that the revision was created, internally generated by doc proto storage at the time of create.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
TimestampOrBuilder

getDefaultInstanceForType()

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

getHumanReview()

public Document.Revision.HumanReview getHumanReview()

Human Review information of this revision.

.google.cloud.documentai.v1.Document.Revision.HumanReview human_review = 6;

Returns
TypeDescription
Document.Revision.HumanReview

The humanReview.

getHumanReviewOrBuilder()

public Document.Revision.HumanReviewOrBuilder getHumanReviewOrBuilder()

Human Review information of this revision.

.google.cloud.documentai.v1.Document.Revision.HumanReview human_review = 6;

Returns
TypeDescription
Document.Revision.HumanReviewOrBuilder

getId()

public String getId()

Id of the revision, internally generated by doc proto storage. Unique within the context of the document.

string id = 1;

Returns
TypeDescription
String

The id.

getIdBytes()

public ByteString getIdBytes()

Id of the revision, internally generated by doc proto storage. Unique within the context of the document.

string id = 1;

Returns
TypeDescription
ByteString

The bytes for id.

getParent(int index) (deprecated)

public int getParent(int index)

Deprecated. google.cloud.documentai.v1.Document.Revision.parent is deprecated. See google/cloud/documentai/v1/document.proto;l=863

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

repeated int32 parent = 2 [deprecated = true];

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
int

The parent at the given index.

getParentCount() (deprecated)

public int getParentCount()

Deprecated. google.cloud.documentai.v1.Document.Revision.parent is deprecated. See google/cloud/documentai/v1/document.proto;l=863

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

repeated int32 parent = 2 [deprecated = true];

Returns
TypeDescription
int

The count of parent.

getParentIds(int index)

public String getParentIds(int index)

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

repeated string parent_ids = 7;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The parentIds at the given index.

getParentIdsBytes(int index)

public ByteString getParentIdsBytes(int index)

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

repeated string parent_ids = 7;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the parentIds at the given index.

getParentIdsCount()

public int getParentIdsCount()

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

repeated string parent_ids = 7;

Returns
TypeDescription
int

The count of parentIds.

getParentIdsList()

public ProtocolStringList getParentIdsList()

The revisions that this revision is based on. Must include all the ids that have anything to do with this revision - eg. there are provenance.parent.revision fields that index into this field.

repeated string parent_ids = 7;

Returns
TypeDescription
ProtocolStringList

A list containing the parentIds.

getParentList() (deprecated)

public List<Integer> getParentList()

Deprecated. google.cloud.documentai.v1.Document.Revision.parent is deprecated. See google/cloud/documentai/v1/document.proto;l=863

The revisions that this revision is based on. This can include one or more parent (when documents are merged.) This field represents the index into the revisions field.

repeated int32 parent = 2 [deprecated = true];

Returns
TypeDescription
List<Integer>

A list containing the parent.

getParserForType()

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

getProcessor()

public String getProcessor()

If the annotation was made by processor identify the processor by its resource name.

string processor = 5;

Returns
TypeDescription
String

The processor.

getProcessorBytes()

public ByteString getProcessorBytes()

If the annotation was made by processor identify the processor by its resource name.

string processor = 5;

Returns
TypeDescription
ByteString

The bytes for processor.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getSourceCase()

public Document.Revision.SourceCase getSourceCase()
Returns
TypeDescription
Document.Revision.SourceCase

hasAgent()

public boolean hasAgent()

If the change was made by a person specify the name or id of that person.

string agent = 4;

Returns
TypeDescription
boolean

Whether the agent field is set.

hasCreateTime()

public boolean hasCreateTime()

The time that the revision was created, internally generated by doc proto storage at the time of create.

.google.protobuf.Timestamp create_time = 3;

Returns
TypeDescription
boolean

Whether the createTime field is set.

hasHumanReview()

public boolean hasHumanReview()

Human Review information of this revision.

.google.cloud.documentai.v1.Document.Revision.HumanReview human_review = 6;

Returns
TypeDescription
boolean

Whether the humanReview field is set.

hasProcessor()

public boolean hasProcessor()

If the annotation was made by processor identify the processor by its resource name.

string processor = 5;

Returns
TypeDescription
boolean

Whether the processor 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 Document.Revision.Builder newBuilderForType()
Returns
TypeDescription
Document.Revision.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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