Class: Google::Apis::DocsV1::ReplaceNamedRangeContentRequest

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

Overview

Replaces the contents of the specified NamedRange or NamedRanges with the given replacement content. Note that an individual NamedRange may consist of multiple discontinuous ranges. In this case, only the content in the first range will be replaced. The other ranges and their content will be deleted. In cases where replacing or deleting any ranges would result in an invalid document structure, a 400 bad request error is returned.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ReplaceNamedRangeContentRequest

Returns a new instance of ReplaceNamedRangeContentRequest.



4467
4468
4469
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4467

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

Instance Attribute Details

#named_range_id ⇒ String

The ID of the named range whose content will be replaced. If there is no named range with the given ID a 400 bad request error is returned. Corresponds to the JSON property namedRangeId

Returns:

  • (String) 


4447
4448
4449
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4447

def named_range_id
  @named_range_id
end

#named_range_name ⇒ String

The name of the NamedRanges whose content will be replaced. If there are multiple named ranges with the given name, then the content of each one will be replaced. If there are no named ranges with the given name, then the request will be a no-op. Corresponds to the JSON property namedRangeName

Returns:

  • (String) 


4455
4456
4457
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4455

def named_range_name
  @named_range_name
end

#tabs_criteria ⇒ Google::Apis::DocsV1::TabsCriteria

A criteria that specifies in which tabs a request executes. Corresponds to the JSON property tabsCriteria

Returns:



4460
4461
4462
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4460

def tabs_criteria
  @tabs_criteria
end

#text ⇒ String

Replaces the content of the specified named range(s) with the given text. Corresponds to the JSON property text

Returns:

  • (String) 


4465
4466
4467
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4465

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4472
4473
4474
4475
4476
4477
 
# File 'lib/google/apis/docs_v1/classes.rb', line 4472

def update!(**args)
  @named_range_id = args[:named_range_id] if args.key?(:named_range_id)
  @named_range_name = args[:named_range_name] if args.key?(:named_range_name)
  @tabs_criteria = args[:tabs_criteria] if args.key?(:tabs_criteria)
  @text = args[:text] if args.key?(:text)
end