Class Scheduling.Builder (3.49.0)

public static final class Scheduling.Builder extends GeneratedMessageV3.Builder<Scheduling.Builder> implements SchedulingOrBuilder

All parameters related to queuing and scheduling of custom jobs.

Protobuf type google.cloud.aiplatform.v1.Scheduling

Implements

SchedulingOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Scheduling.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Scheduling.Builder
Overrides

build()

public Scheduling build()
Returns
Type Description
Scheduling

buildPartial()

public Scheduling buildPartial()
Returns
Type Description
Scheduling

clear()

public Scheduling.Builder clear()
Returns
Type Description
Scheduling.Builder
Overrides

clearDisableRetries()

public Scheduling.Builder clearDisableRetries()

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
Scheduling.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Scheduling.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Scheduling.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Scheduling.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Scheduling.Builder
Overrides

clearRestartJobOnWorkerRestart()

public Scheduling.Builder clearRestartJobOnWorkerRestart()

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
Scheduling.Builder

This builder for chaining.

clearStrategy()

public Scheduling.Builder clearStrategy()

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

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

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearTimeout()

public Scheduling.Builder clearTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
Scheduling.Builder

clone()

public Scheduling.Builder clone()
Returns
Type Description
Scheduling.Builder
Overrides

getDefaultInstanceForType()

public Scheduling getDefaultInstanceForType()
Returns
Type Description
Scheduling

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisableRetries()

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

getRestartJobOnWorkerRestart()

public 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 Scheduling.Strategy getStrategy()

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

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

Returns
Type Description
Scheduling.Strategy

The strategy.

getStrategyValue()

public int getStrategyValue()

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

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

Returns
Type Description
int

The enum numeric value on the wire for strategy.

getTimeout()

public Duration getTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
Duration

The timeout.

getTimeoutBuilder()

public Duration.Builder getTimeoutBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
DurationOrBuilder

hasTimeout()

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Scheduling other)

public Scheduling.Builder mergeFrom(Scheduling other)
Parameter
Name Description
other Scheduling
Returns
Type Description
Scheduling.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Scheduling.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Scheduling.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Scheduling.Builder
Overrides

mergeTimeout(Duration value)

public Scheduling.Builder mergeTimeout(Duration value)

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

.google.protobuf.Duration timeout = 1;

Parameter
Name Description
value Duration
Returns
Type Description
Scheduling.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Scheduling.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Scheduling.Builder
Overrides

setDisableRetries(boolean value)

public Scheduling.Builder setDisableRetries(boolean value)

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];

Parameter
Name Description
value boolean

The disableRetries to set.

Returns
Type Description
Scheduling.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Scheduling.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Scheduling.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Scheduling.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Scheduling.Builder
Overrides

setRestartJobOnWorkerRestart(boolean value)

public Scheduling.Builder setRestartJobOnWorkerRestart(boolean value)

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;

Parameter
Name Description
value boolean

The restartJobOnWorkerRestart to set.

Returns
Type Description
Scheduling.Builder

This builder for chaining.

setStrategy(Scheduling.Strategy value)

public Scheduling.Builder setStrategy(Scheduling.Strategy value)

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

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

Parameter
Name Description
value Scheduling.Strategy

The strategy to set.

Returns
Type Description
Scheduling.Builder

This builder for chaining.

setStrategyValue(int value)

public Scheduling.Builder setStrategyValue(int value)

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

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

Parameter
Name Description
value int

The enum numeric value on the wire for strategy to set.

Returns
Type Description
Scheduling.Builder

This builder for chaining.

setTimeout(Duration value)

public Scheduling.Builder setTimeout(Duration value)

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

.google.protobuf.Duration timeout = 1;

Parameter
Name Description
value Duration
Returns
Type Description
Scheduling.Builder

setTimeout(Duration.Builder builderForValue)

public Scheduling.Builder setTimeout(Duration.Builder builderForValue)

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

.google.protobuf.Duration timeout = 1;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Scheduling.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final Scheduling.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Scheduling.Builder
Overrides