Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Schedule

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

Overview

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Schedule

Returns a new instance of GoogleCloudAiplatformV1Schedule.



25633
25634
25635
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25633

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

Instance Attribute Details

#allow_queueing ⇒ Boolean Also known as: allow_queueing?

Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false. Corresponds to the JSON property allowQueueing

Returns:

  • (Boolean) 


25518
25519
25520
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25518

def allow_queueing
  @allow_queueing
end

#catch_up ⇒ Boolean Also known as: catch_up?

Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false. Corresponds to the JSON property catchUp

Returns:

  • (Boolean) 


25526
25527
25528
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25526

def catch_up
  @catch_up
end

#create_notebook_execution_job_request ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest

Request message for [NotebookService.CreateNotebookExecutionJob] Corresponds to the JSON property createNotebookExecutionJobRequest

Returns:



25532
25533
25534
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25532

def create_notebook_execution_job_request
  @create_notebook_execution_job_request
end

#create_pipeline_job_request ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CreatePipelineJobRequest

Request message for PipelineService.CreatePipelineJob. Corresponds to the JSON property createPipelineJobRequest

Returns:



25537
25538
25539
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25537

def create_pipeline_job_request
  @create_pipeline_job_request
end

#create_time ⇒ String

Output only. Timestamp when this Schedule was created. Corresponds to the JSON property createTime

Returns:

  • (String) 


25542
25543
25544
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25542

def create_time
  @create_time
end

#cron ⇒ String

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: " CRON_TZ=$IANA_TIME_ZONE" or "TZ=$IANA_TIME_ZONE". The $IANA_TIME_ZONE may only be a valid string from IANA time zone database. For example, "CRON_TZ= America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". Corresponds to the JSON property cron

Returns:

  • (String) 


25551
25552
25553
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25551

def cron
  @cron
end

#display_name ⇒ String

Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


25557
25558
25559
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25557

def display_name
  @display_name
end

#end_time ⇒ String

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. Corresponds to the JSON property endTime

Returns:

  • (String) 


25566
25567
25568
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25566

def end_time
  @end_time
end

#last_pause_time ⇒ String

Output only. Timestamp when this Schedule was last paused. Unset if never paused. Corresponds to the JSON property lastPauseTime

Returns:

  • (String) 


25572
25573
25574
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25572

def last_pause_time
  @last_pause_time
end

#last_resume_time ⇒ String

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause. Corresponds to the JSON property lastResumeTime

Returns:

  • (String) 


25578
25579
25580
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25578

def last_resume_time
  @last_resume_time
end

#last_scheduled_run_response ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ScheduleRunResponse

Status of a scheduled run. Corresponds to the JSON property lastScheduledRunResponse

Returns:



25583
25584
25585
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25583

def last_scheduled_run_response
  @last_scheduled_run_response
end

#max_concurrent_run_count ⇒ Fixnum

Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Corresponds to the JSON property maxConcurrentRunCount

Returns:

  • (Fixnum) 


25590
25591
25592
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25590

def max_concurrent_run_count
  @max_concurrent_run_count
end

#max_run_count ⇒ Fixnum

Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified. Corresponds to the JSON property maxRunCount

Returns:

  • (Fixnum) 


25599
25600
25601
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25599

def max_run_count
  @max_run_count
end

#name ⇒ String

Immutable. The resource name of the Schedule. Corresponds to the JSON property name

Returns:

  • (String) 


25604
25605
25606
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25604

def name
  @name
end

#next_run_time ⇒ String

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule. Corresponds to the JSON property nextRunTime

Returns:

  • (String) 


25610
25611
25612
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25610

def next_run_time
  @next_run_time
end

#start_time ⇒ String

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified. Corresponds to the JSON property startTime

Returns:

  • (String) 


25616
25617
25618
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25616

def start_time
  @start_time
end

#started_run_count ⇒ Fixnum

Output only. The number of runs started by this schedule. Corresponds to the JSON property startedRunCount

Returns:

  • (Fixnum) 


25621
25622
25623
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25621

def started_run_count
  @started_run_count
end

#state ⇒ String

Output only. The state of this Schedule. Corresponds to the JSON property state

Returns:

  • (String) 


25626
25627
25628
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25626

def state
  @state
end

#update_time ⇒ String

Output only. Timestamp when this Schedule was updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


25631
25632
25633
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25631

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



25638
25639
25640
25641
25642
25643
25644
25645
25646
25647
25648
25649
25650
25651
25652
25653
25654
25655
25656
25657
25658
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 25638

def update!(**args)
  @allow_queueing = args[:allow_queueing] if args.key?(:allow_queueing)
  @catch_up = args[:catch_up] if args.key?(:catch_up)
  @create_notebook_execution_job_request = args[:create_notebook_execution_job_request] if args.key?(:create_notebook_execution_job_request)
  @create_pipeline_job_request = args[:create_pipeline_job_request] if args.key?(:create_pipeline_job_request)
  @create_time = args[:create_time] if args.key?(:create_time)
  @cron = args[:cron] if args.key?(:cron)
  @display_name = args[:display_name] if args.key?(:display_name)
  @end_time = args[:end_time] if args.key?(:end_time)
  @last_pause_time = args[:last_pause_time] if args.key?(:last_pause_time)
  @last_resume_time = args[:last_resume_time] if args.key?(:last_resume_time)
  @last_scheduled_run_response = args[:last_scheduled_run_response] if args.key?(:last_scheduled_run_response)
  @max_concurrent_run_count = args[:max_concurrent_run_count] if args.key?(:max_concurrent_run_count)
  @max_run_count = args[:max_run_count] if args.key?(:max_run_count)
  @name = args[:name] if args.key?(:name)
  @next_run_time = args[:next_run_time] if args.key?(:next_run_time)
  @start_time = args[:start_time] if args.key?(:start_time)
  @started_run_count = args[:started_run_count] if args.key?(:started_run_count)
  @state = args[:state] if args.key?(:state)
  @update_time = args[:update_time] if args.key?(:update_time)
end