Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta1DocumentShardInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/documentai_v1beta3/classes.rb,
generated/google/apis/documentai_v1beta3/representations.rb,
generated/google/apis/documentai_v1beta3/representations.rb

Overview

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDocumentaiV1beta1DocumentShardInfo

Returns a new instance of GoogleCloudDocumentaiV1beta1DocumentShardInfo.



1497
1498
1499
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1497

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#shard_count ⇒ Fixnum

Total number of shards. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


1484
1485
1486
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1484

def shard_count
  @shard_count
end

#shard_index ⇒ Fixnum

The 0-based index of this shard. Corresponds to the JSON property shardIndex

Returns:

  • (Fixnum) 


1489
1490
1491
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1489

def shard_index
  @shard_index
end

#text_offset ⇒ Fixnum

The index of the first character in Document.text in the overall document global text. Corresponds to the JSON property textOffset

Returns:

  • (Fixnum) 


1495
1496
1497
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1495

def text_offset
  @text_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1502
1503
1504
1505
1506
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 1502

def update!(**args)
  @shard_count = args[:shard_count] if args.key?(:shard_count)
  @shard_index = args[:shard_index] if args.key?(:shard_index)
  @text_offset = args[:text_offset] if args.key?(:text_offset)
end