OBJECT

ScheduledJob

link GraphQL Schema definition

1type ScheduledJob {
2
3id: ID!
4
5# Organization ID
6organizationId: ID
7
8# Organization that owns this scheduled job
9organization: Organization
10
11# Name of scheduled job
12name: String
13
14# Description for the scheduledJob
15description: String
16
17# This is the time the scheduled job will start ingesting.
18#
19# This is in Source Local Time
20#
21# Notes:
22# - If this is in the past, then ingestion will start here and go forward
23# - If this is the future, then ingestion will not start until that time is
24# reached
25startDateTime: DateTime
26
27# The stop time for the scheduledJob.
28#
29# This is in Source Local Time
30stopDateTime: DateTime
31
32# deprecated. DO NOT USE.
33# TODO(al): Remove
34jobTemplateIds: [ID!]
35
36# deprecated. DO NOT USE.
37# TODO(al): Remove
38jobTemplates(
39offset: Int,
40limit: Int
41): JobTemplateList! @deprecated( reason: "obsolete v2 construct" )
42
43# Retrieve the complete set of job templates associated with this
44# scheduled job, including those that are associated through a job
45# pipeline.
46allJobTemplates(offset: Int, limit: Int): JobTemplateList!
47
48# The ID of the primary source on this scheduled job, if applicable.
49# This is based on the payloads of the tasks that are invoked for
50# this scheduled job.
51primarySourceId: ID
52
53# The primary source. See `primarySourceId` above.
54primarySource: Source
55
56# Arguments
57# targetId: Optionally, specify a TDO ID to filter by job target
58# clusterId: Optionally, specify a cluster ID to filter by
59# cluster
60# orderBy: Provide sort information. The default is to sort by
61# createdDateTime descending.
62# dateTimeFilter: Optionally, specify filters on date/time
63# fields.
64# If a filter is not provided here, the query will
65# default to the past 3 months.
66# status: Provide a list of status strings to filter by status
67# offset: Provide an offset to skip to a certain element in the
68# result, for paging.
69# limit: Specify the maximum number of results to included in
70# this response, or page size.
71jobs(
72targetId: ID,
73clusterId: ID,
74orderBy: [JobSortField!],
75dateTimeFilter: [JobDateTimeFilter!],
76status: [JobStatusFilter!],
77offset: Int,
78limit: Int
79): JobList!
80
81# Get a list of sources that are used
82# by engine configurations that reference
83# this schedule through the schedule -> job -> task relationship.
84sources(offset: Int, limit: Int): SourceList
85
86# If the scheduled job is recurring, this is the day and times for the recurring
87# schedule
88parts: [SchedulePart!]
89
90# If true, this is active
91isActive: Boolean!
92
93# This is the scheduledJob Run Mode. Recurring, Continuous, Once or On Demand.
94#
95# On Demand will be launched when the API is called
96runMode: RunMode!
97
98details: JSONData
99
100detailsSchemaId: ID
101
102createdDateTime: DateTime
103
104modifiedDateTime: DateTime
105
106# List of schema-controlled content templates attached
107# to this scheduled job
108contentTemplates: [ScheduledJobContentTemplate!]!
109
110# Permissions granted to other organizations. Only the source owner
111# can view or edit this field.
112collaborators: ScheduledJobCollaboratorList!
113
114# A public scheduled job can be viewed and launched by
115# users from any organization. By default, scheduled jobs are
116# private and can only be viewed or launched by the owning organization
117# and organizations that the owner has explicitly shared them with.
118# Only Veritone administrators can create public scheduled jobs.
119isPublic: Boolean
120
121# The user's permission on this scheduled job
122permission: ScheduledJobPermission
123
124primarySourceTypeId: ID
125
126primarySourceType: SourceType
127
128ingestionStatusId: ID
129
130ingestionStatus: String
131
132affiliates: ProgramAffiliateList!
133
134}