Class Document.Revision.Builder (2.52.0)

public static final class Document.Revision.Builder extends GeneratedMessageV3.Builder<Document.Revision.Builder> implements Document.RevisionOrBuilder

Contains past or forward revisions of this document.

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

Static Methods

getDescriptor()

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

Methods

addAllParent(Iterable<? extends Integer> values) (deprecated)

public Document.Revision.Builder addAllParent(Iterable<? extends Integer> values)

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
Name Description
values Iterable<? extends java.lang.Integer>

The parent to add.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

addAllParentIds(Iterable<String> values)

public Document.Revision.Builder addAllParentIds(Iterable<String> values)

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
Name Description
values Iterable<String>

The parentIds to add.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

addParent(int value) (deprecated)

public Document.Revision.Builder addParent(int value)

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
Name Description
value int

The parent to add.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

addParentIds(String value)

public Document.Revision.Builder addParentIds(String value)

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
Name Description
value String

The parentIds to add.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

addParentIdsBytes(ByteString value)

public Document.Revision.Builder addParentIdsBytes(ByteString value)

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
Name Description
value ByteString

The bytes of the parentIds to add.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Document.Revision.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Revision.Builder
Overrides

build()

public Document.Revision build()
Returns
Type Description
Document.Revision

buildPartial()

public Document.Revision buildPartial()
Returns
Type Description
Document.Revision

clear()

public Document.Revision.Builder clear()
Returns
Type Description
Document.Revision.Builder
Overrides

clearAgent()

public Document.Revision.Builder clearAgent()

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

string agent = 4;

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

clearCreateTime()

public Document.Revision.Builder clearCreateTime()

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
Type Description
Document.Revision.Builder

clearField(Descriptors.FieldDescriptor field)

public Document.Revision.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Document.Revision.Builder
Overrides

clearHumanReview()

public Document.Revision.Builder clearHumanReview()

Human Review information of this revision.

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

Returns
Type Description
Document.Revision.Builder

clearId()

public Document.Revision.Builder clearId()

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

string id = 1;

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Revision.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Document.Revision.Builder
Overrides

clearParent() (deprecated)

public Document.Revision.Builder clearParent()

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
Type Description
Document.Revision.Builder

This builder for chaining.

clearParentIds()

public Document.Revision.Builder clearParentIds()

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
Type Description
Document.Revision.Builder

This builder for chaining.

clearProcessor()

public Document.Revision.Builder clearProcessor()

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

string processor = 5;

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

clearSource()

public Document.Revision.Builder clearSource()
Returns
Type Description
Document.Revision.Builder

clone()

public Document.Revision.Builder clone()
Returns
Type Description
Document.Revision.Builder
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
Type Description
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
Type Description
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
Type Description
Timestamp

The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Type Description
Builder

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
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Document.Revision getDefaultInstanceForType()
Returns
Type Description
Document.Revision

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getHumanReview()

public Document.Revision.HumanReview getHumanReview()

Human Review information of this revision.

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

Returns
Type Description
Document.Revision.HumanReview

The humanReview.

getHumanReviewBuilder()

public Document.Revision.HumanReview.Builder getHumanReviewBuilder()

Human Review information of this revision.

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

Returns
Type Description
Document.Revision.HumanReview.Builder

getHumanReviewOrBuilder()

public Document.Revision.HumanReviewOrBuilder getHumanReviewOrBuilder()

Human Review information of this revision.

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

Returns
Type Description
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
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Type Description
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
List<Integer>

A list containing the parent.

getProcessor()

public String getProcessor()

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

string processor = 5;

Returns
Type Description
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
Type Description
ByteString

The bytes for processor.

getSourceCase()

public Document.Revision.SourceCase getSourceCase()
Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
boolean

Whether the processor field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public Document.Revision.Builder mergeCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Document.Revision.Builder

mergeFrom(Document.Revision other)

public Document.Revision.Builder mergeFrom(Document.Revision other)
Parameter
Name Description
other Document.Revision
Returns
Type Description
Document.Revision.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Document.Revision.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Document.Revision.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Document.Revision.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Document.Revision.Builder
Overrides

mergeHumanReview(Document.Revision.HumanReview value)

public Document.Revision.Builder mergeHumanReview(Document.Revision.HumanReview value)

Human Review information of this revision.

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

Parameter
Name Description
value Document.Revision.HumanReview
Returns
Type Description
Document.Revision.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Revision.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Revision.Builder
Overrides

setAgent(String value)

public Document.Revision.Builder setAgent(String value)

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

string agent = 4;

Parameter
Name Description
value String

The agent to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setAgentBytes(ByteString value)

public Document.Revision.Builder setAgentBytes(ByteString value)

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

string agent = 4;

Parameter
Name Description
value ByteString

The bytes for agent to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public Document.Revision.Builder setCreateTime(Timestamp value)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
value Timestamp
Returns
Type Description
Document.Revision.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Document.Revision.Builder setCreateTime(Timestamp.Builder builderForValue)

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

.google.protobuf.Timestamp create_time = 3;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Document.Revision.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public Document.Revision.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Document.Revision.Builder
Overrides

setHumanReview(Document.Revision.HumanReview value)

public Document.Revision.Builder setHumanReview(Document.Revision.HumanReview value)

Human Review information of this revision.

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

Parameter
Name Description
value Document.Revision.HumanReview
Returns
Type Description
Document.Revision.Builder

setHumanReview(Document.Revision.HumanReview.Builder builderForValue)

public Document.Revision.Builder setHumanReview(Document.Revision.HumanReview.Builder builderForValue)

Human Review information of this revision.

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

Parameter
Name Description
builderForValue Document.Revision.HumanReview.Builder
Returns
Type Description
Document.Revision.Builder

setId(String value)

public Document.Revision.Builder setId(String value)

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

string id = 1;

Parameter
Name Description
value String

The id to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setIdBytes(ByteString value)

public Document.Revision.Builder setIdBytes(ByteString value)

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

string id = 1;

Parameter
Name Description
value ByteString

The bytes for id to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setParent(int index, int value) (deprecated)

public Document.Revision.Builder setParent(int index, int value)

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];

Parameters
Name Description
index int

The index to set the value at.

value int

The parent to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setParentIds(int index, String value)

public Document.Revision.Builder setParentIds(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The parentIds to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setProcessor(String value)

public Document.Revision.Builder setProcessor(String value)

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

string processor = 5;

Parameter
Name Description
value String

The processor to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setProcessorBytes(ByteString value)

public Document.Revision.Builder setProcessorBytes(ByteString value)

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

string processor = 5;

Parameter
Name Description
value ByteString

The bytes for processor to set.

Returns
Type Description
Document.Revision.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Document.Revision.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Document.Revision.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Revision.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Document.Revision.Builder
Overrides