- 3.55.0 (latest)
- 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.BuilderImplements
SchedulingOrBuilderStatic 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 |
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 |
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 |
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 |
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 |
getDefaultInstanceForType()
public Scheduling getDefaultInstanceForType()
Returns | |
---|---|
Type | Description |
Scheduling |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns | |
---|---|
Type | Description |
Descriptor |
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()
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 |
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()
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 |
isInitialized()
public final boolean isInitialized()
Returns | |
---|---|
Type | Description |
boolean |
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 |
Exceptions | |
---|---|
Type | Description |
IOException |
mergeFrom(Message other)
public Scheduling.Builder mergeFrom(Message other)
Parameter | |
---|---|
Name | Description |
other |
Message |
Returns | |
---|---|
Type | Description |
Scheduling.Builder |
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)
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 |
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 |
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 |
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 |