Class: Google::Apis::BigquerydatatransferV1::ScheduleOptions
- Inherits:
-
Object
- Object
- Google::Apis::BigquerydatatransferV1::ScheduleOptions
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/bigquerydatatransfer_v1/classes.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb,
generated/google/apis/bigquerydatatransfer_v1/representations.rb
Overview
Options customizing the data transfer schedule.
Instance Attribute Summary collapse
-
#disable_auto_scheduling ⇒ Boolean
(also: #disable_auto_scheduling?)
If true, automatic scheduling of data transfer runs for this configuration will be disabled.
-
#end_time ⇒ String
Defines time to stop scheduling transfer runs.
-
#start_time ⇒ String
Specifies time to start scheduling transfer runs.
Instance Method Summary collapse
-
#initialize(**args) ⇒ ScheduleOptions
constructor
A new instance of ScheduleOptions.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ ScheduleOptions
Returns a new instance of ScheduleOptions.
577 578 579 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 577 def initialize(**args) update!(**args) end |
Instance Attribute Details
#disable_auto_scheduling ⇒ Boolean Also known as: disable_auto_scheduling?
If true, automatic scheduling of data transfer runs for this configuration
will be disabled. The runs can be started on ad-hoc basis using
StartManualTransferRuns API. When automatic scheduling is disabled, the
TransferConfig.schedule field will be ignored.
Corresponds to the JSON property disableAutoScheduling
557 558 559 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 557 def disable_auto_scheduling @disable_auto_scheduling end |
#end_time ⇒ String
Defines time to stop scheduling transfer runs. A transfer run cannot be
scheduled at or after the end time. The end time can be changed at any
moment. The time when a data transfer can be trigerred manually is not
limited by this option.
Corresponds to the JSON property endTime
566 567 568 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 566 def end_time @end_time end |
#start_time ⇒ String
Specifies time to start scheduling transfer runs. The first run will be
scheduled at or after the start time according to a recurrence pattern
defined in the schedule string. The start time can be changed at any
moment. The time when a data transfer can be trigerred manually is not
limited by this option.
Corresponds to the JSON property startTime
575 576 577 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 575 def start_time @start_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
582 583 584 585 586 |
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 582 def update!(**args) @disable_auto_scheduling = args[:disable_auto_scheduling] if args.key?(:disable_auto_scheduling) @end_time = args[:end_time] if args.key?(:end_time) @start_time = args[:start_time] if args.key?(:start_time) end |