Class: Google::Apis::DocsV1::Range

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

Overview

Specifies a contiguous range of text.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Range

Returns a new instance of Range



3546
3547
3548
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3546

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

Instance Attribute Details

#end_index ⇒ Fixnum

The zero-based end index of this range, exclusive, in UTF-16 code units. In all current uses, an end index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


3531
3532
3533
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3531

def end_index
  @end_index
end

#segment_id ⇒ String

The ID of the header, footer or footnote that this range is contained in. An empty segment ID signifies the document's body. Corresponds to the JSON property segmentId

Returns:

  • (String) 


3537
3538
3539
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3537

def segment_id
  @segment_id
end

#start_index ⇒ Fixnum

The zero-based start index of this range, in UTF-16 code units. In all current uses, a start index must be provided. This field is an Int32Value in order to accommodate future use cases with open-ended ranges. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


3544
3545
3546
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3544

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3551
3552
3553
3554
3555
 
# File 'generated/google/apis/docs_v1/classes.rb', line 3551

def update!(**args)
  @end_index = args[:end_index] if args.key?(:end_index)
  @segment_id = args[:segment_id] if args.key?(:segment_id)
  @start_index = args[:start_index] if args.key?(:start_index)
end