INPUT_OBJECT

CreateEngine

Input fields used to create a new engine.

GraphQL Schema definition

1 input CreateEngine {
4 
2 #   Optional given id
3 id: ID
10 
5 #   Indicates whether or not the engine should be public -- visible to and
6 #   usable by users outside the creator's organization.
7 #   Typically an engine should not be made public until it has been fully
8 #   configured and tested in production.
9 isPublic: Boolean
13 
11 #   Human-readable name for the engine
12 name: String
16 
14 #   An optional description for the engine.
15 description: String
19 
17 #   The engine category
18 categoryId: String!
22 
20 #   The engine deployment model. See the DeploymentModel enum for options.
21 deploymentModel: DeploymentModel!
25 
23 #   An optional price indicator for the engine.
24 price: Int
28 
26 #   Edge version. Default is 3.
27 edgeVersion: Int
32 
29 #   Optionally, supply custom fields that the user can set when launching
30 #   the engine. See developer documentation for details.
31 fields: [CreateEngineField!]
35 
33 #   Optionally, supply ID's of schemas that this engine will use as input schemas
34 schemas: [EngineSchema]
38 
36 #   The path for an icon image
37 iconPath: String
41 
39 #   The path for a logo image
40 logoPath: String
48 
42 #   Optionally, supply dependency information about this engine.
43 #   Currently this field cannot be set through the API
44 #   dependency: CreateEngineDependency
45 # 
46 #   Whether or not the engine requires a library.
47 libraryRequired: Boolean
51 
49 #   Whether or not the engine creates a TDO
50 createsTDO: Boolean
54 
52 #   List of use cases the engine serves
53 useCases: [String!]
57 
55 #   List of industries where the capabilities of the engine can be applied
56 industries: [String!]
60 
58 #   Generic Manifest for the engine based on data supplied during onboarding
59 manifest: JSONData
63 
61 #   Testing detail includes necessary data for engine certification process
62 testingDetails: TestingDetailsField
67 
64 #   JWT rights for engine, which is used for generating jwtToken rights later
65 #   Limit jwtRights update to private engines only
66 jwtRights: JWTRightsField
70 
68 #   Template Job definitions for standalone engine execution
69 standaloneJobTemplates: [CreateEngineJobTemplate!]
73 
71 #   CPU Resources required for engine to run, in milli-CPUs
72 cpuResourceMcpu: Int
76 
74 #   CPU Resources required for engine to run, in milli-CPUs
75 gpuSupported: GPUSupported
79 
77 #   Engine or Organization homepage
78 website: String
82 
80 #   In what way can this engine be distributed
81 distributionType: EngineDistributionType
85 
83 #   The tags associated with the engine
84 entityTags: [EntityTagInput]
88 
86 #   Indicates the metadata version number
87 metadataVersion: Int
89 }

Required by

MutationMutations are used to modify data. Each mutation takes an input that contains the data necessary to create or update the data in question.

1	input CreateEngine {
4
2	# Optional given id
3	id: ID
10
5	# Indicates whether or not the engine should be public -- visible to and
6	# usable by users outside the creator's organization.
7	# Typically an engine should not be made public until it has been fully
8	# configured and tested in production.
9	isPublic: Boolean
13
11	# Human-readable name for the engine
12	name: String
16
14	# An optional description for the engine.
15	description: String
19
17	# The engine category
18	categoryId: String!
22
20	# The engine deployment model. See the DeploymentModel enum for options.
21	deploymentModel: DeploymentModel!
25
23	# An optional price indicator for the engine.
24	price: Int
28
26	# Edge version. Default is 3.
27	edgeVersion: Int
32
29	# Optionally, supply custom fields that the user can set when launching
30	# the engine. See developer documentation for details.
31	fields: [CreateEngineField!]
35
33	# Optionally, supply ID's of schemas that this engine will use as input schemas
34	schemas: [EngineSchema]
38
36	# The path for an icon image
37	iconPath: String
41
39	# The path for a logo image
40	logoPath: String
48
42	# Optionally, supply dependency information about this engine.
43	# Currently this field cannot be set through the API
44	# dependency: CreateEngineDependency
45	#
46	# Whether or not the engine requires a library.
47	libraryRequired: Boolean
51
49	# Whether or not the engine creates a TDO
50	createsTDO: Boolean
54
52	# List of use cases the engine serves
53	useCases: [String!]
57
55	# List of industries where the capabilities of the engine can be applied
56	industries: [String!]
60
58	# Generic Manifest for the engine based on data supplied during onboarding
59	manifest: JSONData
63
61	# Testing detail includes necessary data for engine certification process
62	testingDetails: TestingDetailsField
67
64	# JWT rights for engine, which is used for generating jwtToken rights later
65	# Limit jwtRights update to private engines only
66	jwtRights: JWTRightsField
70
68	# Template Job definitions for standalone engine execution
69	standaloneJobTemplates: [CreateEngineJobTemplate!]
73
71	# CPU Resources required for engine to run, in milli-CPUs
72	cpuResourceMcpu: Int
76
74	# CPU Resources required for engine to run, in milli-CPUs
75	gpuSupported: GPUSupported
79
77	# Engine or Organization homepage
78	website: String
82
80	# In what way can this engine be distributed
81	distributionType: EngineDistributionType
85
83	# The tags associated with the engine
84	entityTags: [EntityTagInput]
88
86	# Indicates the metadata version number
87	metadataVersion: Int
89	}

CreateEngine

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by