Class 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 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>
      • 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()
         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()
         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)
         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)
         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)
         The maximum job running time. The default is 7 days.
         
        .google.protobuf.Duration timeout = 1;
      • clearTimeout

        public Scheduling.Builder clearTimeout()
         The maximum job running time. The default is 7 days.
         
        .google.protobuf.Duration timeout = 1;
      • getTimeoutBuilder

        public com.google.protobuf.Duration.Builder getTimeoutBuilder()
         The maximum job running time. The default is 7 days.
         
        .google.protobuf.Duration timeout = 1;
      • getTimeoutOrBuilder

        public com.google.protobuf.DurationOrBuilder getTimeoutOrBuilder()
         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()
         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)
         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()
         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.
      • 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.
      • 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>