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
2202 2203 2204 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2202 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
2195 2196 2197 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2195 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
2187 2188 2189 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2187 def range @range end |
#rows ⇒ Array<Google::Apis::SheetsV4::RowData>
The data to write.
Corresponds to the JSON property rows
2200 2201 2202 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2200 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
2161 2162 2163 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2161 def start @start end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2207 2208 2209 2210 2211 2212 |
# File 'generated/google/apis/sheets_v4/classes.rb', line 2207 def update!(**args) @start = args[:start] if args.key?(:start) @range = args[:range] if args.key?(:range) @fields = args[:fields] if args.key?(:fields) @rows = args[:rows] if args.key?(:rows) end |