Class: Google::Apis::SheetsV4::UpdateCellsRequest
- Inherits:
-
Object
- Object
- Google::Apis::SheetsV4::UpdateCellsRequest
- 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
Updates all cells in a range with new data.
Instance Attribute Summary collapse
-
#fields ⇒ String
The fields of CellData that should be updated.
-
#range ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
-
#rows ⇒ Array<Google::Apis::SheetsV4::RowData>
The data to write.
-
#start ⇒ Google::Apis::SheetsV4::GridCoordinate
A coordinate in a sheet.
Instance Method Summary collapse
-
#initialize(**args) ⇒ UpdateCellsRequest
constructor
A new instance of UpdateCellsRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ UpdateCellsRequest
Returns a new instance of UpdateCellsRequest
5848 5849 5850 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5848 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
5840 5841 5842 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5840 def fields @fields end |
#range ⇒ Google::Apis::SheetsV4::GridRange
A range on a sheet.
All indexes are zero-based.
Indexes are half open, e.g 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 0, then:
Sheet1!A1:A1 == sheet_id: 0,
start_row_index: 0, end_row_index: 1,
start_column_index: 0, end_column_index: 1
Sheet1!A3:B4 == sheet_id: 0,
start_row_index: 2, end_row_index: 4,
start_column_index: 0, end_column_index: 2
Sheet1!A:B == sheet_id: 0,
start_column_index: 0, end_column_index: 2
Sheet1!A5:B == sheet_id: 0,
start_row_index: 4,
start_column_index: 0, end_column_index: 2
Sheet1 == sheet_id:0
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
5827 5828 5829 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5827 def range @range end |
#rows ⇒ Array<Google::Apis::SheetsV4::RowData>
The data to write.
Corresponds to the JSON property rows
5832 5833 5834 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5832 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
5846 5847 5848 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5846 def start @start end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
5853 5854 5855 5856 5857 5858 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 5853 def update!(**args) @range = args[:range] if args.key?(:range) @rows = args[:rows] if args.key?(:rows) @fields = args[:fields] if args.key?(:fields) @start = args[:start] if args.key?(:start) end |