Class: Google::Apis::SheetsV4::DataSourceRefreshSchedule

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

Schedule for refreshing the data source. Data sources in the spreadsheet are refreshed within a time interval. You can specify the start time by clicking the Scheduled Refresh button in the Sheets editor, but the interval is fixed at 4 hours. For example, if you specify a start time of 8am , the refresh will take place between 8am and 12pm every day.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ DataSourceRefreshSchedule

Returns a new instance of DataSourceRefreshSchedule.



4116
4117
4118
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4116

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

Instance Attribute Details

#daily_schedule ⇒ Google::Apis::SheetsV4::DataSourceRefreshDailySchedule

A schedule for data to refresh every day in a given time interval. Corresponds to the JSON property dailySchedule

Returns:



4083
4084
4085
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4083

def daily_schedule
  @daily_schedule
end

#enabled ⇒ Boolean Also known as: enabled?

True if the refresh schedule is enabled, or false otherwise. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


4088
4089
4090
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4088

def enabled
  @enabled
end

#monthly_schedule ⇒ Google::Apis::SheetsV4::DataSourceRefreshMonthlySchedule

A monthly schedule for data to refresh on specific days in the month in a given time interval. Corresponds to the JSON property monthlySchedule

Returns:



4095
4096
4097
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4095

def monthly_schedule
  @monthly_schedule
end

#next_run ⇒ Google::Apis::SheetsV4::Interval

Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. Corresponds to the JSON property nextRun

Returns:



4103
4104
4105
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4103

def next_run
  @next_run
end

#refresh_scope ⇒ String

The scope of the refresh. Must be ALL_DATA_SOURCES. Corresponds to the JSON property refreshScope

Returns:

  • (String) 


4108
4109
4110
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4108

def refresh_scope
  @refresh_scope
end

#weekly_schedule ⇒ Google::Apis::SheetsV4::DataSourceRefreshWeeklySchedule

A weekly schedule for data to refresh on specific days in a given time interval. Corresponds to the JSON property weeklySchedule

Returns:



4114
4115
4116
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4114

def weekly_schedule
  @weekly_schedule
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4121
4122
4123
4124
4125
4126
4127
4128
 
# File 'lib/google/apis/sheets_v4/classes.rb', line 4121

def update!(**args)
  @daily_schedule = args[:daily_schedule] if args.key?(:daily_schedule)
  @enabled = args[:enabled] if args.key?(:enabled)
  @monthly_schedule = args[:monthly_schedule] if args.key?(:monthly_schedule)
  @next_run = args[:next_run] if args.key?(:next_run)
  @refresh_scope = args[:refresh_scope] if args.key?(:refresh_scope)
  @weekly_schedule = args[:weekly_schedule] if args.key?(:weekly_schedule)
end