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.
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.
public CreatePipelineJobRequest CreatePipelineJobRequest { get; set; }
Request for
[PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob].
CreatePipelineJobRequest.parent field is required (format:
projects/{project}/locations/{location}).
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 * * * *".
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.
public Schedule.Types.RunResponse LastScheduledRunResponse { get; set; }
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.
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).
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThe \u003ccode\u003eSchedule\u003c/code\u003e class in the Vertex AI v1beta1 API allows users to schedule periodic runs for making API calls based on specified times and request types.\u003c/p\u003e\n"],["\u003cp\u003eSchedules can be configured with a cron-based system, allowing for detailed timing specifications, including specific time zones.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eSchedule\u003c/code\u003e class provides options for managing run queuing, backfilling missed runs, setting start and end times, and limiting the maximum number of concurrent or total runs.\u003c/p\u003e\n"],["\u003cp\u003eThe status of a schedule can be tracked using properties like \u003ccode\u003eState\u003c/code\u003e, \u003ccode\u003eLastPauseTime\u003c/code\u003e, \u003ccode\u003eLastResumeTime\u003c/code\u003e, \u003ccode\u003eNextRunTime\u003c/code\u003e, and \u003ccode\u003eLastScheduledRunResponse\u003c/code\u003e, which provide insights into its activity and history.\u003c/p\u003e\n"],["\u003cp\u003eUsers can specify requests for \u003ccode\u003eCreateModelMonitoringJob\u003c/code\u003e, \u003ccode\u003eCreateNotebookExecutionJob\u003c/code\u003e, or \u003ccode\u003eCreatePipelineJob\u003c/code\u003e within a schedule, enabling automated execution of various AI platform tasks.\u003c/p\u003e\n"]]],[],null,["# Vertex AI v1beta1 API - Class Schedule (1.0.0-beta47)\n\nVersion latestkeyboard_arrow_down\n\n- [1.0.0-beta47 (latest)](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Schedule)\n- [1.0.0-beta46](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/1.0.0-beta46/Google.Cloud.AIPlatform.V1Beta1.Schedule) \n\n public sealed class Schedule : IMessage\u003cSchedule\u003e, IEquatable\u003cSchedule\u003e, IDeepCloneable\u003cSchedule\u003e, IBufferMessage, IMessage\n\nReference documentation and code samples for the Vertex AI v1beta1 API class Schedule.\n\nAn instance of a Schedule periodically schedules runs to make API calls based\non user specified time specification and API request type. \n\nInheritance\n-----------\n\n[object](https://learn.microsoft.com/dotnet/api/system.object) \\\u003e Schedule \n\nImplements\n----------\n\n[IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage-1.html)[Schedule](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Schedule), [IEquatable](https://learn.microsoft.com/dotnet/api/system.iequatable-1)[Schedule](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Schedule), [IDeepCloneable](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IDeepCloneable-1.html)[Schedule](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Schedule), [IBufferMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IBufferMessage.html), [IMessage](https://cloud.google.com/dotnet/docs/reference/Google.Protobuf/latest/Google.Protobuf.IMessage.html) \n\nInherited Members\n-----------------\n\n[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode) \n[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype) \n[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring)\n\nNamespace\n---------\n\n[Google.Cloud.AIPlatform.V1Beta1](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1)\n\nAssembly\n--------\n\nGoogle.Cloud.AIPlatform.V1Beta1.dll\n\nConstructors\n------------\n\n### Schedule()\n\n public Schedule()\n\n### Schedule(Schedule)\n\n public Schedule(Schedule other)\n\nProperties\n----------\n\n### AllowQueueing\n\n public bool AllowQueueing { get; set; }\n\nOptional. Whether new scheduled runs can be queued when max_concurrent_runs\nlimit is reached. If set to true, new runs will be queued instead of\nskipped. Default to false.\n\n### CatchUp\n\n public bool CatchUp { get; set; }\n\nOutput only. Whether to backfill missed runs when the schedule is resumed\nfrom PAUSED state. If set to true, all missed runs will be scheduled. New\nruns will be scheduled after the backfill is complete. Default to false.\n\n### CreateModelMonitoringJobRequest\n\n public CreateModelMonitoringJobRequest CreateModelMonitoringJobRequest { get; set; }\n\nRequest for\n\\[ModelMonitoringService.CreateModelMonitoringJob\\]\\[google.cloud.aiplatform.v1beta1.ModelMonitoringService.CreateModelMonitoringJob\\].\n\n### CreateNotebookExecutionJobRequest\n\n public CreateNotebookExecutionJobRequest CreateNotebookExecutionJobRequest { get; set; }\n\nRequest for\n\\[NotebookService.CreateNotebookExecutionJob\\]\\[google.cloud.aiplatform.v1beta1.NotebookService.CreateNotebookExecutionJob\\].\n\n### CreatePipelineJobRequest\n\n public CreatePipelineJobRequest CreatePipelineJobRequest { get; set; }\n\nRequest for\n\\[PipelineService.CreatePipelineJob\\]\\[google.cloud.aiplatform.v1beta1.PipelineService.CreatePipelineJob\\].\nCreatePipelineJobRequest.parent field is required (format:\nprojects/{project}/locations/{location}).\n\n### CreateTime\n\n public Timestamp CreateTime { get; set; }\n\nOutput only. Timestamp when this Schedule was created.\n\n### Cron\n\n public string Cron { get; set; }\n\nCron schedule (\u003chttps://en.wikipedia.org/wiki/Cron\u003e) to launch scheduled\nruns. To explicitly set a timezone to the cron tab, apply a prefix in the\ncron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\".\nThe ${IANA_TIME_ZONE} may only be a valid string from IANA time zone\ndatabase. For example, \"CRON_TZ=America/New_York 1 \\* \\* \\* \\*\", or\n\"TZ=America/New_York 1 \\* \\* \\* \\*\".\n\n### DisplayName\n\n public string DisplayName { get; set; }\n\nRequired. User provided name of the Schedule.\nThe name can be up to 128 characters long and can consist of any UTF-8\ncharacters.\n\n### EndTime\n\n public Timestamp EndTime { get; set; }\n\nOptional. Timestamp after which no new runs can be scheduled.\nIf specified, The schedule will be completed when either\nend_time is reached or when scheduled_run_count \\\u003e= max_run_count.\nIf not specified, new runs will keep getting scheduled until this Schedule\nis paused or deleted. Already scheduled runs will be allowed to complete.\nUnset if not specified.\n\n### HasCron\n\n public bool HasCron { get; }\n\nGets whether the \"cron\" field is set\n\n### LastPauseTime\n\n public Timestamp LastPauseTime { get; set; }\n\nOutput only. Timestamp when this Schedule was last paused.\nUnset if never paused.\n\n### LastResumeTime\n\n public Timestamp LastResumeTime { get; set; }\n\nOutput only. Timestamp when this Schedule was last resumed.\nUnset if never resumed from pause.\n\n### LastScheduledRunResponse\n\n public Schedule.Types.RunResponse LastScheduledRunResponse { get; set; }\n\nOutput only. Response of the last scheduled run.\nThis is the response for starting the scheduled requests and not the\nexecution of the operations/jobs created by the requests (if applicable).\nUnset if no run has been scheduled yet.\n\n### MaxConcurrentRunCount\n\n public long MaxConcurrentRunCount { get; set; }\n\nRequired. Maximum number of runs that can be started concurrently for this\nSchedule. This is the limit for starting the scheduled requests and not the\nexecution of the operations/jobs created by the requests (if applicable).\n\n### MaxRunCount\n\n public long MaxRunCount { get; set; }\n\nOptional. Maximum run count of the schedule.\nIf specified, The schedule will be completed when either\nstarted_run_count \\\u003e= max_run_count or when end_time is reached.\nIf not specified, new runs will keep getting scheduled until this Schedule\nis paused or deleted. Already scheduled runs will be allowed to complete.\nUnset if not specified.\n\n### Name\n\n public string Name { get; set; }\n\nImmutable. The resource name of the Schedule.\n\n### NextRunTime\n\n public Timestamp NextRunTime { get; set; }\n\nOutput only. Timestamp when this Schedule should schedule the next run.\nHaving a next_run_time in the past means the runs are being started\nbehind schedule.\n\n### RequestCase\n\n public Schedule.RequestOneofCase RequestCase { get; }\n\n### ScheduleName\n\n public ScheduleName ScheduleName { get; set; }\n\n[ScheduleName](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.ScheduleName)-typed view over the [Name](/dotnet/docs/reference/Google.Cloud.AIPlatform.V1Beta1/latest/Google.Cloud.AIPlatform.V1Beta1.Schedule#Google_Cloud_AIPlatform_V1Beta1_Schedule_Name) resource name property.\n\n### StartTime\n\n public Timestamp StartTime { get; set; }\n\nOptional. Timestamp after which the first run can be scheduled.\nDefault to Schedule create time if not specified.\n\n### StartedRunCount\n\n public long StartedRunCount { get; set; }\n\nOutput only. The number of runs started by this schedule.\n\n### State\n\n public Schedule.Types.State State { get; set; }\n\nOutput only. The state of this Schedule.\n\n### TimeSpecificationCase\n\n public Schedule.TimeSpecificationOneofCase TimeSpecificationCase { get; }\n\n### UpdateTime\n\n public Timestamp UpdateTime { get; set; }\n\nOutput only. Timestamp when this Schedule was updated."]]
