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.



3976
3977
3978
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3976

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) 


3961
3962
3963
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3961

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) 


3969
3970
3971
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3969

def named_range_name
  @named_range_name
end

#text ⇒ String

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

Returns:

  • (String) 


3974
3975
3976
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3974

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3981
3982
3983
3984
3985
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3981

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)
  @text = args[:text] if args.key?(:text)
end