Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schedule

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/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) ⇒ GoogleCloudAiplatformV1beta1Schedule

Returns a new instance of GoogleCloudAiplatformV1beta1Schedule.



52893
52894
52895
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52893

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) 


52765
52766
52767
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52765

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) 


52773
52774
52775
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52773

def catch_up
  @catch_up
end

#create_model_monitoring_job_request ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CreateModelMonitoringJobRequest

Request message for ModelMonitoringService.CreateModelMonitoringJob. Corresponds to the JSON property createModelMonitoringJobRequest

Returns:



52779
52780
52781
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52779

def create_model_monitoring_job_request
  @create_model_monitoring_job_request
end

#create_notebook_execution_job_request ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CreateNotebookExecutionJobRequest

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

Returns:



52784
52785
52786
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52784

def create_notebook_execution_job_request
  @create_notebook_execution_job_request
end

#create_pipeline_job_request ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CreatePipelineJobRequest

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

Returns:



52789
52790
52791
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52789

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) 


52794
52795
52796
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52794

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) 


52803
52804
52805
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52803

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) 


52809
52810
52811
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52809

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) 


52818
52819
52820
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52818

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) 


52824
52825
52826
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52824

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) 


52830
52831
52832
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52830

def last_resume_time
  @last_resume_time
end

#last_scheduled_run_response ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ScheduleRunResponse

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

Returns:



52835
52836
52837
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52835

def last_scheduled_run_response
  @last_scheduled_run_response
end

#max_concurrent_active_run_count ⇒ Fixnum

Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest. Corresponds to the JSON property maxConcurrentActiveRunCount

Returns:

  • (Fixnum) 


52843
52844
52845
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52843

def max_concurrent_active_run_count
  @max_concurrent_active_run_count
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) 


52850
52851
52852
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52850

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) 


52859
52860
52861
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52859

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) 


52864
52865
52866
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52864

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) 


52870
52871
52872
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52870

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) 


52876
52877
52878
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52876

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) 


52881
52882
52883
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52881

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) 


52886
52887
52888
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52886

def state
  @state
end

#update_time ⇒ String

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

Returns:

  • (String) 


52891
52892
52893
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52891

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



52898
52899
52900
52901
52902
52903
52904
52905
52906
52907
52908
52909
52910
52911
52912
52913
52914
52915
52916
52917
52918
52919
52920
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 52898

def update!(**args)
  @allow_queueing = args[:allow_queueing] if args.key?(:allow_queueing)
  @catch_up = args[:catch_up] if args.key?(:catch_up)
  @create_model_monitoring_job_request = args[:create_model_monitoring_job_request] if args.key?(:create_model_monitoring_job_request)
  @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_active_run_count = args[:max_concurrent_active_run_count] if args.key?(:max_concurrent_active_run_count)
  @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