Class: Google::Apis::DocumentaiV1beta2::GoogleCloudDocumentaiV1beta2DocumentShardInfo

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

Returns a new instance of GoogleCloudDocumentaiV1beta2DocumentShardInfo.



3270
3271
3272
 
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 3270

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

Instance Attribute Details

#shard_count ⇒ Fixnum

Total number of shards. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


3257
3258
3259
 
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 3257

def shard_count
  @shard_count
end

#shard_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3262
3263
3264
 
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 3262

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) 


3268
3269
3270
 
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 3268

def text_offset
  @text_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3275
3276
3277
3278
3279
 
# File 'generated/google/apis/documentai_v1beta2/classes.rb', line 3275

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