Class: Google::Apis::BigquerydatatransferV1::TimeBasedSchedule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/bigquerydatatransfer_v1/classes.rb,
lib/google/apis/bigquerydatatransfer_v1/representations.rb,
lib/google/apis/bigquerydatatransfer_v1/representations.rb

Overview

Options customizing the time based transfer schedule. Options are migrated from the original ScheduleOptions message.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ TimeBasedSchedule

Returns a new instance of TimeBasedSchedule.



841
842
843
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 841

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

Instance Attribute Details

#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. Corresponds to the JSON property endTime

Returns:

  • (String) 


819
820
821
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 819

def end_time
  @end_time
end

#schedule ⇒ String

Data transfer schedule. If the data source does not support a custom schedule, this should be empty. If it is empty, the default value for the data source will be used. The specified times are in UTC. Examples of valid format: 1st, 3rd monday of month 15:30, every wed,fri of jan,jun 13:15, and first sunday of quarter 00:00. See more explanation about the format here: https:// cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml# the_schedule_format NOTE: The minimum interval time between recurring transfers depends on the data source; refer to the documentation for your data source. Corresponds to the JSON property schedule

Returns:

  • (String) 


832
833
834
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 832

def schedule
  @schedule
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. Corresponds to the JSON property startTime

Returns:

  • (String) 


839
840
841
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 839

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



846
847
848
849
850
 
# File 'lib/google/apis/bigquerydatatransfer_v1/classes.rb', line 846

def update!(**args)
  @end_time = args[:end_time] if args.key?(:end_time)
  @schedule = args[:schedule] if args.key?(:schedule)
  @start_time = args[:start_time] if args.key?(:start_time)
end