public sealed class Schedule : IMessage<Schedule>, IEquatable<Schedule>, IDeepCloneable<Schedule>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1 API class Schedule.
An instance of a Schedule periodically schedules runs to make API calls based on user specified time specification and API request type.
Namespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
Schedule()
public Schedule()Schedule(Schedule)
public Schedule(Schedule other)| Parameter | |
|---|---|
| Name | Description |
other | Schedule |
Properties
AllowQueueing
public bool AllowQueueing { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
CatchUp
public bool CatchUp { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
bool | |
CreatePipelineJobRequest
public CreatePipelineJobRequest CreatePipelineJobRequest { get; set; }Request for [PipelineService.CreatePipelineJob][google.cloud.aiplatform.v1.PipelineService.CreatePipelineJob]. CreatePipelineJobRequest.parent field is required (format: projects/{project}/locations/{location}).
| Property Value | |
|---|---|
| Type | Description |
CreatePipelineJobRequest | |
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp when this Schedule was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Cron
public string Cron { get; set; }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 * * * *".
| Property Value | |
|---|---|
| Type | Description |
string | |
DisplayName
public string DisplayName { get; set; }Required. User provided name of the Schedule. The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
EndTime
public Timestamp EndTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
HasCron
public bool HasCron { get; }Gets whether the "cron" field is set
| Property Value | |
|---|---|
| Type | Description |
bool | |
LastPauseTime
public Timestamp LastPauseTime { get; set; }Output only. Timestamp when this Schedule was last paused. Unset if never paused.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastResumeTime
public Timestamp LastResumeTime { get; set; }Output only. Timestamp when this Schedule was last resumed. Unset if never resumed from pause.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
LastScheduledRunResponse
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.
| Property Value | |
|---|---|
| Type | Description |
ScheduleTypesRunResponse | |
MaxConcurrentRunCount
public long MaxConcurrentRunCount { get; set; }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).
| Property Value | |
|---|---|
| Type | Description |
long | |
MaxRunCount
public long MaxRunCount { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
long | |
Name
public string Name { get; set; }Immutable. The resource name of the Schedule.
| Property Value | |
|---|---|
| Type | Description |
string | |
NextRunTime
public Timestamp NextRunTime { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
RequestCase
public Schedule.RequestOneofCase RequestCase { get; }| Property Value | |
|---|---|
| Type | Description |
ScheduleRequestOneofCase | |
ScheduleName
public ScheduleName ScheduleName { get; set; }ScheduleName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
ScheduleName | |
StartTime
public Timestamp StartTime { get; set; }Optional. Timestamp after which the first run can be scheduled. Default to Schedule create time if not specified.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
StartedRunCount
public long StartedRunCount { get; set; }Output only. The number of runs started by this schedule.
| Property Value | |
|---|---|
| Type | Description |
long | |
State
public Schedule.Types.State State { get; set; }Output only. The state of this Schedule.
| Property Value | |
|---|---|
| Type | Description |
ScheduleTypesState | |
TimeSpecificationCase
public Schedule.TimeSpecificationOneofCase TimeSpecificationCase { get; }| Property Value | |
|---|---|
| Type | Description |
ScheduleTimeSpecificationOneofCase | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp when this Schedule was updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |