Class GoogleCloudAiplatformV1Schedule

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

Inheritance
object
GoogleCloudAiplatformV1Schedule
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1Schedule : IDirectResponseSchema

Properties

AllowQueueing

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.

Declaration
[JsonProperty("allowQueueing")]
public virtual bool? AllowQueueing { get; set; }
Property Value
Type Description
bool?

CatchUp

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.

Declaration
[JsonProperty("catchUp")]
public virtual bool? CatchUp { get; set; }
Property Value
Type Description
bool?

CreateNotebookExecutionJobRequest

Request for NotebookService.CreateNotebookExecutionJob.

Declaration
[JsonProperty("createNotebookExecutionJobRequest")]
public virtual GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest CreateNotebookExecutionJobRequest { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1CreateNotebookExecutionJobRequest

CreatePipelineJobRequest

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

Declaration
[JsonProperty("createPipelineJobRequest")]
public virtual GoogleCloudAiplatformV1CreatePipelineJobRequest CreatePipelineJobRequest { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1CreatePipelineJobRequest

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Timestamp when this Schedule was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

Cron

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 * * * *".

Declaration
[JsonProperty("cron")]
public virtual string Cron { get; set; }
Property Value
Type Description
string

DisplayName

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

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

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.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

LastPauseTime

object representation of LastPauseTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastPauseTimeDateTimeOffset instead.")]
public virtual object LastPauseTime { get; set; }
Property Value
Type Description
object

LastPauseTimeDateTimeOffset

DateTimeOffset representation of LastPauseTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastPauseTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastPauseTimeRaw

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

Declaration
[JsonProperty("lastPauseTime")]
public virtual string LastPauseTimeRaw { get; set; }
Property Value
Type Description
string

LastResumeTime

object representation of LastResumeTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use LastResumeTimeDateTimeOffset instead.")]
public virtual object LastResumeTime { get; set; }
Property Value
Type Description
object

LastResumeTimeDateTimeOffset

DateTimeOffset representation of LastResumeTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? LastResumeTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

LastResumeTimeRaw

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

Declaration
[JsonProperty("lastResumeTime")]
public virtual string LastResumeTimeRaw { get; set; }
Property Value
Type Description
string

LastScheduledRunResponse

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.

Declaration
[JsonProperty("lastScheduledRunResponse")]
public virtual GoogleCloudAiplatformV1ScheduleRunResponse LastScheduledRunResponse { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1ScheduleRunResponse

MaxConcurrentRunCount

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).

Declaration
[JsonProperty("maxConcurrentRunCount")]
public virtual long? MaxConcurrentRunCount { get; set; }
Property Value
Type Description
long?

MaxRunCount

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.

Declaration
[JsonProperty("maxRunCount")]
public virtual long? MaxRunCount { get; set; }
Property Value
Type Description
long?

Name

Immutable. The resource name of the Schedule.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NextRunTime

object representation of NextRunTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use NextRunTimeDateTimeOffset instead.")]
public virtual object NextRunTime { get; set; }
Property Value
Type Description
object

NextRunTimeDateTimeOffset

DateTimeOffset representation of NextRunTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? NextRunTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

NextRunTimeRaw

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.

Declaration
[JsonProperty("nextRunTime")]
public virtual string NextRunTimeRaw { get; set; }
Property Value
Type Description
string

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

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

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

StartedRunCount

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

Declaration
[JsonProperty("startedRunCount")]
public virtual long? StartedRunCount { get; set; }
Property Value
Type Description
long?

State

Output only. The state of this Schedule.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Timestamp when this Schedule was updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

Implements