Class: Google::Apis::SheetsV4::DataSourceParameter

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

A parameter in a data source's query. The parameter allows the user to pass in values from the spreadsheet into a query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataSourceParameter

Returns a new instance of DataSourceParameter.



4006
4007
4008
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4006

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

Instance Attribute Details

#name ⇒ String

Named parameter. Must be a legitimate identifier for the DataSource that supports it. For example, BigQuery identifier. Corresponds to the JSON property name

Returns:

  • (String) 


3982
3983
3984
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3982

def name
  @name
end

#named_range_id ⇒ String

ID of a NamedRange. Its size must be 1x1. Corresponds to the JSON property namedRangeId

Returns:

  • (String) 


3987
3988
3989
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 3987

def named_range_id
  @named_range_id
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 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

Returns:



4004
4005
4006
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4004

def range
  @range
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4011
4012
4013
4014
4015
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4011

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