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 #   An optional price dimension for the engine.
27 priceDimension: PriceDimension
31 
29 #   Edge version. Default is 3.
30 edgeVersion: Int
35 
32 #   Optionally, supply custom fields that the user can set when launching
33 #   the engine. See developer documentation for details.
34 fields: [CreateEngineField!]
38 
36 #   Optionally, supply ID's of schemas that this engine will use as input schemas
37 schemas: [EngineSchema]
41 
39 #   The path for an icon image
40 iconPath: String
44 
42 #   The path for a logo image
43 logoPath: String
51 
45 #   Optionally, supply dependency information about this engine.
46 #   Currently this field cannot be set through the API
47 #   dependency: CreateEngineDependency
48 # 
49 #   Whether or not the engine requires a library.
50 libraryRequired: Boolean
54 
52 #   Whether or not the engine creates a TDO
53 createsTDO: Boolean
57 
55 #   List of use cases the engine serves
56 useCases: [String!]
60 
58 #   List of industries where the capabilities of the engine can be applied
59 industries: [String!]
63 
61 #   Generic Manifest for the engine based on data supplied during onboarding
62 manifest: JSONData
66 
64 #   Testing detail includes necessary data for engine certification process
65 testingDetails: TestingDetailsField
70 
67 #   JWT rights for engine, which is used for generating jwtToken rights later
68 #   Limit jwtRights update to private engines only
69 jwtRights: JWTRightsField
73 
71 #   Template Job definitions for standalone engine execution
72 standaloneJobTemplates: [CreateEngineJobTemplate!]
76 
74 #   CPU Resources required for engine to run, in milli-CPUs
75 cpuResourceMcpu: Int
79 
77 #   CPU Resources required for engine to run, in milli-CPUs
78 gpuSupported: GPUSupported
82 
80 #   Engine or Organization homepage
81 website: String
85 
83 #   In what way can this engine be distributed
84 distributionType: EngineDistributionType
88 
86 #   The tags associated with the engine
87 entityTags: [EntityTagInput]
91 
89 #   Indicates the metadata version number
90 metadataVersion: Int
92 }

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	# An optional price dimension for the engine.
27	priceDimension: PriceDimension
31
29	# Edge version. Default is 3.
30	edgeVersion: Int
35
32	# Optionally, supply custom fields that the user can set when launching
33	# the engine. See developer documentation for details.
34	fields: [CreateEngineField!]
38
36	# Optionally, supply ID's of schemas that this engine will use as input schemas
37	schemas: [EngineSchema]
41
39	# The path for an icon image
40	iconPath: String
44
42	# The path for a logo image
43	logoPath: String
51
45	# Optionally, supply dependency information about this engine.
46	# Currently this field cannot be set through the API
47	# dependency: CreateEngineDependency
48	#
49	# Whether or not the engine requires a library.
50	libraryRequired: Boolean
54
52	# Whether or not the engine creates a TDO
53	createsTDO: Boolean
57
55	# List of use cases the engine serves
56	useCases: [String!]
60
58	# List of industries where the capabilities of the engine can be applied
59	industries: [String!]
63
61	# Generic Manifest for the engine based on data supplied during onboarding
62	manifest: JSONData
66
64	# Testing detail includes necessary data for engine certification process
65	testingDetails: TestingDetailsField
70
67	# JWT rights for engine, which is used for generating jwtToken rights later
68	# Limit jwtRights update to private engines only
69	jwtRights: JWTRightsField
73
71	# Template Job definitions for standalone engine execution
72	standaloneJobTemplates: [CreateEngineJobTemplate!]
76
74	# CPU Resources required for engine to run, in milli-CPUs
75	cpuResourceMcpu: Int
79
77	# CPU Resources required for engine to run, in milli-CPUs
78	gpuSupported: GPUSupported
82
80	# Engine or Organization homepage
81	website: String
85
83	# In what way can this engine be distributed
84	distributionType: EngineDistributionType
88
86	# The tags associated with the engine
87	entityTags: [EntityTagInput]
91
89	# Indicates the metadata version number
90	metadataVersion: Int
92	}

CreateEngine

link GraphQL Schema definition

link Required by

GraphQL Schema definition

Required by