Class Scheduling.Builder (3.56.0)

Version latest

• 3.56.0 (latest)
• 3.55.0
• 3.54.0
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Scheduling.Builder

Implements

SchedulingOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

GeneratedMessageV3.Builder<BuilderType>.clear()

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

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearMaxWaitDuration()

public Scheduling.Builder clearMaxWaitDuration()

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

clearOneof(Descriptors.OneofDescriptor oneof)

public Scheduling.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Scheduling.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearRestartJobOnWorkerRestart()

public Scheduling.Builder clearRestartJobOnWorkerRestart()

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.

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()

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

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Scheduling getDefaultInstanceForType()

Returns
Type	Description
Scheduling

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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.

getMaxWaitDuration()

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

getMaxWaitDurationBuilder()

public Duration.Builder getMaxWaitDurationBuilder()

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
Builder

getMaxWaitDurationOrBuilder()

public 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 boolean getRestartJobOnWorkerRestart()

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.

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()

Optional. 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()

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

.google.protobuf.Duration timeout = 1;

Returns
Type	Description
Builder

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
Type	Description
DurationOrBuilder

hasMaxWaitDuration()

public 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 boolean hasTimeout()

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

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

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

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Scheduling.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Scheduling.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeMaxWaitDuration(Duration value)

public Scheduling.Builder mergeMaxWaitDuration(Duration value)

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

Parameter
Name	Description
value	Duration

Returns
Type	Description
Scheduling.Builder

mergeTimeout(Duration value)

public Scheduling.Builder mergeTimeout(Duration value)

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

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

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

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setMaxWaitDuration(Duration value)

public Scheduling.Builder setMaxWaitDuration(Duration value)

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

Parameter
Name	Description
value	Duration

Returns
Type	Description
Scheduling.Builder

setMaxWaitDuration(Duration.Builder builderForValue)

public Scheduling.Builder setMaxWaitDuration(Duration.Builder builderForValue)

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

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
Scheduling.Builder

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

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setRestartJobOnWorkerRestart(boolean value)

public Scheduling.Builder setRestartJobOnWorkerRestart(boolean value)

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.

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)

Optional. 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)

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

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)