Class: Google::Apis::GameservicesV1::Schedule

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

Overview

The schedule of a recurring or one time event. The event's time span is specified by start_time and end_time. If the scheduled event's timespan is larger than the cron_spec + cron_job_duration, the event will be recurring. If only cron_spec + cron_job_duration are specified, the event is effective starting at the local time specified by cron_spec, and is recurring. start_time|-------[cron job]-------[cron job]-------[cron job]---|end_time cron job: cron spec start time + duration

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Schedule

Returns a new instance of Schedule.



1882
1883
1884
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1882

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

Instance Attribute Details

#cron_job_duration ⇒ String

The duration for the cron job event. The duration of the event is effective after the cron job's start time. Corresponds to the JSON property cronJobDuration

Returns:

  • (String) 


1864
1865
1866
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1864

def cron_job_duration
  @cron_job_duration
end

#cron_spec ⇒ String

The cron definition of the scheduled event. See https://en.wikipedia.org/wiki/ Cron. Cron spec specifies the local time as defined by the realm. Corresponds to the JSON property cronSpec

Returns:

  • (String) 


1870
1871
1872
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1870

def cron_spec
  @cron_spec
end

#end_time ⇒ String

The end time of the event. Corresponds to the JSON property endTime

Returns:

  • (String) 


1875
1876
1877
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1875

def end_time
  @end_time
end

#start_time ⇒ String

The start time of the event. Corresponds to the JSON property startTime

Returns:

  • (String) 


1880
1881
1882
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1880

def start_time
  @start_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1887
1888
1889
1890
1891
1892
 
# File 'generated/google/apis/gameservices_v1/classes.rb', line 1887

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