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



6115
6116
6117
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6115

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

Instance Attribute Details

#include_spreadsheet_in_response ⇒ Boolean 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) 


6091
6092
6093
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6091

def include_spreadsheet_in_response
  @include_spreadsheet_in_response
end

#requests ⇒ Array<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

Returns:



6113
6114
6115
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6113

def requests
  @requests
end

#response_include_grid_data ⇒ Boolean Also known as: response_include_grid_data?

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

Returns:

  • (Boolean) 


6105
6106
6107
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6105

def response_include_grid_data
  @response_include_grid_data
end

#response_ranges ⇒ Array<String>

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

Returns:

  • (Array<String>) 


6098
6099
6100
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6098

def response_ranges
  @response_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6120
6121
6122
6123
6124
6125
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6120

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