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.



1993
1994
1995
# File 'generated/google/apis/sheets_v4/classes.rb', line 1993

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)


1969
1970
1971
# File 'generated/google/apis/sheets_v4/classes.rb', line 1969

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



1977
1978
1979
# File 'generated/google/apis/sheets_v4/classes.rb', line 1977

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)


1984
1985
1986
# File 'generated/google/apis/sheets_v4/classes.rb', line 1984

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


1991
1992
1993
# File 'generated/google/apis/sheets_v4/classes.rb', line 1991

def response_ranges
  @response_ranges
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1998
1999
2000
2001
2002
2003
# File 'generated/google/apis/sheets_v4/classes.rb', line 1998

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