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