Class: Google::Apis::SheetsV4::UpdateCellsRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

Updates all cells in a range with new data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpdateCellsRequest

Returns a new instance of UpdateCellsRequest.



10479
10480
10481
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10479

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

Instance Attribute Details

#fields ⇒ String

The fields of CellData that should be updated. At least one field must be specified. The root is the CellData; 'row.values.' should not be specified. A single "*" can be used as short-hand for listing every field. Corresponds to the JSON property fields

Returns:

  • (String) 


10450
10451
10452
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10450

def fields
  @fields
end

#range ⇒ Google::Apis::SheetsV4::GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive -- [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if "Sheet1" is sheet ID 123456, then: Sheet1!A1:A1 == sheet_id: 123456, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1 Sheet1!A3:B4 == sheet_id: 123456, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1!A:B == sheet_id: 123456, start_column_index: 0, end_column_index: 2 Sheet1!A5:B == sheet_id: 123456, start_row_index: 4, start_column_index: 0, end_column_index: 2 Sheet1 == sheet_id: 123456 The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as #REF!. Corresponds to the JSON property range

Returns:



10467
10468
10469
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10467

def range
  @range
end

#rows ⇒ Array<Google::Apis::SheetsV4::RowData>

The data to write. Corresponds to the JSON property rows

Returns:



10472
10473
10474
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10472

def rows
  @rows
end

#start ⇒ Google::Apis::SheetsV4::GridCoordinate

A coordinate in a sheet. All indexes are zero-based. Corresponds to the JSON property start

Returns:



10477
10478
10479
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10477

def start
  @start
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10484
10485
10486
10487
10488
10489
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 10484

def update!(**args)
  @fields = args[:fields] if args.key?(:fields)
  @range = args[:range] if args.key?(:range)
  @rows = args[:rows] if args.key?(:rows)
  @start = args[:start] if args.key?(:start)
end