com.google.cloud.aiplatform.v1

Class Scheduling.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

com.google.cloud.aiplatform.v1.Scheduling.Builder

All Implemented Interfaces:

SchedulingOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Scheduling

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

 All parameters related to queuing and scheduling of custom jobs.
 

Protobuf type google.cloud.aiplatform.v1.Scheduling

Method Summary

Modifier and Type	Method and Description
Scheduling.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Scheduling	build()
Scheduling	buildPartial()
Scheduling.Builder	clear()
Scheduling.Builder	clearDisableRetries() Optional.
Scheduling.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
Scheduling.Builder	clearMaxWaitDuration() Optional.
Scheduling.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
Scheduling.Builder	clearRestartJobOnWorkerRestart() Optional.
Scheduling.Builder	clearStrategy() Optional.
Scheduling.Builder	clearTimeout() Optional.
Scheduling.Builder	clone()
Scheduling	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
boolean	getDisableRetries() Optional.
com.google.protobuf.Duration	getMaxWaitDuration() Optional.
com.google.protobuf.Duration.Builder	getMaxWaitDurationBuilder() Optional.
com.google.protobuf.DurationOrBuilder	getMaxWaitDurationOrBuilder() Optional.
boolean	getRestartJobOnWorkerRestart() Optional.
Scheduling.Strategy	getStrategy() Optional.
int	getStrategyValue() Optional.
com.google.protobuf.Duration	getTimeout() Optional.
com.google.protobuf.Duration.Builder	getTimeoutBuilder() Optional.
com.google.protobuf.DurationOrBuilder	getTimeoutOrBuilder() Optional.
boolean	hasMaxWaitDuration() Optional.
boolean	hasTimeout() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Scheduling.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
Scheduling.Builder	mergeFrom(com.google.protobuf.Message other)
Scheduling.Builder	mergeFrom(Scheduling other)
Scheduling.Builder	mergeMaxWaitDuration(com.google.protobuf.Duration value) Optional.
Scheduling.Builder	mergeTimeout(com.google.protobuf.Duration value) Optional.
Scheduling.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
Scheduling.Builder	setDisableRetries(boolean value) Optional.
Scheduling.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
Scheduling.Builder	setMaxWaitDuration(com.google.protobuf.Duration.Builder builderForValue) Optional.
Scheduling.Builder	setMaxWaitDuration(com.google.protobuf.Duration value) Optional.
Scheduling.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
Scheduling.Builder	setRestartJobOnWorkerRestart(boolean value) Optional.
Scheduling.Builder	setStrategy(Scheduling.Strategy value) Optional.
Scheduling.Builder	setStrategyValue(int value) Optional.
Scheduling.Builder	setTimeout(com.google.protobuf.Duration.Builder builderForValue) Optional.
Scheduling.Builder	setTimeout(com.google.protobuf.Duration value) Optional.
Scheduling.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

clear

public Scheduling.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

getDefaultInstanceForType

public Scheduling getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public Scheduling build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public Scheduling buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public Scheduling.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

setField

public Scheduling.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                   Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

clearField

public Scheduling.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

clearOneof

public Scheduling.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

setRepeatedField

public Scheduling.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           int index,
                                           Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

addRepeatedField

public Scheduling.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                           Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

mergeFrom

public Scheduling.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Scheduling.Builder>

mergeFrom

public Scheduling.Builder mergeFrom(Scheduling other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

mergeFrom

public Scheduling.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Scheduling.Builder>

Throws:

IOException

hasTimeout

public boolean hasTimeout()

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

.google.protobuf.Duration timeout = 1;

Specified by:

hasTimeout in interface SchedulingOrBuilder

Returns:

Whether the timeout field is set.

getTimeout

public com.google.protobuf.Duration getTimeout()

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

.google.protobuf.Duration timeout = 1;

Specified by:

getTimeout in interface SchedulingOrBuilder

Returns:

The timeout.

setTimeout

public Scheduling.Builder setTimeout(com.google.protobuf.Duration value)

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

.google.protobuf.Duration timeout = 1;

setTimeout

public Scheduling.Builder setTimeout(com.google.protobuf.Duration.Builder builderForValue)

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

.google.protobuf.Duration timeout = 1;

mergeTimeout

public Scheduling.Builder mergeTimeout(com.google.protobuf.Duration value)

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

.google.protobuf.Duration timeout = 1;

clearTimeout

public Scheduling.Builder clearTimeout()

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

.google.protobuf.Duration timeout = 1;

getTimeoutBuilder

public com.google.protobuf.Duration.Builder getTimeoutBuilder()

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

.google.protobuf.Duration timeout = 1;

getTimeoutOrBuilder

public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Specified by:

getTimeoutOrBuilder in interface SchedulingOrBuilder

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;

Specified by:

getRestartJobOnWorkerRestart in interface SchedulingOrBuilder

Returns:

The restartJobOnWorkerRestart.

setRestartJobOnWorkerRestart

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;

Parameters:

value - The restartJobOnWorkerRestart to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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

Specified by:

getStrategyValue in interface SchedulingOrBuilder

Returns:

The enum numeric value on the wire for strategy.

setStrategyValue

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

Parameters:

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

Returns:

This builder for chaining.

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

Specified by:

getStrategy in interface SchedulingOrBuilder

Returns:

The strategy.

setStrategy

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

Parameters:

value - The strategy to set.

Returns:

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:

This builder for chaining.

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

Specified by:

getDisableRetries in interface SchedulingOrBuilder

Returns:

The disableRetries.

setDisableRetries

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

Parameters:

value - The disableRetries to set.

Returns:

This builder for chaining.

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:

This builder for chaining.

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

Specified by:

hasMaxWaitDuration in interface SchedulingOrBuilder

Returns:

Whether the maxWaitDuration field is set.

getMaxWaitDuration

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

Specified by:

getMaxWaitDuration in interface SchedulingOrBuilder

Returns:

The maxWaitDuration.

setMaxWaitDuration

public Scheduling.Builder setMaxWaitDuration(com.google.protobuf.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];

setMaxWaitDuration

public Scheduling.Builder setMaxWaitDuration(com.google.protobuf.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];

mergeMaxWaitDuration

public Scheduling.Builder mergeMaxWaitDuration(com.google.protobuf.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];

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

getMaxWaitDurationBuilder

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

getMaxWaitDurationOrBuilder

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

Specified by:

getMaxWaitDurationOrBuilder in interface SchedulingOrBuilder

setUnknownFields

public final Scheduling.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>

mergeUnknownFields

public final Scheduling.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Scheduling.Builder>