Google Cloud Ai Platform V1 Client - Class Scheduling (1.8.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class Scheduling.

All parameters related to queuing and scheduling of custom jobs.

Generated from protobuf message google.cloud.aiplatform.v1.Scheduling

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ timeout Google\Protobuf\Duration

The maximum job running time. The default is 7 days.

↳ restart_job_on_worker_restart bool

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.

↳ strategy int

Optional. This determines which type of scheduling strategy to use.

↳ disable_retries bool

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.

↳ max_wait_duration Google\Protobuf\Duration

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.

getTimeout

The maximum job running time. The default is 7 days.

Returns
Type Description
Google\Protobuf\Duration|null

hasTimeout

clearTimeout

setTimeout

The maximum job running time. The default is 7 days.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getRestartJobOnWorkerRestart

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.

Returns
Type Description
bool

setRestartJobOnWorkerRestart

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getStrategy

Optional. This determines which type of scheduling strategy to use.

Returns
Type Description
int

setStrategy

Optional. This determines which type of scheduling strategy to use.

Parameter
Name Description
var int
Returns
Type Description
$this

getDisableRetries

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.

Returns
Type Description
bool

setDisableRetries

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getMaxWaitDuration

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.

Returns
Type Description
Google\Protobuf\Duration|null

hasMaxWaitDuration

clearMaxWaitDuration

setMaxWaitDuration

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.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this