OBJECT

Engine

link GraphQL Schema definition

1type Engine {
2
3id: ID!
4
5ownerOrganizationId: ID!
6
7isPublic: Boolean
8
9logoPath: String
10
11iconPath: String
12
13# The signed URL for the engine icon; will fallback to raw iconPath if unable to
14# sign.
15signedIconPath: String
16
17# The signed URL for the engine logo; will fallback to raw logoPath if unable to
18# sign.
19signedLogoPath: String
20
21name: String
22
23ownerOrganization: Organization
24
25description: String
26
27categoryId: String
28
29state: EngineState
30
31price: Int
32
33asset: String
34
35displayName: String
36
37validateUri: String
38
39executeUri: String
40
41applicationId: ID
42
43# True if the engine creates a TemporalDataObject (TDO) as part of its
44# execution. False otherwise.
45createsTDO: Boolean
46
47website: String
48
49rating: Int
50
51edgeVersion: Int
52
53createdDateTime: DateTime
54
55modifiedDateTime: DateTime
56
57createdBy: String
58
59modifiedBy: String
60
61# True if the engine requires a library to run. If so, a library ID must
62# be provided in the engine payload.
63libraryRequired: Boolean
64
65deploymentModel: DeploymentModel
66
67# Arguments
68# offset: Provide an offset to skip to a certain element in the
69# result, for paging.
70# limit: Specify maximum number of results to retrieve in this
71# result. Page size.
72# dateTimeFilter: Filter the tasks by date/time field.
73# If a filter is not provided, a default of `createdDateTime` between
74# three months ago and the current date will be applied.
75tasks(
76status: [String],
77offset: Int,
78limit: Int,
79id: ID,
80dateTimeFilter: [TaskDateTimeFilter],
81hasSourceAsset: Boolean
82): TaskList
83
84# Retrieve builds for the engine.
85# By default, deleted builds are not included.
86# Deleted builds can be retrieved by including the `deleted` status parameter.
87#
88# Arguments
89# offset: Provide an offset to skip to a certain element in the
90# result, for paging.
91# limit: Specify maximum number of results to retrieve in this
92# result. Page size.
93# orderBy: Set order information on the query. Multiple fields
94# are supported.
95builds(
96buildStatus: [BuildStatus!],
97status: [String],
98offset: Int,
99limit: Int,
100id: ID,
101orderBy: [EngineBuildOrderBy!]
102): BuildList
103
104# Retrieve input schemas being used by the engine.
105# By default, deleted schemas are not included.
106# Deleted schemas can be retrieved by including the `deleted` status parameter.
107#
108# Arguments
109# offset: Provide an offset to skip to a certain element in the
110# result, for paging.
111# limit: Specify maximum number of results to retrieve in this
112# result. Page size.
113# orderBy: Set order information on the query. Multiple fields
114# are supported.
115inputSchemas(
116schemaStatus: [SchemaStatus!],
117offset: Int,
118limit: Int,
119id: ID,
120orderBy: [SchemaOrder]
121): SchemaList
122
123# Retrieve output schemas being used by the engine.
124# By default, deleted schemas are not included.
125# Deleted schemas can be retrieved by including the `deleted` status parameter.
126#
127# Arguments
128# offset: Provide an offset to skip to a certain element in the
129# result, for paging.
130# limit: Specify maximum number of results to retrieve in this
131# result. Page size.
132# orderBy: Set order information on the query. Multiple fields
133# are supported.
134outputSchemas(
135schemaStatus: [SchemaStatus!],
136offset: Int,
137limit: Int,
138id: ID,
139orderBy: [SchemaOrder]
140): SchemaList
141
142# Dependency information for this engine
143dependency: EngineDependency
144
145# The list of custom fields on the engine. Users will be prompted to
146# set or change these values when they run the engine. For example, a
147# translation engine might have a field for the target language.
148fields: [EngineField!]
149
150# The engine category
151category: EngineCategory
152
153validStateActions: [EngineStateAction]
154
155# Get the engine's preferred input format, based on the latest deployed build.
156# If there is no deployed build this field cannot be populated.
157preferredInputFormat: String
158
159# Get the engine's supported input formats, based on the latest deployed build.
160# If there is no deployed build this field cannot be populated.
161supportedInputFormats: [String!]
162
163# Get the engine's output formats, based on the latest deployed build.
164# If there is no deployed build this field cannot be populated.
165outputFormats: [String!]
166
167# List of IDs of source types that the engine supports,
168# based on the latest deployed build.
169# If there is no deployed build this field cannot be populated.
170# Applies only to adapter engines that ingest data from a source.
171# Will be a list of IDs of SourceType objects.
172supportedSourceTypes: [String!]
173
174# Get the ingestion flag which determines whether the adapter has a scan phase
175# during ingestion.
176# If there is no deployed build this field cannot be populated.
177hasScanPhase: Boolean
178
179# Get the deployed build version of this engine. If there is no deployed
180# build, this field will be null.
181deployedVersion: Int
182
183# Specifies the mode in which the engine process input
184mode: EngineMode
185
186# Specifies the runtime type, such as "iron" or "edge"
187runtimeType: String
188
189# Get oauth information based on the deployed build. If there is no deployed
190# build, this field will be null.
191oauth: String
192
193# Get engine flag which determines whether the engine is a conductor,
194# this field will be null
195isConductor: Boolean
196
197# List of schedule types that the engine supports,
198# based on the latest deployed build.
199# If there is no deployed build, this field cannot be populated.
200supportedScheduleTypes: [EngineScheduleType!]
201
202# Retrieve task metrics for the engine
203#
204# Arguments
205# fromDateTime: Provide a starting date in ISO format (maximum
206# range of 7 days)
207# toDateTime: Provide an end date in ISO format (maximum range of
208# 7 days)
209taskMetrics(fromDateTime: DateTime, toDateTime: DateTime): EngineTaskMetrics
210
211# List of use cases the engine serves
212useCases: [String!]
213
214# List of industries where the capabilities of the engine can be applied
215industries: [String!]
216
217# Generic Manifest for the engine based on data supplied during onboarding
218manifest: JSONData
219
220# Testing detail includes necessary data for engine certification process
221testingDetails: TestingDetailsType
222
223# JWT rights for engine, which is used for generating jwtToken rights later
224jwtRights: JSONData
225
226# Template Job definitions for standalone engine execution
227#
228# Arguments
229# type: Retrieve sepcific template type
230standaloneJobTemplates(type: JobTemplateEnumType): [EngineJobTemplate]
231
232# CPU Required to run engine, in milli-CPU's
233cpuResourceMcpu: Int
234
235# GPU supported
236gpuSupported: GPUSupported
237
238# In what way can this engine be distributed
239distributionType: EngineDistributionType
240
241# The tags associated with the engine
242entityTags: [EntityTag]
243
244}