Package 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.GeneratedMessage.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.GeneratedMessage.Builder<Scheduling.Builder> implements SchedulingOrBuilder
 All parameters related to queuing and scheduling of custom jobs.
Protobuf type google.cloud.aiplatform.v1.Scheduling

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.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.GeneratedMessage.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.GeneratedMessage.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

    • 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.GeneratedMessage.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