Class: Google::Apis::DocumentaiV1beta3::GoogleCloudDocumentaiV1beta3DocumentShardInfo

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) ⇒ GoogleCloudDocumentaiV1beta3DocumentShardInfo

Returns a new instance of GoogleCloudDocumentaiV1beta3DocumentShardInfo.



5087
5088
5089
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 5087

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

Instance Attribute Details

#shard_count ⇒ Fixnum

Total number of shards. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


5074
5075
5076
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 5074

def shard_count
  @shard_count
end

#shard_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


5079
5080
5081
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 5079

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) 


5085
5086
5087
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 5085

def text_offset
  @text_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5092
5093
5094
5095
5096
 
# File 'generated/google/apis/documentai_v1beta3/classes.rb', line 5092

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