Class: Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::BatchUpdateValuesByDataFilterRequest
- 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
-
#data ⇒ Array<Google::Apis::SheetsV4::DataFilterValueRange>
The new values to apply to the spreadsheet.
-
#include_values_in_response ⇒ Boolean
(also: #include_values_in_response?)
Determines if the update response should include the values of the cells that were updated.
-
#response_date_time_render_option ⇒ String
Determines how dates, times, and durations in the response should be rendered.
-
#response_value_render_option ⇒ String
Determines how values in the response should be rendered.
-
#value_input_option ⇒ String
How the input data should be interpreted.
Instance Method Summary collapse
-
#initialize(**args) ⇒ BatchUpdateValuesByDataFilterRequest
constructor
A new instance of BatchUpdateValuesByDataFilterRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ BatchUpdateValuesByDataFilterRequest
Returns a new instance of BatchUpdateValuesByDataFilterRequest
1563 1564 1565 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1563 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 will be
applied to all of those ranges.
Corresponds to the JSON property data
1529 1530 1531 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1529 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 will contain
the updated values. If the range to write was larger than than the range
actually written, the response will include all values in the requested
range (excluding trailing empty rows and columns).
Corresponds to the JSON property includeValuesInResponse
1540 1541 1542 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1540 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
1550 1551 1552 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1550 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
1556 1557 1558 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1556 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
1561 1562 1563 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1561 def value_input_option @value_input_option end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
1568 1569 1570 1571 1572 1573 1574 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 1568 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 |