Class: Google::Apis::DfareportingV2_8::Report::Schedule
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV2_8::Report::Schedule
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v2_8/classes.rb,
generated/google/apis/dfareporting_v2_8/representations.rb,
generated/google/apis/dfareporting_v2_8/representations.rb
Overview
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".
Instance Attribute Summary collapse
-
#active ⇒ Boolean
(also: #active?)
Whether the schedule is active or not.
-
#every ⇒ Fixnum
Defines every how many days, weeks or months the report should be run.
-
#expiration_date ⇒ Date
The expiration date when the scheduled report stops running.
-
#repeats ⇒ String
The interval for which the report is repeated.
-
#repeats_on_week_days ⇒ Array<String>
List of week days "WEEKLY" on which scheduled reports should run.
-
#runs_on_day_of_month ⇒ String
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.
-
#start_date ⇒ Date
Start date of date range for which scheduled reports should be run.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Schedule
constructor
A new instance of Schedule.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ Schedule
Returns a new instance of Schedule
10270 10271 10272 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10270 def initialize(**args) update!(**args) end |
Instance Attribute Details
#active ⇒ Boolean Also known as: active?
Whether the schedule is active or not. Must be set to either true or false.
Corresponds to the JSON property active
10228 10229 10230 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10228 def active @active end |
#every ⇒ Fixnum
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
10235 10236 10237 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10235 def every @every end |
#expiration_date ⇒ Date
The expiration date when the scheduled report stops running.
Corresponds to the JSON property expirationDate
10240 10241 10242 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10240 def expiration_date @expiration_date end |
#repeats ⇒ String
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
10248 10249 10250 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10248 def repeats @repeats end |
#repeats_on_week_days ⇒ Array<String>
List of week days "WEEKLY" on which scheduled reports should run.
Corresponds to the JSON property repeatsOnWeekDays
10253 10254 10255 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10253 def repeats_on_week_days @repeats_on_week_days end |
#runs_on_day_of_month ⇒ String
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
10263 10264 10265 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10263 def runs_on_day_of_month @runs_on_day_of_month end |
#start_date ⇒ Date
Start date of date range for which scheduled reports should be run.
Corresponds to the JSON property startDate
10268 10269 10270 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10268 def start_date @start_date end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10275 10276 10277 10278 10279 10280 10281 10282 10283 |
# File 'generated/google/apis/dfareporting_v2_8/classes.rb', line 10275 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 |