Class: Google::Apis::SheetsV4::BatchUpdateSpreadsheetRequest

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 any aspect of 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) ⇒ BatchUpdateSpreadsheetRequest

Returns a new instance of BatchUpdateSpreadsheetRequest.


1532
1533
1534
# File 'generated/google/apis/sheets_v4/classes.rb', line 1532

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

Instance Attribute Details

#include_spreadsheet_in_responseBoolean Also known as: include_spreadsheet_in_response?

Determines if the update response should include the spreadsheet resource. Corresponds to the JSON property includeSpreadsheetInResponse

Returns:

  • (Boolean)

1508
1509
1510
# File 'generated/google/apis/sheets_v4/classes.rb', line 1508

def include_spreadsheet_in_response
  @include_spreadsheet_in_response
end

#requestsArray<Google::Apis::SheetsV4::Request>

A list of updates to apply to the spreadsheet. Requests will be applied in the order they are specified. If any request is not valid, no requests will be applied. Corresponds to the JSON property requests


1516
1517
1518
# File 'generated/google/apis/sheets_v4/classes.rb', line 1516

def requests
  @requests
end

#response_include_grid_dataBoolean Also known as: response_include_grid_data?

True if grid data should be returned. Meaningful only if include_spreadsheet_in_response is 'true'. This parameter is ignored if a field mask was set in the request. Corresponds to the JSON property responseIncludeGridData

Returns:

  • (Boolean)

1523
1524
1525
# File 'generated/google/apis/sheets_v4/classes.rb', line 1523

def response_include_grid_data
  @response_include_grid_data
end

#response_rangesArray<String>

Limits the ranges included in the response spreadsheet. Meaningful only if include_spreadsheet_in_response is 'true'. Corresponds to the JSON property responseRanges

Returns:

  • (Array<String>)

1530
1531
1532
# File 'generated/google/apis/sheets_v4/classes.rb', line 1530

def response_ranges
  @response_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1537
1538
1539
1540
1541
1542
# File 'generated/google/apis/sheets_v4/classes.rb', line 1537

def update!(**args)
  @include_spreadsheet_in_response = args[:include_spreadsheet_in_response] if args.key?(:include_spreadsheet_in_response)
  @requests = args[:requests] if args.key?(:requests)
  @response_include_grid_data = args[:response_include_grid_data] if args.key?(:response_include_grid_data)
  @response_ranges = args[:response_ranges] if args.key?(:response_ranges)
end