OBJECT

Engine

link GraphQL Schema definition

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