class Google::Apis::DfareportingV3_3::Report::Schedule

The report's schedule. Can only be set if the report's 'dateRange' is a relative date range and the relative date range is not “TODAY”.

Attributes

active[RW]

Whether the schedule is active or not. Must be set to either true or false. Corresponds to the JSON property `active` @return [Boolean]

active?[RW]

Whether the schedule is active or not. Must be set to either true or false. Corresponds to the JSON property `active` @return [Boolean]

every[RW]

Defines every how many days, weeks or months the report should be run. Needs to be set when “repeats” is either “DAILY”, “WEEKLY” or “MONTHLY”. Corresponds to the JSON property `every` @return [Fixnum]

expiration_date[RW]

Corresponds to the JSON property `expirationDate` @return [Date]

repeats[RW]

The interval for which the report is repeated. Note: - “DAILY” also requires field “every” to be set. - “WEEKLY” also requires fields “every” and “ repeatsOnWeekDays” to be set. - “MONTHLY” also requires fields “every” and “ runsOnDayOfMonth” to be set. Corresponds to the JSON property `repeats` @return [String]

repeats_on_week_days[RW]

List of week days “WEEKLY” on which scheduled reports should run. Corresponds to the JSON property `repeatsOnWeekDays` @return [Array<String>]

runs_on_day_of_month[RW]

Enum to define for “MONTHLY” scheduled reports whether reports should be repeated on the same day of the month as “startDate” or the same day of the week of the month. Example: If 'startDate' is Monday, April 2nd 2012 (2012-04- 02), “DAY_OF_MONTH” would run subsequent reports on the 2nd of every Month, and “WEEK_OF_MONTH” would run subsequent reports on the first Monday of the month. Corresponds to the JSON property `runsOnDayOfMonth` @return [String]

start_date[RW]

Corresponds to the JSON property `startDate` @return [Date]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/dfareporting_v3_3/classes.rb, line 10215
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/dfareporting_v3_3/classes.rb, line 10220
def update!(**args)
  @active = args[:active] if args.key?(:active)
  @every = args[:every] if args.key?(:every)
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
  @repeats = args[:repeats] if args.key?(:repeats)
  @repeats_on_week_days = args[:repeats_on_week_days] if args.key?(:repeats_on_week_days)
  @runs_on_day_of_month = args[:runs_on_day_of_month] if args.key?(:runs_on_day_of_month)
  @start_date = args[:start_date] if args.key?(:start_date)
end