Class: Google::Apis::NotebooksV1::Schedule

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

Overview

The definition of a schedule.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Schedule

Returns a new instance of Schedule.



2466
2467
2468
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2466

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

Instance Attribute Details

#create_time ⇒ String

Output only. Time the schedule was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


2409
2410
2411
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2409

def create_time
  @create_time
end

#cron_schedule ⇒ String

Cron-tab formatted schedule by which the job will execute. Format: minute, hour, day of month, month, day of week, e.g. 0 0 * * WED = every Wednesday More examples: https://crontab.guru/examples.html Corresponds to the JSON property cronSchedule

Returns:

  • (String) 


2416
2417
2418
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2416

def cron_schedule
  @cron_schedule
end

#description ⇒ String

A brief description of this environment. Corresponds to the JSON property description

Returns:

  • (String) 


2421
2422
2423
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2421

def description
  @description
end

#display_name ⇒ String

Output only. Display name used for UI purposes. Name can only contain alphanumeric characters, hyphens -, and underscores _. Corresponds to the JSON property displayName

Returns:

  • (String) 


2427
2428
2429
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2427

def display_name
  @display_name
end

#execution_template ⇒ Google::Apis::NotebooksV1::ExecutionTemplate

The description a notebook execution workload. Corresponds to the JSON property executionTemplate

Returns:



2432
2433
2434
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2432

def execution_template
  @execution_template
end

#name ⇒ String

Output only. The name of this schedule. Format: projects/project_id/ locations/location/schedules/schedule_id` Corresponds to the JSON propertyname`

Returns:

  • (String) 


2438
2439
2440
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2438

def name
  @name
end

#recent_executions ⇒ Array<Google::Apis::NotebooksV1::Execution>

Output only. The most recent execution names triggered from this schedule and their corresponding states. Corresponds to the JSON property recentExecutions

Returns:



2444
2445
2446
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2444

def recent_executions
  @recent_executions
end

#state ⇒ String

Corresponds to the JSON property state

Returns:

  • (String) 


2449
2450
2451
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2449

def state
  @state
end

#time_zone ⇒ String

Timezone on which the cron_schedule. The value of this field must be a time zone name from the tz database. TZ Database: https://en.wikipedia.org/wiki/ List_of_tz_database_time_zones Note that some time zones include a provision for daylight savings time. The rules for daylight saving time are determined by the chosen tz. For UTC use the string "utc". If a time zone is not specified, the default will be in UTC (also known as GMT). Corresponds to the JSON property timeZone

Returns:

  • (String) 


2459
2460
2461
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2459

def time_zone
  @time_zone
end

#update_time ⇒ String

Output only. Time the schedule was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


2464
2465
2466
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2464

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
 
# File 'lib/google/apis/notebooks_v1/classes.rb', line 2471

def update!(**args)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cron_schedule = args[:cron_schedule] if args.key?(:cron_schedule)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @execution_template = args[:execution_template] if args.key?(:execution_template)
  @name = args[:name] if args.key?(:name)
  @recent_executions = args[:recent_executions] if args.key?(:recent_executions)
  @state = args[:state] if args.key?(:state)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @update_time = args[:update_time] if args.key?(:update_time)
end