Class Document.Provenance.Builder (2.87.0)

public static final class Document.Provenance.Builder extends GeneratedMessage.Builder<Document.Provenance.Builder> implements Document.ProvenanceOrBuilder

Structure to identify provenance relationships between annotations in different revisions.

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

Static Methods

getDescriptor()

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

Methods

addAllParents(Iterable<? extends Document.Provenance.Parent> values)

public Document.Provenance.Builder addAllParents(Iterable<? extends Document.Provenance.Parent> values)

References to the original elements that are replaced.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.documentai.v1.Document.Provenance.Parent>
Returns
Type Description
Document.Provenance.Builder

addParents(Document.Provenance.Parent value)

public Document.Provenance.Builder addParents(Document.Provenance.Parent value)

References to the original elements that are replaced.

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

Parameter
Name Description
value Document.Provenance.Parent
Returns
Type Description
Document.Provenance.Builder

addParents(Document.Provenance.Parent.Builder builderForValue)

public Document.Provenance.Builder addParents(Document.Provenance.Parent.Builder builderForValue)

References to the original elements that are replaced.

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

Parameter
Name Description
builderForValue Document.Provenance.Parent.Builder
Returns
Type Description
Document.Provenance.Builder

addParents(int index, Document.Provenance.Parent value)

public Document.Provenance.Builder addParents(int index, Document.Provenance.Parent value)

References to the original elements that are replaced.

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

Parameters
Name Description
index int
value Document.Provenance.Parent
Returns
Type Description
Document.Provenance.Builder

addParents(int index, Document.Provenance.Parent.Builder builderForValue)

public Document.Provenance.Builder addParents(int index, Document.Provenance.Parent.Builder builderForValue)

References to the original elements that are replaced.

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

Parameters
Name Description
index int
builderForValue Document.Provenance.Parent.Builder
Returns
Type Description
Document.Provenance.Builder

addParentsBuilder()

public Document.Provenance.Parent.Builder addParentsBuilder()

References to the original elements that are replaced.

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

Returns
Type Description
Document.Provenance.Parent.Builder

addParentsBuilder(int index)

public Document.Provenance.Parent.Builder addParentsBuilder(int index)

References to the original elements that are replaced.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Provenance.Parent.Builder

build()

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

buildPartial()

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

clear()

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

clearId() (deprecated)

public Document.Provenance.Builder clearId()

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

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

int32 id = 2 [deprecated = true];

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

clearParents()

public Document.Provenance.Builder clearParents()

References to the original elements that are replaced.

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

Returns
Type Description
Document.Provenance.Builder

clearRevision() (deprecated)

public Document.Provenance.Builder clearRevision()

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

The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

clearType()

public Document.Provenance.Builder clearType()

The type of provenance operation.

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

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

getDefaultInstanceForType()

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

getDescriptorForType()

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

getId() (deprecated)

public int getId()

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

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.v1.Document.Provenance.Parent parents = 3;

Parameter
Name Description
index int
Returns
Type Description
Document.Provenance.Parent

getParentsBuilder(int index)

public Document.Provenance.Parent.Builder getParentsBuilder(int index)

References to the original elements that are replaced.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Provenance.Parent.Builder

getParentsBuilderList()

public List<Document.Provenance.Parent.Builder> getParentsBuilderList()

References to the original elements that are replaced.

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

Returns
Type Description
List<Builder>

getParentsCount()

public int getParentsCount()

References to the original elements that are replaced.

repeated .google.cloud.documentai.v1.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.v1.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.v1.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.v1.Document.Provenance.Parent parents = 3;

Returns
Type Description
List<? extends com.google.cloud.documentai.v1.Document.Provenance.ParentOrBuilder>

getRevision() (deprecated)

public int getRevision()

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

The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

Returns
Type Description
int

The revision.

getType()

public Document.Provenance.OperationType getType()

The type of provenance operation.

.google.cloud.documentai.v1.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.v1.Document.Provenance.OperationType type = 4;

Returns
Type Description
int

The enum numeric value on the wire for type.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Document.Provenance other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

removeParents(int index)

public Document.Provenance.Builder removeParents(int index)

References to the original elements that are replaced.

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

Parameter
Name Description
index int
Returns
Type Description
Document.Provenance.Builder

setId(int value) (deprecated)

public Document.Provenance.Builder setId(int value)

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

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

int32 id = 2 [deprecated = true];

Parameter
Name Description
value int

The id to set.

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

setParents(int index, Document.Provenance.Parent value)

public Document.Provenance.Builder setParents(int index, Document.Provenance.Parent value)

References to the original elements that are replaced.

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

Parameters
Name Description
index int
value Document.Provenance.Parent
Returns
Type Description
Document.Provenance.Builder

setParents(int index, Document.Provenance.Parent.Builder builderForValue)

public Document.Provenance.Builder setParents(int index, Document.Provenance.Parent.Builder builderForValue)

References to the original elements that are replaced.

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

Parameters
Name Description
index int
builderForValue Document.Provenance.Parent.Builder
Returns
Type Description
Document.Provenance.Builder

setRevision(int value) (deprecated)

public Document.Provenance.Builder setRevision(int value)

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

The index of the revision that produced this element.

int32 revision = 1 [deprecated = true];

Parameter
Name Description
value int

The revision to set.

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

setType(Document.Provenance.OperationType value)

public Document.Provenance.Builder setType(Document.Provenance.OperationType value)

The type of provenance operation.

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

Parameter
Name Description
value Document.Provenance.OperationType

The type to set.

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.

setTypeValue(int value)

public Document.Provenance.Builder setTypeValue(int value)

The type of provenance operation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.

Returns
Type Description
Document.Provenance.Builder

This builder for chaining.