Class: Google::Apis::SheetsV4::SetDataValidationRequest

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

Sets a data validation rule to every cell in the range. To clear validation in a range, call this with no rule specified.

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

Returns a new instance of SetDataValidationRequest.


5121
5122
5123
# File 'generated/google/apis/sheets_v4/classes.rb', line 5121

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

Instance Attribute Details

#rangeGoogle::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


5119
5120
5121
# File 'generated/google/apis/sheets_v4/classes.rb', line 5119

def range
  @range
end

#ruleGoogle::Apis::SheetsV4::DataValidationRule

A data validation rule. Corresponds to the JSON property rule


5093
5094
5095
# File 'generated/google/apis/sheets_v4/classes.rb', line 5093

def rule
  @rule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


5126
5127
5128
5129
# File 'generated/google/apis/sheets_v4/classes.rb', line 5126

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