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 String : 36 37 String : 38 39 String : 40 41 String : 42 43 ID : 44 45 # True if the engine creates a TemporalDataObject (TDO) as part of its 46 # execution. False otherwise. 47 Boolean : 48 49 String : 50 51 Int : 52 53 Int : 54 55 DateTime : 56 57 DateTime : 58 59 String : 60 61 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. 65 Boolean : 66 67 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. 77 ( 78 String], : [ 79 Int, : 80 Int, : 81 ID, : 82 TaskDateTimeFilter], : [ 83 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. 97 ( 98 BuildStatus!], : [ 99 String], : [ 100 Int, : 101 Int, : 102 ID, : 103 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. 117 ( 118 SchemaStatus!], : [ 119 Int, : 120 Int, : 121 ID, : 122 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. 136 ( 137 SchemaStatus!], : [ 138 Int, : 139 Int, : 140 ID, : 141 SchemaOrder] : [ 142 ): SchemaList 143 144 # Dependency information for this engine 145 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. 150 EngineField!] : [ 151 152 # The engine category 153 EngineCategory : 154 155 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. 159 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. 163 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. 167 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. 174 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. 179 Boolean : 180 181 # Get the deployed build version of this engine. If there is no deployed 182 # build, this field will be null. 183 Int : 184 185 # Specifies the mode in which the engine process input 186 EngineMode : 187 188 # Specifies the runtime type, such as "iron" or "edge" 189 String : 190 191 # Get oauth information based on the deployed build. If there is no deployed 192 # build, this field will be null. 193 String : 194 195 # Get engine flag which determines whether the engine is a conductor, 196 # this field will be null 197 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. 202 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) 211 DateTime, : DateTime): EngineTaskMetrics ( : 212 213 # List of use cases the engine serves 214 String!] : [ 215 216 # List of industries where the capabilities of the engine can be applied 217 String!] : [ 218 219 # Generic Manifest for the engine based on data supplied during onboarding 220 JSONData : 221 222 # Testing detail includes necessary data for engine certification process 223 TestingDetailsType : 224 225 # JWT rights for engine, which is used for generating jwtToken rights later 226 JSONData : 227 228 # Template Job definitions for standalone engine execution 229 # 230 # Arguments 231 # type: Retrieve sepcific template type 232 JobTemplateEnumType): [EngineJobTemplate] ( : 233 234 # CPU Required to run engine, in milli-CPU's 235 Int : 236 237 # GPU supported 238 GPUSupported : 239 240 # In what way can this engine be distributed 241 EngineDistributionType : 242 243 # The tags associated with the engine 244 EntityTag] : [ 245 246 }
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.