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