Interface SchedulingOrBuilder (3.50.0)

public interface SchedulingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisableRetries()

public abstract boolean 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.

bool disable_retries = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The disableRetries.

getMaxWaitDuration()

public abstract Duration 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.

.google.protobuf.Duration max_wait_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Duration

The maxWaitDuration.

getMaxWaitDurationOrBuilder()

public abstract DurationOrBuilder getMaxWaitDurationOrBuilder()

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.

.google.protobuf.Duration max_wait_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DurationOrBuilder

getRestartJobOnWorkerRestart()

public abstract boolean 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.

bool restart_job_on_worker_restart = 3;

Returns
Type Description
boolean

The restartJobOnWorkerRestart.

getStrategy()

public abstract Scheduling.Strategy getStrategy()

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

.google.cloud.aiplatform.v1beta1.Scheduling.Strategy strategy = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Scheduling.Strategy

The strategy.

getStrategyValue()

public abstract int getStrategyValue()

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

.google.cloud.aiplatform.v1beta1.Scheduling.Strategy strategy = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for strategy.

getTimeout()

public abstract Duration getTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
Duration

The timeout.

getTimeoutOrBuilder()

public abstract DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
DurationOrBuilder

hasMaxWaitDuration()

public abstract boolean hasMaxWaitDuration()

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.

.google.protobuf.Duration max_wait_duration = 6 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the maxWaitDuration field is set.

hasTimeout()

public abstract boolean hasTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
boolean

Whether the timeout field is set.