Class Document.ShardInfo.Builder (2.51.0)

public static final class Document.ShardInfo.Builder extends GeneratedMessageV3.Builder<Document.ShardInfo.Builder> implements Document.ShardInfoOrBuilder

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

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

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

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

buildPartial()

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

clear()

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

clearField(Descriptors.FieldDescriptor field)

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

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearShardCount()

public Document.ShardInfo.Builder clearShardCount()

Total number of shards.

int64 shard_count = 2;

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

clearShardIndex()

public Document.ShardInfo.Builder clearShardIndex()

The 0-based index of this shard.

int64 shard_index = 1;

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

clearTextOffset()

public Document.ShardInfo.Builder clearTextOffset()

The index of the first character in Document.text in the overall document global text.

int64 text_offset = 3;

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

clone()

public Document.ShardInfo.Builder clone()
Returns
Type Description
Document.ShardInfo.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

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

getShardCount()

public long getShardCount()

Total number of shards.

int64 shard_count = 2;

Returns
Type Description
long

The shardCount.

getShardIndex()

public long getShardIndex()

The 0-based index of this shard.

int64 shard_index = 1;

Returns
Type Description
long

The shardIndex.

getTextOffset()

public long getTextOffset()

The index of the first character in Document.text in the overall document global text.

int64 text_offset = 3;

Returns
Type Description
long

The textOffset.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Document.ShardInfo other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

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

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

setShardCount(long value)

public Document.ShardInfo.Builder setShardCount(long value)

Total number of shards.

int64 shard_count = 2;

Parameter
Name Description
value long

The shardCount to set.

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

setShardIndex(long value)

public Document.ShardInfo.Builder setShardIndex(long value)

The 0-based index of this shard.

int64 shard_index = 1;

Parameter
Name Description
value long

The shardIndex to set.

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

setTextOffset(long value)

public Document.ShardInfo.Builder setTextOffset(long value)

The index of the first character in Document.text in the overall document global text.

int64 text_offset = 3;

Parameter
Name Description
value long

The textOffset to set.

Returns
Type Description
Document.ShardInfo.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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