com.google.cloud.aiplatform.v1beta1

Interface SchedulingOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Scheduling, Scheduling.Builder

public interface SchedulingOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getDisableRetries() Optional.
com.google.protobuf.Duration	getMaxWaitDuration() Optional.
com.google.protobuf.DurationOrBuilder	getMaxWaitDurationOrBuilder() Optional.
boolean	getRestartJobOnWorkerRestart() Restarts the entire CustomJob if a worker gets restarted.
Scheduling.Strategy	getStrategy() Optional.
int	getStrategyValue() Optional.
com.google.protobuf.Duration	getTimeout() The maximum job running time.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() The maximum job running time.
boolean	hasMaxWaitDuration() Optional.
boolean	hasTimeout() The maximum job running time.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasTimeout

boolean hasTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns:

Whether the timeout field is set.

getTimeout

com.google.protobuf.Duration getTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns:

The timeout.

getTimeoutOrBuilder

com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

getRestartJobOnWorkerRestart

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:

The restartJobOnWorkerRestart.

getStrategyValue

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:

The enum numeric value on the wire for strategy.

getStrategy

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:

The strategy.

getDisableRetries

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:

The disableRetries.

hasMaxWaitDuration

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:

Whether the maxWaitDuration field is set.

getMaxWaitDuration

com.google.protobuf.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:

The maxWaitDuration.

getMaxWaitDurationOrBuilder

com.google.protobuf.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];