Class Schedule (3.47.0)

Version 3.47.0

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.0.0
• 2.9.8
• 2.8.9
• 2.7.4
• 2.5.3
• 2.4.0

public final class Schedule extends GeneratedMessageV3 implements ScheduleOrBuilder

An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.

Protobuf type google.cloud.aiplatform.v1beta1.Schedule

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > Schedule

Implements

ScheduleOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOW_QUEUEING_FIELD_NUMBER

public static final int ALLOW_QUEUEING_FIELD_NUMBER

Field Value
Type	Description
int

CATCH_UP_FIELD_NUMBER

public static final int CATCH_UP_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_MODEL_MONITORING_JOB_REQUEST_FIELD_NUMBER

public static final int CREATE_MODEL_MONITORING_JOB_REQUEST_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER

public static final int CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER

public static final int CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER

Field Value
Type	Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

CRON_FIELD_NUMBER

public static final int CRON_FIELD_NUMBER

Field Value
Type	Description
int

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER

Field Value
Type	Description
int

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER

Field Value
Type	Description
int

LAST_PAUSE_TIME_FIELD_NUMBER

public static final int LAST_PAUSE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

LAST_RESUME_TIME_FIELD_NUMBER

public static final int LAST_RESUME_TIME_FIELD_NUMBER

Field Value
Type	Description
int

LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER

public static final int LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER

Field Value
Type	Description
int

MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER

public static final int MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

MAX_RUN_COUNT_FIELD_NUMBER

public static final int MAX_RUN_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

Field Value
Type	Description
int

NEXT_RUN_TIME_FIELD_NUMBER

public static final int NEXT_RUN_TIME_FIELD_NUMBER

Field Value
Type	Description
int

STARTED_RUN_COUNT_FIELD_NUMBER

public static final int STARTED_RUN_COUNT_FIELD_NUMBER

Field Value
Type	Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER

Field Value
Type	Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER

Field Value
Type	Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Schedule getDefaultInstance()

Returns
Type	Description
Schedule

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Schedule.Builder newBuilder()

Returns
Type	Description
Schedule.Builder

newBuilder(Schedule prototype)

public static Schedule.Builder newBuilder(Schedule prototype)

Parameter
Name	Description
prototype	Schedule

Returns
Type	Description
Schedule.Builder

parseDelimitedFrom(InputStream input)

public static Schedule parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Schedule parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Schedule parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Schedule parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Schedule parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Schedule parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Schedule parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Schedule

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Schedule> parser()

Returns
Type	Description
Parser<Schedule>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllowQueueing()

public boolean getAllowQueueing()

Optional. Whether new scheduled runs can be queued when max_concurrent_runs limit is reached. If set to true, new runs will be queued instead of skipped. Default to false.

bool allow_queueing = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	The allowQueueing.

getCatchUp()

public boolean getCatchUp()

Output only. Whether to backfill missed runs when the schedule is resumed from PAUSED state. If set to true, all missed runs will be scheduled. New runs will be scheduled after the backfill is complete. Default to false.

bool catch_up = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	The catchUp.

getCreateModelMonitoringJobRequest()

public CreateModelMonitoringJobRequest getCreateModelMonitoringJobRequest()

Request for ModelMonitoringService.CreateModelMonitoringJob.

.google.cloud.aiplatform.v1beta1.CreateModelMonitoringJobRequest create_model_monitoring_job_request = 15;

Returns
Type	Description
CreateModelMonitoringJobRequest	The createModelMonitoringJobRequest.

getCreateModelMonitoringJobRequestOrBuilder()

public CreateModelMonitoringJobRequestOrBuilder getCreateModelMonitoringJobRequestOrBuilder()

Request for ModelMonitoringService.CreateModelMonitoringJob.

.google.cloud.aiplatform.v1beta1.CreateModelMonitoringJobRequest create_model_monitoring_job_request = 15;

Returns
Type	Description
CreateModelMonitoringJobRequestOrBuilder

getCreateNotebookExecutionJobRequest()

public CreateNotebookExecutionJobRequest getCreateNotebookExecutionJobRequest()

Request for NotebookService.CreateNotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;

Returns
Type	Description
CreateNotebookExecutionJobRequest	The createNotebookExecutionJobRequest.

getCreateNotebookExecutionJobRequestOrBuilder()

public CreateNotebookExecutionJobRequestOrBuilder getCreateNotebookExecutionJobRequestOrBuilder()

Request for NotebookService.CreateNotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;

Returns
Type	Description
CreateNotebookExecutionJobRequestOrBuilder

getCreatePipelineJobRequest()

public CreatePipelineJobRequest getCreatePipelineJobRequest()

Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

Returns
Type	Description
CreatePipelineJobRequest	The createPipelineJobRequest.

getCreatePipelineJobRequestOrBuilder()

public CreatePipelineJobRequestOrBuilder getCreatePipelineJobRequestOrBuilder()

Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

Returns
Type	Description
CreatePipelineJobRequestOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. Timestamp when this Schedule was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Timestamp when this Schedule was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getCron()

public String getCron()

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".

string cron = 10;

Returns
Type	Description
String	The cron.

getCronBytes()

public ByteString getCronBytes()

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".

string cron = 10;

Returns
Type	Description
ByteString	The bytes for cron.

getDefaultInstanceForType()

public Schedule getDefaultInstanceForType()

Returns
Type	Description
Schedule

getDisplayName()

public String getDisplayName()

Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ByteString	The bytes for displayName.

getEndTime()

public Timestamp getEndTime()

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getLastPauseTime()

public Timestamp getLastPauseTime()

Output only. Timestamp when this Schedule was last paused. Unset if never paused.

.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The lastPauseTime.

getLastPauseTimeOrBuilder()

public TimestampOrBuilder getLastPauseTimeOrBuilder()

Output only. Timestamp when this Schedule was last paused. Unset if never paused.

.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getLastResumeTime()

public Timestamp getLastResumeTime()

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The lastResumeTime.

getLastResumeTimeOrBuilder()

public TimestampOrBuilder getLastResumeTimeOrBuilder()

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getLastScheduledRunResponse()

public Schedule.RunResponse getLastScheduledRunResponse()

Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.

.google.cloud.aiplatform.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Schedule.RunResponse	The lastScheduledRunResponse.

getLastScheduledRunResponseOrBuilder()

public Schedule.RunResponseOrBuilder getLastScheduledRunResponseOrBuilder()

Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.

.google.cloud.aiplatform.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Schedule.RunResponseOrBuilder

getMaxConcurrentRunCount()

public long getMaxConcurrentRunCount()

Required. Maximum number of runs that can be started concurrently for this Schedule. This is the limit for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable).

int64 max_concurrent_run_count = 11 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
long	The maxConcurrentRunCount.

getMaxRunCount()

public long getMaxRunCount()

Optional. Maximum run count of the schedule. If specified, The schedule will be completed when either started_run_count >= max_run_count or when end_time is reached. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

int64 max_run_count = 16 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
long	The maxRunCount.

getName()

public String getName()

Immutable. The resource name of the Schedule.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

Immutable. The resource name of the Schedule.

string name = 1 [(.google.api.field_behavior) = IMMUTABLE];

Returns
Type	Description
ByteString	The bytes for name.

getNextRunTime()

public Timestamp getNextRunTime()

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The nextRunTime.

getNextRunTimeOrBuilder()

public TimestampOrBuilder getNextRunTimeOrBuilder()

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getParserForType()

public Parser<Schedule> getParserForType()

Returns
Type	Description
Parser<Schedule>

Overrides

GeneratedMessageV3.getParserForType()

getRequestCase()

public Schedule.RequestCase getRequestCase()

Returns
Type	Description
Schedule.RequestCase

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

getStartTime()

public Timestamp getStartTime()

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
Timestamp	The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
TimestampOrBuilder

getStartedRunCount()

public long getStartedRunCount()

Output only. The number of runs started by this schedule.

int64 started_run_count = 17 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
long	The startedRunCount.

getState()

public Schedule.State getState()

Output only. The state of this Schedule.

.google.cloud.aiplatform.v1beta1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Schedule.State	The state.

getStateValue()

public int getStateValue()

Output only. The state of this Schedule.

.google.cloud.aiplatform.v1beta1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for state.

getTimeSpecificationCase()

public Schedule.TimeSpecificationCase getTimeSpecificationCase()

Returns
Type	Description
Schedule.TimeSpecificationCase

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Timestamp when this Schedule was updated.

.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Timestamp when this Schedule was updated.

.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateModelMonitoringJobRequest()

public boolean hasCreateModelMonitoringJobRequest()

Request for ModelMonitoringService.CreateModelMonitoringJob.

.google.cloud.aiplatform.v1beta1.CreateModelMonitoringJobRequest create_model_monitoring_job_request = 15;

Returns
Type	Description
boolean	Whether the createModelMonitoringJobRequest field is set.

hasCreateNotebookExecutionJobRequest()

public boolean hasCreateNotebookExecutionJobRequest()

Request for NotebookService.CreateNotebookExecutionJob.

.google.cloud.aiplatform.v1beta1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;

Returns
Type	Description
boolean	Whether the createNotebookExecutionJobRequest field is set.

hasCreatePipelineJobRequest()

public boolean hasCreatePipelineJobRequest()

Request for PipelineService.CreatePipelineJob. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).

.google.cloud.aiplatform.v1beta1.CreatePipelineJobRequest create_pipeline_job_request = 14;

Returns
Type	Description
boolean	Whether the createPipelineJobRequest field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Timestamp when this Schedule was created.

.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasCron()

public boolean hasCron()

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE}" or "TZ=${IANA_TIME_ZONE}". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *".

string cron = 10;

Returns
Type	Description
boolean	Whether the cron field is set.

hasEndTime()

public boolean hasEndTime()

Optional. Timestamp after which no new runs can be scheduled. If specified, The schedule will be completed when either end_time is reached or when scheduled_run_count >= max_run_count. If not specified, new runs will keep getting scheduled until this Schedule is paused or deleted. Already scheduled runs will be allowed to complete. Unset if not specified.

.google.protobuf.Timestamp end_time = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the endTime field is set.

hasLastPauseTime()

public boolean hasLastPauseTime()

Output only. Timestamp when this Schedule was last paused. Unset if never paused.

.google.protobuf.Timestamp last_pause_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the lastPauseTime field is set.

hasLastResumeTime()

public boolean hasLastResumeTime()

Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.

.google.protobuf.Timestamp last_resume_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the lastResumeTime field is set.

hasLastScheduledRunResponse()

public boolean hasLastScheduledRunResponse()

Output only. Response of the last scheduled run. This is the response for starting the scheduled requests and not the execution of the operations/jobs created by the requests (if applicable). Unset if no run has been scheduled yet.

.google.cloud.aiplatform.v1beta1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the lastScheduledRunResponse field is set.

hasNextRunTime()

public boolean hasNextRunTime()

Output only. Timestamp when this Schedule should schedule the next run. Having a next_run_time in the past means the runs are being started behind schedule.

.google.protobuf.Timestamp next_run_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the nextRunTime field is set.

hasStartTime()

public boolean hasStartTime()

Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.

.google.protobuf.Timestamp start_time = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the startTime field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Timestamp when this Schedule was updated.

.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public Schedule.Builder newBuilderForType()

Returns
Type	Description
Schedule.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Schedule.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Schedule.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public Schedule.Builder toBuilder()

Returns
Type	Description
Schedule.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException