Schedules

A Schedule is a named, reusable weekday-and-time schedule shared by scheduled resources across a Site.

List Schedules

SDK Method

Files::Schedule.list

Return Object

List<Schedule>

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

begin
  schedules = Files::Schedule.list
  schedules.auto_paging_each do |schedule|
    # Operate on schedule
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Show Schedule

SDK Method

Files::Schedule.find

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Schedule ID.

Example Request

begin
  schedule = Files::Schedule.find(id)
  # Operate on schedule
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Create Schedule

SDK Method

Files::Schedule.create

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string
Required		Schedule name.
schedule_days_of_week
array(int64)
Required		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)
Required		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.

Example Request

begin
  schedule = Files::Schedule.create(
    name: "Weekday overnight",
    schedule_days_of_week: [1,2,3,4,5],
    schedule_times_of_day: ["01:00"]
  )
  # Operate on schedule
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Update Schedule

SDK Method

schedule.update

Return Object

Schedule

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Schedule name.
schedule_days_of_week
array(int64)		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.

Example Request

begin
  # Find the schedule object by its id.
  schedule = Files::Schedule.find(id)
  schedule.update(
    name: "Weekday overnight"
  )
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

Delete Schedule

SDK Method

schedule.delete

Return Object

nil

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

begin
  # Find the schedule object by its id.
  schedule = Files::Schedule.find(id)
  schedule.delete
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The Schedule Object

Some of the methods above return a Schedule object. The attributes of this object are listed below.

AttributeDescription
id
int64		Schedule ID.
name
string		Schedule name.
schedule_days_of_week
array(int64)		0-based weekdays used by the Schedule. 0 is Sunday.
schedule_times_of_day
array(string)		Times of day in HH:MM format (24-hour).
schedule_time_zone
string		Time zone for scheduled times. If not set, times are interpreted as UTC.
holiday_region
string		Optional holiday region on which linked resources do not run.
human_readable_schedule
string		Human-readable Schedule description.
created_at
date-time		Creation time.
updated_at
date-time		Last update time.