@@ -15,25 +15,28 @@ class LaunchParameters:
15
15
The launching user API token is the second element when the request header's
16
16
'Authorization' value is split on white-space."""
17
17
18
- # The Project UUID to launch the instance in
18
+ # The Project UUID of the project to launch the instance in
19
19
project_id : str
20
20
# A symbolic name of the Instance
21
21
name : str
22
- # The user name of the person launching the Instance/ Workflow
22
+ # The user name of the person launching the Instance ( Workflow step)
23
23
launching_user_name : str
24
24
# The API Access token provided by the User
25
25
launching_user_api_token : str
26
26
# The specification, which can contain 'variables'
27
27
specification : dict [str , Any ]
28
- # An alternative way to passing variables to the specification.
29
- # If used it will replace any 'variables' key in the specification.
28
+ # An alternative way to pass variables to the specification.
29
+ # If used it will replace any 'variables' already present in the specification.
30
30
specification_variables : dict [str , Any ] | None = None
31
31
# A string. In DM v4 converted to a boolean and set in the
32
- # instance Pod as a label.
32
+ # instance Pod as a label. Setting this means the Instances
33
+ # that are created will not be automatically removed by the Job operator.
33
34
debug : str | None = None
34
- # The RunningWorkflow UUID
35
+ # The RunningWorkflow UUID.
36
+ # Required if the Instance is part of a Workflow step.
35
37
running_workflow_id : str | None = None
36
- # The RunningWorkflowStep UUID
38
+ # The RunningWorkflowStep UUID.
39
+ # Required if the Instance is part of a Workflow step.
37
40
running_workflow_step_id : str | None = None
38
41
# The application ID (a custom resource name)
39
42
# used to identify the 'type' of Instance to create.
@@ -47,10 +50,13 @@ class LaunchResult:
47
50
Any error returned in this object is a launch error, not a Job error."""
48
51
49
52
# A numeric non-zero error code if an error occurred
50
- # and an optional message
53
+ # and an error message if the error number is not zero.
51
54
error_num : int = 0
52
55
error_msg : str | None = None
53
- # The Instance UUID that was created for you
56
+ # The following optional properties
57
+ # may not be present if there's a launch error.
58
+ #
59
+ # The Instance UUID that was created for you.
54
60
instance_id : str | None = None
55
61
# The Task UUID that is handling the Instance launch
56
62
task_id : str | None = None
0 commit comments