Class: Google::Apis::DfareportingV3_4::Report::Schedule
- Inherits:
-
Object
- Object
- Google::Apis::DfareportingV3_4::Report::Schedule
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/dfareporting_v3_4/classes.rb,
generated/google/apis/dfareporting_v3_4/representations.rb,
generated/google/apis/dfareporting_v3_4/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.
10773 10774 10775 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10773 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
10731 10732 10733 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10731 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
10738 10739 10740 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10738 def every @every end |
#expiration_date ⇒ Date
The expiration date when the scheduled report stops running.
Corresponds to the JSON property expirationDate
10743 10744 10745 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10743 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
10751 10752 10753 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10751 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
10756 10757 10758 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10756 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
10766 10767 10768 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10766 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
10771 10772 10773 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10771 def start_date @start_date end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10778 10779 10780 10781 10782 10783 10784 10785 10786 |
# File 'generated/google/apis/dfareporting_v3_4/classes.rb', line 10778 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 |