Class: Google::Apis::DocumentaiV1::GoogleCloudDocumentaiV1DocumentShardInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/documentai_v1/classes.rb,
lib/google/apis/documentai_v1/representations.rb,
lib/google/apis/documentai_v1/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) ⇒ GoogleCloudDocumentaiV1DocumentShardInfo

Returns a new instance of GoogleCloudDocumentaiV1DocumentShardInfo.



3609
3610
3611
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3609

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

Instance Attribute Details

#shard_count ⇒ Fixnum

Total number of shards. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


3596
3597
3598
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3596

def shard_count
  @shard_count
end

#shard_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3601
3602
3603
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3601

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) 


3607
3608
3609
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3607

def text_offset
  @text_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3614
3615
3616
3617
3618
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3614

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