Package com.google.cloud.aiplatform.v1

Class Scheduling

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Scheduling
All Implemented Interfaces:
SchedulingOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Scheduling extends com.google.protobuf.GeneratedMessage implements SchedulingOrBuilder
 All parameters related to queuing and scheduling of custom jobs.
Protobuf type google.cloud.aiplatform.v1.Scheduling
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Scheduling.Builder
    All parameters related to queuing and scheduling of custom jobs.
    static enum 
    Scheduling.Strategy
    Optional.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DISABLE_RETRIES_FIELD_NUMBER
     
    static final int
    MAX_WAIT_DURATION_FIELD_NUMBER
     
    static final int
    RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER
     
    static final int
    STRATEGY_FIELD_NUMBER
     
    static final int
    TIMEOUT_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static Scheduling
    getDefaultInstance()
     
    Scheduling
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    boolean
    getDisableRetries()
    Optional.
    com.google.protobuf.Duration
    getMaxWaitDuration()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getMaxWaitDurationOrBuilder()
    Optional.
    com.google.protobuf.Parser<Scheduling>
    getParserForType()
     
    boolean
    getRestartJobOnWorkerRestart()
    Optional.
    int
    getSerializedSize()
     
    Scheduling.Strategy
    getStrategy()
    Optional.
    int
    getStrategyValue()
    Optional.
    com.google.protobuf.Duration
    getTimeout()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getTimeoutOrBuilder()
    Optional.
    int
    hashCode()
     
    boolean
    hasMaxWaitDuration()
    Optional.
    boolean
    hasTimeout()
    Optional.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Scheduling.Builder
    newBuilder()
     
    static Scheduling.Builder
    newBuilder(Scheduling prototype)
     
    Scheduling.Builder
    newBuilderForType()
     
    protected Scheduling.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Scheduling
    parseDelimitedFrom(InputStream input)
     
    static Scheduling
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Scheduling
    parseFrom(byte[] data)
     
    static Scheduling
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Scheduling
    parseFrom(com.google.protobuf.ByteString data)
     
    static Scheduling
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Scheduling
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Scheduling
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Scheduling
    parseFrom(InputStream input)
     
    static Scheduling
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Scheduling
    parseFrom(ByteBuffer data)
     
    static Scheduling
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Scheduling>
    parser()
     
    Scheduling.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • TIMEOUT_FIELD_NUMBER

      public static final int TIMEOUT_FIELD_NUMBER
      See Also:

    • RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER

      public static final int RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER
      See Also:

    • STRATEGY_FIELD_NUMBER

      public static final int STRATEGY_FIELD_NUMBER
      See Also:

    • DISABLE_RETRIES_FIELD_NUMBER

      public static final int DISABLE_RETRIES_FIELD_NUMBER
      See Also:

    • MAX_WAIT_DURATION_FIELD_NUMBER

      public static final int MAX_WAIT_DURATION_FIELD_NUMBER
      See Also:

  • 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

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

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

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

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

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

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

    • 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

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static Scheduling parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static Scheduling parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Scheduling parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Scheduling parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Scheduling parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Scheduling parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Scheduling parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public Scheduling.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static Scheduling.Builder newBuilder()

    • newBuilder

      public static Scheduling.Builder newBuilder(Scheduling prototype)

    • toBuilder

      public Scheduling.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected Scheduling.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Scheduling getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Scheduling> parser()

    • getParserForType

      public com.google.protobuf.Parser<Scheduling> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public Scheduling getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder