Class: Google::Apis::BigquerydatatransferV1::ScheduleOptions

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ScheduleOptions

Returns a new instance of ScheduleOptions.


563
564
565
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 563

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#disable_auto_schedulingBoolean 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

Returns:

  • (Boolean)

544
545
546
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 544

def disable_auto_scheduling
  @disable_auto_scheduling
end

#end_timeString

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

Returns:

  • (String)

553
554
555
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 553

def end_time
  @end_time
end

#start_timeString

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

Returns:

  • (String)

561
562
563
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 561

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


568
569
570
571
572
# File 'generated/google/apis/bigquerydatatransfer_v1/classes.rb', line 568

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