Class Scheduling (3.25.0)

public final class Scheduling extends GeneratedMessageV3 implements SchedulingOrBuilder

All parameters related to queuing and scheduling of custom jobs.

Protobuf type google.cloud.aiplatform.v1.Scheduling

Implements

SchedulingOrBuilder

Static Fields

DISABLE_RETRIES_FIELD_NUMBER

public static final int DISABLE_RETRIES_FIELD_NUMBER
Field Value
TypeDescription
int

RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER

public static final int RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER
Field Value
TypeDescription
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Scheduling getDefaultInstance()
Returns
TypeDescription
Scheduling

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Scheduling.Builder newBuilder()
Returns
TypeDescription
Scheduling.Builder

newBuilder(Scheduling prototype)

public static Scheduling.Builder newBuilder(Scheduling prototype)
Parameter
NameDescription
prototypeScheduling
Returns
TypeDescription
Scheduling.Builder

parseDelimitedFrom(InputStream input)

public static Scheduling parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Scheduling parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Scheduling parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Scheduling parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Scheduling parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Scheduling parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Scheduling
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Scheduling> parser()
Returns
TypeDescription
Parser<Scheduling>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Scheduling getDefaultInstanceForType()
Returns
TypeDescription
Scheduling

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
TypeDescription
boolean

The disableRetries.

getParserForType()

public Parser<Scheduling> getParserForType()
Returns
TypeDescription
Parser<Scheduling>
Overrides

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
TypeDescription
boolean

The restartJobOnWorkerRestart.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTimeout()

public Duration getTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
TypeDescription
Duration

The timeout.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
TypeDescription
DurationOrBuilder

hasTimeout()

public boolean hasTimeout()

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

.google.protobuf.Duration timeout = 1;

Returns
TypeDescription
boolean

Whether the timeout field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Scheduling.Builder newBuilderForType()
Returns
TypeDescription
Scheduling.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Scheduling.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Scheduling.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Scheduling.Builder toBuilder()
Returns
TypeDescription
Scheduling.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException