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.



3027
3028
3029
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3027

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

Instance Attribute Details

#shard_count ⇒ Fixnum

Total number of shards. Corresponds to the JSON property shardCount

Returns:

  • (Fixnum) 


3014
3015
3016
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3014

def shard_count
  @shard_count
end

#shard_index ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3019
3020
3021
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3019

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) 


3025
3026
3027
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3025

def text_offset
  @text_offset
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3032
3033
3034
3035
3036
 
# File 'lib/google/apis/documentai_v1/classes.rb', line 3032

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