Class: Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest

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

Overview

The request for updating more than one range of values in a spreadsheet.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ BatchUpdateValuesByDataFilterRequest

Returns a new instance of BatchUpdateValuesByDataFilterRequest.



1798
1799
1800
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1798

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

Instance Attribute Details

#data ⇒ Array<Google::Apis::SheetsV4::DataFilterValueRange>

The new values to apply to the spreadsheet. If more than one range is matched by the specified DataFilter the specified values are applied to all of those ranges. Corresponds to the JSON property data

Returns:



1767
1768
1769
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1767

def data
  @data
end

#include_values_in_response ⇒ Boolean Also known as: include_values_in_response?

Determines if the update response should include the values of the cells that were updated. By default, responses do not include the updated values. The updatedData field within each of the BatchUpdateValuesResponse.responses contains the updated values. If the range to write was larger than the range actually written, the response includes all values in the requested range ( excluding trailing empty rows and columns). Corresponds to the JSON property includeValuesInResponse

Returns:

  • (Boolean) 


1777
1778
1779
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1777

def include_values_in_response
  @include_values_in_response
end

#response_date_time_render_option ⇒ String

Determines how dates, times, and durations in the response should be rendered. This is ignored if response_value_render_option is FORMATTED_VALUE. The default dateTime render option is DateTimeRenderOption.SERIAL_NUMBER. Corresponds to the JSON property responseDateTimeRenderOption

Returns:

  • (String) 


1785
1786
1787
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1785

def response_date_time_render_option
  @response_date_time_render_option
end

#response_value_render_option ⇒ String

Determines how values in the response should be rendered. The default render option is ValueRenderOption.FORMATTED_VALUE. Corresponds to the JSON property responseValueRenderOption

Returns:

  • (String) 


1791
1792
1793
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1791

def response_value_render_option
  @response_value_render_option
end

#value_input_option ⇒ String

How the input data should be interpreted. Corresponds to the JSON property valueInputOption

Returns:

  • (String) 


1796
1797
1798
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1796

def value_input_option
  @value_input_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1803
1804
1805
1806
1807
1808
1809
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 1803

def update!(**args)
  @data = args[:data] if args.key?(:data)
  @include_values_in_response = args[:include_values_in_response] if args.key?(:include_values_in_response)
  @response_date_time_render_option = args[:response_date_time_render_option] if args.key?(:response_date_time_render_option)
  @response_value_render_option = args[:response_value_render_option] if args.key?(:response_value_render_option)
  @value_input_option = args[:value_input_option] if args.key?(:value_input_option)
end