Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Scheduling

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

All parameters related to queuing and scheduling of custom jobs.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Scheduling

Returns a new instance of GoogleCloudAiplatformV1Scheduling.



24497
24498
24499
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24497

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

Instance Attribute Details

#disable_retries ⇒ Boolean Also known as: disable_retries?

Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides Scheduling.restart_job_on_worker_restart to false. Corresponds to the JSON property disableRetries

Returns:

  • (Boolean) 


24468
24469
24470
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24468

def disable_retries
  @disable_retries
end

#max_wait_duration ⇒ String

Optional. This is the maximum duration that a job will wait for the requested resources to be provisioned if the scheduling strategy is set to [Strategy. DWS_FLEX_START]. If set to 0, the job will wait indefinitely. The default is 24 hours. Corresponds to the JSON property maxWaitDuration

Returns:

  • (String) 


24477
24478
24479
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24477

def max_wait_duration
  @max_wait_duration
end

#restart_job_on_worker_restart ⇒ Boolean Also known as: restart_job_on_worker_restart?

Optional. Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job. Corresponds to the JSON property restartJobOnWorkerRestart

Returns:

  • (Boolean) 


24484
24485
24486
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24484

def restart_job_on_worker_restart
  @restart_job_on_worker_restart
end

#strategy ⇒ String

Optional. This determines which type of scheduling strategy to use. Corresponds to the JSON property strategy

Returns:

  • (String) 


24490
24491
24492
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24490

def strategy
  @strategy
end

#timeout ⇒ String

Optional. The maximum job running time. The default is 7 days. Corresponds to the JSON property timeout

Returns:

  • (String) 


24495
24496
24497
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24495

def timeout
  @timeout
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24502
24503
24504
24505
24506
24507
24508
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 24502

def update!(**args)
  @disable_retries = args[:disable_retries] if args.key?(:disable_retries)
  @max_wait_duration = args[:max_wait_duration] if args.key?(:max_wait_duration)
  @restart_job_on_worker_restart = args[:restart_job_on_worker_restart] if args.key?(:restart_job_on_worker_restart)
  @strategy = args[:strategy] if args.key?(:strategy)
  @timeout = args[:timeout] if args.key?(:timeout)
end