Class: Google::Apis::SheetsV4::DataSourceTable

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 data source table, which allows the user to import a static table of data from the DataSource into Sheets. This is also known as "Extract" in the Sheets editor.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataSourceTable

Returns a new instance of DataSourceTable.



4297
4298
4299
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4297

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

Instance Attribute Details

#column_selection_type ⇒ String

The type to select columns for the data source table. Defaults to SELECTED. Corresponds to the JSON property columnSelectionType

Returns:

  • (String) 


4254
4255
4256
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4254

def column_selection_type
  @column_selection_type
end

#columns ⇒ Array<Google::Apis::SheetsV4::DataSourceColumnReference>

Columns selected for the data source table. The column_selection_type must be SELECTED. Corresponds to the JSON property columns

Returns:



4260
4261
4262
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4260

def columns
  @columns
end

#data_execution_status ⇒ Google::Apis::SheetsV4::DataExecutionStatus

The data execution status. A data execution is created to sync a data source object with the latest data from a DataSource. It is usually scheduled to run at background, you can check its state to tell if an execution completes There are several scenarios where a data execution is triggered to run: * Adding a data source creates an associated data source sheet as well as a data execution to sync the data from the data source to the sheet. * Updating a data source creates a data execution to refresh the associated data source sheet similarly. * You can send refresh request to explicitly refresh one or multiple data source objects. Corresponds to the JSON property dataExecutionStatus

Returns:



4273
4274
4275
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4273

def data_execution_status
  @data_execution_status
end

#data_source_id ⇒ String

The ID of the data source the data source table is associated with. Corresponds to the JSON property dataSourceId

Returns:

  • (String) 


4278
4279
4280
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4278

def data_source_id
  @data_source_id
end

#filter_specs ⇒ Array<Google::Apis::SheetsV4::FilterSpec>

Filter specifications in the data source table. Corresponds to the JSON property filterSpecs

Returns:



4283
4284
4285
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4283

def filter_specs
  @filter_specs
end

#row_limit ⇒ Fixnum

The limit of rows to return. If not set, a default limit is applied. Please refer to the Sheets editor for the default and max limit. Corresponds to the JSON property rowLimit

Returns:

  • (Fixnum) 


4289
4290
4291
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4289

def row_limit
  @row_limit
end

#sort_specs ⇒ Array<Google::Apis::SheetsV4::SortSpec>

Sort specifications in the data source table. The result of the data source table is sorted based on the sort specifications in order. Corresponds to the JSON property sortSpecs

Returns:



4295
4296
4297
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4295

def sort_specs
  @sort_specs
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4302
4303
4304
4305
4306
4307
4308
4309
4310
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 4302

def update!(**args)
  @column_selection_type = args[:column_selection_type] if args.key?(:column_selection_type)
  @columns = args[:columns] if args.key?(:columns)
  @data_execution_status = args[:data_execution_status] if args.key?(:data_execution_status)
  @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
  @filter_specs = args[:filter_specs] if args.key?(:filter_specs)
  @row_limit = args[:row_limit] if args.key?(:row_limit)
  @sort_specs = args[:sort_specs] if args.key?(:sort_specs)
end