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.



3951
3952
3953
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3951

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) 


3936
3937
3938
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3936

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) 


3944
3945
3946
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3944

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) 


3949
3950
3951
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3949

def text
  @text
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3956
3957
3958
3959
3960
 
# File 'lib/google/apis/docs_v1/classes.rb', line 3956

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