OBJECT
Engine
link GraphQL Schema definition
1 type Engine { 2 3 : ID! 4 5 : Int 6 7 : ID! 8 9 : Boolean 10 11 : String 12 13 : String 14 15 # The signed URL for the engine icon; will fallback to raw iconPath if unable to 16 # sign. 17 : String 18 19 # The signed URL for the engine logo; will fallback to raw logoPath if unable to 20 # sign. 21 : String 22 23 : String 24 25 : Organization 26 27 : String 28 29 : String 30 31 : EngineState 32 33 : Int 34 35 : PriceDimension 36 37 : String 38 39 : String 40 41 : String 42 43 : String 44 45 : ID 46 47 # True if the engine creates a TemporalDataObject (TDO) as part of its 48 # execution. False otherwise. 49 : Boolean 50 51 : String 52 53 : Int 54 55 : Int 56 57 : DateTime 58 59 : DateTime 60 61 : String 62 63 : 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. 67 : Boolean 68 69 : 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. 79 ( 80 : [String], 81 : Int, 82 : Int, 83 : ID, 84 : [TaskDateTimeFilter], 85 : 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. 99 ( 100 : [BuildStatus!], 101 : [String], 102 : Int, 103 : Int, 104 : ID, 105 : [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. 119 ( 120 : [SchemaStatus!], 121 : Int, 122 : Int, 123 : ID, 124 : [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. 138 ( 139 : [SchemaStatus!], 140 : Int, 141 : Int, 142 : ID, 143 : [SchemaOrder] 144 ): SchemaList 145 146 # Dependency information for this engine 147 : 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. 152 : [EngineField!] 153 154 # The engine category 155 : EngineCategory 156 157 : [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. 161 : 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. 165 : [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. 169 : [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. 176 : [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. 181 : Boolean 182 183 # Get the deployed build version of this engine. If there is no deployed 184 # build, this field will be null. 185 : Int 186 187 # Specifies the mode in which the engine process input 188 : EngineMode 189 190 # Specifies the runtime type, such as "iron" or "edge" 191 : String 192 193 # Get oauth information based on the deployed build. If there is no deployed 194 # build, this field will be null. 195 : String 196 197 # Get engine flag which determines whether the engine is a conductor, 198 # this field will be null 199 : 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. 204 : [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) 213 (: DateTime, : DateTime): EngineTaskMetrics 214 215 # List of use cases the engine serves 216 : [String!] 217 218 # List of industries where the capabilities of the engine can be applied 219 : [String!] 220 221 # Generic Manifest for the engine based on data supplied during onboarding 222 : JSONData 223 224 # Testing detail includes necessary data for engine certification process 225 : TestingDetailsType 226 227 # JWT rights for engine, which is used for generating jwtToken rights later 228 : JSONData 229 230 # Template Job definitions for standalone engine execution 231 # 232 # Arguments 233 # type: Retrieve sepcific template type 234 (: JobTemplateEnumType): [EngineJobTemplate] 235 236 # CPU Required to run engine, in milli-CPU's 237 : Int 238 239 # GPU supported 240 : GPUSupported 241 242 # GPU required 243 : Boolean 244 245 # GPU Model 246 : GPUModel 247 248 # GPU driver version 249 : String 250 251 # Kernel version 252 : String 253 254 # In what way can this engine be distributed 255 : EngineDistributionType 256 257 # The tags associated with the engine 258 : [EntityTag] 259 260 }
link Required by
- AssetSourceDataA structure containing metadata about the source engine and task for an asset.
- Build
- EngineBlacklist
- EngineList
- EngineRunDescribes engine run on a TDO with
- EngineWhitelist
- LibraryEngineModel
- MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.
- QueryQueries are used to retrieve data. If you're new to our API, try the `me` query to explore the information you have access to. Hit `ctrl-space` at any time to activate field completion hints, and mouse over a field or parameter to see its documentation.
- TaskRepresents a single engine task
- TaskTemplate
- TDOSourceDataDescribes source information about a TDO. That is, the components and processes that produced it. Each field may or may not have a value, depending on how the TDO was created.