Class: Google::Apis::SheetsV4::RefreshDataSourceRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/sheets_v4/classes.rb,
lib/google/apis/sheets_v4/representations.rb,
lib/google/apis/sheets_v4/representations.rb

Overview

Refreshes one or multiple data source objects in the spreadsheet by the specified references. The request requires an additional bigquery.readonly OAuth scope. If there are multiple refresh requests referencing the same data source objects in one batch, only the last refresh request is processed, and all those requests will have the same response accordingly.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ RefreshDataSourceRequest

Returns a new instance of RefreshDataSourceRequest.



7784
7785
7786
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7784

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

Instance Attribute Details

#data_source_id ⇒ String

Reference to a DataSource. If specified, refreshes all associated data source objects for the data source. Corresponds to the JSON property dataSourceId

Returns:

  • (String) 


7763
7764
7765
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7763

def data_source_id
  @data_source_id
end

#force ⇒ Boolean Also known as: force?

Refreshes the data source objects regardless of the current state. If not set and a referenced data source object was in error state, the refresh will fail immediately. Corresponds to the JSON property force

Returns:

  • (Boolean) 


7770
7771
7772
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7770

def force
  @force
end

#is_all ⇒ Boolean Also known as: is_all?

Refreshes all existing data source objects in the spreadsheet. Corresponds to the JSON property isAll

Returns:

  • (Boolean) 


7776
7777
7778
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7776

def is_all
  @is_all
end

#references ⇒ Google::Apis::SheetsV4::DataSourceObjectReferences

A list of references to data source objects. Corresponds to the JSON property references

Returns:



7782
7783
7784
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7782

def references
  @references
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7789
7790
7791
7792
7793
7794
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 7789

def update!(**args)
  @data_source_id = args[:data_source_id] if args.key?(:data_source_id)
  @force = args[:force] if args.key?(:force)
  @is_all = args[:is_all] if args.key?(:is_all)
  @references = args[:references] if args.key?(:references)
end