Class Scheduling (3.48.0)

public final class Scheduling extends GeneratedMessageV3 implements SchedulingOrBuilder

All parameters related to queuing and scheduling of custom jobs.

Protobuf type google.cloud.aiplatform.v1beta1.Scheduling

Implements

SchedulingOrBuilder

Static Fields

DISABLE_RETRIES_FIELD_NUMBER

public static final int DISABLE_RETRIES_FIELD_NUMBER
Field Value
Type Description
int

RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER

public static final int RESTART_JOB_ON_WORKER_RESTART_FIELD_NUMBER
Field Value
Type Description
int

STRATEGY_FIELD_NUMBER

public static final int STRATEGY_FIELD_NUMBER
Field Value
Type Description
int

TIMEOUT_FIELD_NUMBER

public static final int TIMEOUT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Scheduling getDefaultInstance()
Returns
Type Description
Scheduling

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Scheduling.Builder newBuilder()
Returns
Type Description
Scheduling.Builder

newBuilder(Scheduling prototype)

public static Scheduling.Builder newBuilder(Scheduling prototype)
Parameter
Name Description
prototype Scheduling
Returns
Type Description
Scheduling.Builder

parseDelimitedFrom(InputStream input)

public static Scheduling parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Scheduling parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Scheduling parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Scheduling parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Scheduling parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Scheduling parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Scheduling parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Scheduling
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Scheduling> parser()
Returns
Type Description
Parser<Scheduling>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Scheduling getDefaultInstanceForType()
Returns
Type Description
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
Type Description
boolean

The disableRetries.

getParserForType()

public Parser<Scheduling> getParserForType()
Returns
Type Description
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
Type Description
boolean

The restartJobOnWorkerRestart.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStrategy()

public Scheduling.Strategy getStrategy()

Optional. This determines which type of scheduling strategy to use.

.google.cloud.aiplatform.v1beta1.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.v1beta1.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.

getTimeoutOrBuilder()

public DurationOrBuilder getTimeoutOrBuilder()

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

.google.protobuf.Duration timeout = 1;

Returns
Type Description
DurationOrBuilder

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Scheduling.Builder newBuilderForType()
Returns
Type Description
Scheduling.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Scheduling.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Scheduling.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Scheduling.Builder toBuilder()
Returns
Type Description
Scheduling.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException