Package com.google.cloud.aiplatform.v1
Class Schedule
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.Schedule
- All Implemented Interfaces:
ScheduleOrBuilder,com.google.protobuf.Message,com.google.protobuf.MessageLite,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,Serializable
@Generated
public final class Schedule
extends com.google.protobuf.GeneratedMessage
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.v1.Schedule- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classAn instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.static enumstatic final classStatus of a scheduled run.static interfacestatic enumPossible state of the schedule.static enumNested 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.BuilderParentNested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessage
alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanOptional.booleanOutput only.Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.getCron()Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.com.google.protobuf.ByteStringCron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.static Schedulestatic final com.google.protobuf.Descriptors.DescriptorRequired.com.google.protobuf.ByteStringRequired.com.google.protobuf.TimestampOptional.com.google.protobuf.TimestampOrBuilderOptional.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.Output only.Output only.longOptional.longRequired.longOptional.getName()Immutable.com.google.protobuf.ByteStringImmutable.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.com.google.protobuf.Parser<Schedule>intlongOutput only.com.google.protobuf.TimestampOptional.com.google.protobuf.TimestampOrBuilderOptional.getState()Output only.intOutput only.com.google.protobuf.TimestampOutput only.com.google.protobuf.TimestampOrBuilderOutput only.booleanRequest for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].booleanRequest for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob].booleanOutput only.booleanhasCron()Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.booleanOptional.inthashCode()booleanOutput only.booleanOutput only.booleanOutput only.booleanOutput only.booleanOptional.booleanOutput only.protected com.google.protobuf.GeneratedMessage.FieldAccessorTablefinal booleanstatic Schedule.Builderstatic Schedule.BuildernewBuilder(Schedule prototype) protected Schedule.BuildernewBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) static ScheduleparseDelimitedFrom(InputStream input) static ScheduleparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScheduleparseFrom(byte[] data) static ScheduleparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScheduleparseFrom(com.google.protobuf.ByteString data) static ScheduleparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScheduleparseFrom(com.google.protobuf.CodedInputStream input) static ScheduleparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScheduleparseFrom(InputStream input) static ScheduleparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ScheduleparseFrom(ByteBuffer data) static ScheduleparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Schedule>parser()voidwriteTo(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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashFields, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
CRON_FIELD_NUMBER
public static final int CRON_FIELD_NUMBER- See Also:
-
CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER
public static final int CREATE_PIPELINE_JOB_REQUEST_FIELD_NUMBER- See Also:
-
CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER
public static final int CREATE_NOTEBOOK_EXECUTION_JOB_REQUEST_FIELD_NUMBER- See Also:
-
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER- See Also:
-
DISPLAY_NAME_FIELD_NUMBER
public static final int DISPLAY_NAME_FIELD_NUMBER- See Also:
-
START_TIME_FIELD_NUMBER
public static final int START_TIME_FIELD_NUMBER- See Also:
-
END_TIME_FIELD_NUMBER
public static final int END_TIME_FIELD_NUMBER- See Also:
-
MAX_RUN_COUNT_FIELD_NUMBER
public static final int MAX_RUN_COUNT_FIELD_NUMBER- See Also:
-
STARTED_RUN_COUNT_FIELD_NUMBER
public static final int STARTED_RUN_COUNT_FIELD_NUMBER- See Also:
-
STATE_FIELD_NUMBER
public static final int STATE_FIELD_NUMBER- See Also:
-
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER- See Also:
-
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER- See Also:
-
NEXT_RUN_TIME_FIELD_NUMBER
public static final int NEXT_RUN_TIME_FIELD_NUMBER- See Also:
-
LAST_PAUSE_TIME_FIELD_NUMBER
public static final int LAST_PAUSE_TIME_FIELD_NUMBER- See Also:
-
LAST_RESUME_TIME_FIELD_NUMBER
public static final int LAST_RESUME_TIME_FIELD_NUMBER- See Also:
-
MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER
public static final int MAX_CONCURRENT_RUN_COUNT_FIELD_NUMBER- See Also:
-
MAX_CONCURRENT_ACTIVE_RUN_COUNT_FIELD_NUMBER
public static final int MAX_CONCURRENT_ACTIVE_RUN_COUNT_FIELD_NUMBER- See Also:
-
ALLOW_QUEUEING_FIELD_NUMBER
public static final int ALLOW_QUEUEING_FIELD_NUMBER- See Also:
-
CATCH_UP_FIELD_NUMBER
public static final int CATCH_UP_FIELD_NUMBER- See Also:
-
LAST_SCHEDULED_RUN_RESPONSE_FIELD_NUMBER
public static final int LAST_SCHEDULED_RUN_RESPONSE_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:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessage
-
getTimeSpecificationCase
- Specified by:
getTimeSpecificationCasein interfaceScheduleOrBuilder
-
getRequestCase
- Specified by:
getRequestCasein interfaceScheduleOrBuilder
-
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;- Specified by:
hasCronin interfaceScheduleOrBuilder- Returns:
- Whether the cron field is set.
-
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;- Specified by:
getCronin interfaceScheduleOrBuilder- Returns:
- The cron.
-
getCronBytes
public com.google.protobuf.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;- Specified by:
getCronBytesin interfaceScheduleOrBuilder- Returns:
- The bytes for cron.
-
hasCreatePipelineJobRequest
public boolean hasCreatePipelineJobRequest()Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})..google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;- Specified by:
hasCreatePipelineJobRequestin interfaceScheduleOrBuilder- Returns:
- Whether the createPipelineJobRequest field is set.
-
getCreatePipelineJobRequest
Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})..google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;- Specified by:
getCreatePipelineJobRequestin interfaceScheduleOrBuilder- Returns:
- The createPipelineJobRequest.
-
getCreatePipelineJobRequestOrBuilder
Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location})..google.cloud.aiplatform.v1.CreatePipelineJobRequest create_pipeline_job_request = 14;- Specified by:
getCreatePipelineJobRequestOrBuilderin interfaceScheduleOrBuilder
-
hasCreateNotebookExecutionJobRequest
public boolean hasCreateNotebookExecutionJobRequest()Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
.google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;- Specified by:
hasCreateNotebookExecutionJobRequestin interfaceScheduleOrBuilder- Returns:
- Whether the createNotebookExecutionJobRequest field is set.
-
getCreateNotebookExecutionJobRequest
Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
.google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;- Specified by:
getCreateNotebookExecutionJobRequestin interfaceScheduleOrBuilder- Returns:
- The createNotebookExecutionJobRequest.
-
getCreateNotebookExecutionJobRequestOrBuilder
Request for [NotebookService.CreateNotebookExecutionJob][google.cloud.aiplatform.v1.NotebookService.CreateNotebookExecutionJob].
.google.cloud.aiplatform.v1.CreateNotebookExecutionJobRequest create_notebook_execution_job_request = 20;- Specified by:
getCreateNotebookExecutionJobRequestOrBuilderin interfaceScheduleOrBuilder
-
getName
Immutable. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNamein interfaceScheduleOrBuilder- Returns:
- The name.
-
getNameBytes
public com.google.protobuf.ByteString getNameBytes()Immutable. The resource name of the Schedule.
string name = 1 [(.google.api.field_behavior) = IMMUTABLE];- Specified by:
getNameBytesin interfaceScheduleOrBuilder- Returns:
- The bytes for name.
-
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];- Specified by:
getDisplayNamein interfaceScheduleOrBuilder- Returns:
- The displayName.
-
getDisplayNameBytes
public com.google.protobuf.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];- Specified by:
getDisplayNameBytesin interfaceScheduleOrBuilder- Returns:
- The bytes for displayName.
-
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];- Specified by:
hasStartTimein interfaceScheduleOrBuilder- Returns:
- Whether the startTime field is set.
-
getStartTime
public com.google.protobuf.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];- Specified by:
getStartTimein interfaceScheduleOrBuilder- Returns:
- The startTime.
-
getStartTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getStartTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
hasEndTimein interfaceScheduleOrBuilder- Returns:
- Whether the endTime field is set.
-
getEndTime
public com.google.protobuf.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];- Specified by:
getEndTimein interfaceScheduleOrBuilder- Returns:
- The endTime.
-
getEndTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getEndTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
getMaxRunCountin interfaceScheduleOrBuilder- Returns:
- The maxRunCount.
-
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];- Specified by:
getStartedRunCountin interfaceScheduleOrBuilder- Returns:
- The startedRunCount.
-
getStateValue
public int getStateValue()Output only. The state of this Schedule.
.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStateValuein interfaceScheduleOrBuilder- Returns:
- The enum numeric value on the wire for state.
-
getState
Output only. The state of this Schedule.
.google.cloud.aiplatform.v1.Schedule.State state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getStatein interfaceScheduleOrBuilder- Returns:
- The state.
-
hasCreateTime
public boolean hasCreateTime()Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasCreateTimein interfaceScheduleOrBuilder- Returns:
- Whether the createTime field is set.
-
getCreateTime
public com.google.protobuf.Timestamp getCreateTime()Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimein interfaceScheduleOrBuilder- Returns:
- The createTime.
-
getCreateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()Output only. Timestamp when this Schedule was created.
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getCreateTimeOrBuilderin interfaceScheduleOrBuilder
-
hasUpdateTime
public boolean hasUpdateTime()Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasUpdateTimein interfaceScheduleOrBuilder- Returns:
- Whether the updateTime field is set.
-
getUpdateTime
public com.google.protobuf.Timestamp getUpdateTime()Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimein interfaceScheduleOrBuilder- Returns:
- The updateTime.
-
getUpdateTimeOrBuilder
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()Output only. Timestamp when this Schedule was updated.
.google.protobuf.Timestamp update_time = 19 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getUpdateTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
hasNextRunTimein interfaceScheduleOrBuilder- Returns:
- Whether the nextRunTime field is set.
-
getNextRunTime
public com.google.protobuf.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];- Specified by:
getNextRunTimein interfaceScheduleOrBuilder- Returns:
- The nextRunTime.
-
getNextRunTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getNextRunTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
hasLastPauseTimein interfaceScheduleOrBuilder- Returns:
- Whether the lastPauseTime field is set.
-
getLastPauseTime
public com.google.protobuf.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];- Specified by:
getLastPauseTimein interfaceScheduleOrBuilder- Returns:
- The lastPauseTime.
-
getLastPauseTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getLastPauseTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
hasLastResumeTimein interfaceScheduleOrBuilder- Returns:
- Whether the lastResumeTime field is set.
-
getLastResumeTime
public com.google.protobuf.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];- Specified by:
getLastResumeTimein interfaceScheduleOrBuilder- Returns:
- The lastResumeTime.
-
getLastResumeTimeOrBuilder
public com.google.protobuf.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];- Specified by:
getLastResumeTimeOrBuilderin interfaceScheduleOrBuilder
-
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];- Specified by:
getMaxConcurrentRunCountin interfaceScheduleOrBuilder- Returns:
- The maxConcurrentRunCount.
-
getMaxConcurrentActiveRunCount
public long getMaxConcurrentActiveRunCount()Optional. Specifies the maximum number of active runs that can be executed concurrently for this Schedule. This limits the number of runs that can be in a non-terminal state at the same time. Currently, this field is only supported for requests of type CreatePipelineJobRequest.
int64 max_concurrent_active_run_count = 21 [(.google.api.field_behavior) = OPTIONAL];- Specified by:
getMaxConcurrentActiveRunCountin interfaceScheduleOrBuilder- Returns:
- The maxConcurrentActiveRunCount.
-
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];- Specified by:
getAllowQueueingin interfaceScheduleOrBuilder- Returns:
- 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];- Specified by:
getCatchUpin interfaceScheduleOrBuilder- Returns:
- The catchUp.
-
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.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
hasLastScheduledRunResponsein interfaceScheduleOrBuilder- Returns:
- Whether the lastScheduledRunResponse field is set.
-
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.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLastScheduledRunResponsein interfaceScheduleOrBuilder- Returns:
- The lastScheduledRunResponse.
-
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.v1.Schedule.RunResponse last_scheduled_run_response = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];- Specified by:
getLastScheduledRunResponseOrBuilderin interfaceScheduleOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessage
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessage- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessage
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.google.protobuf.AbstractMessage
-
parseFrom
public static Schedule parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Schedule parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Schedule parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Schedule parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Schedule parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static Schedule parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Schedule parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Schedule parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Schedule parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Schedule.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent) - Overrides:
newBuilderForTypein classcom.google.protobuf.AbstractMessage
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessage
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-