GoogleCloudAiplatformV1Schedule

import type { GoogleCloudAiplatformV1Schedule } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

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

interface GoogleCloudAiplatformV1Schedule {

allowQueueing?: boolean;

readonly catchUp?: boolean;

createPipelineJobRequest?: GoogleCloudAiplatformV1CreatePipelineJobRequest;

readonly createTime?: Date;

cron?: string;

displayName?: string;

endTime?: Date;

readonly lastPauseTime?: Date;

readonly lastResumeTime?: Date;

readonly lastScheduledRunResponse?: GoogleCloudAiplatformV1ScheduleRunResponse;

maxConcurrentRunCount?: bigint;

maxRunCount?: bigint;

name?: string;

readonly nextRunTime?: Date;

readonly startedRunCount?: bigint;

startTime?: Date;

readonly state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "PAUSED"

| "COMPLETED";

readonly updateTime?: Date;

}

§Properties

allowQueueing?: boolean

[src]

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.

readonly catchUp?: boolean

[src]

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.

createPipelineJobRequest?: GoogleCloudAiplatformV1CreatePipelineJobRequest

[src]

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

readonly createTime?: Date

[src]

Output only. Timestamp when this Schedule was created.

cron?: string

[src]

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

displayName?: string

[src]

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

endTime?: Date

[src]

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.

readonly lastPauseTime?: Date

[src]

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

readonly lastResumeTime?: Date

[src]

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

readonly lastScheduledRunResponse?: GoogleCloudAiplatformV1ScheduleRunResponse

[src]

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.

maxConcurrentRunCount?: bigint

[src]

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

maxRunCount?: bigint

[src]

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.

name?: string

[src]

Immutable. The resource name of the Schedule.

readonly nextRunTime?: Date

[src]

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.

readonly startedRunCount?: bigint

[src]

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

startTime?: Date

[src]

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

readonly state?: "STATE_UNSPECIFIED" | "ACTIVE" | "PAUSED" | "COMPLETED"

[src]

Output only. The state of this Schedule.

readonly updateTime?: Date

[src]

Output only. Timestamp when this Schedule was updated.