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

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ BatchUpdateValuesByDataFilterRequest

Returns a new instance of BatchUpdateValuesByDataFilterRequest.


1617
1618
1619
# File 'generated/google/apis/sheets_v4/classes.rb', line 1617

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

Instance Attribute Details

#dataArray<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


1586
1587
1588
# File 'generated/google/apis/sheets_v4/classes.rb', line 1586

def data
  @data
end

#include_values_in_responseBoolean 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)

1596
1597
1598
# File 'generated/google/apis/sheets_v4/classes.rb', line 1596

def include_values_in_response
  @include_values_in_response
end

#response_date_time_render_optionString

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)

1604
1605
1606
# File 'generated/google/apis/sheets_v4/classes.rb', line 1604

def response_date_time_render_option
  @response_date_time_render_option
end

#response_value_render_optionString

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)

1610
1611
1612
# File 'generated/google/apis/sheets_v4/classes.rb', line 1610

def response_value_render_option
  @response_value_render_option
end

#value_input_optionString

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

Returns:

  • (String)

1615
1616
1617
# File 'generated/google/apis/sheets_v4/classes.rb', line 1615

def value_input_option
  @value_input_option
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1622
1623
1624
1625
1626
1627
1628
# File 'generated/google/apis/sheets_v4/classes.rb', line 1622

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