17.42. Jobs Start RPC¶
Request starting of a job created by the Create RPC.
rpc Start (JobsStartRequest) returns (JobsStartResponse)
17.42.1. Messages¶
- JobsStartRequest
- JobsStartResponse
- NamedValue
17.43. JobsStartRequest¶
message JobsStartRequest { message NamedValue { string name = 1; string value = 2; } RequestHeader header = 1; Identifier job_id = 2; repeated NamedValue Variables = 3; }
17.43.1. Properties¶
17.43.1.2. job_id¶
type: message
The Job id for the job that should be started.
Required. If the identifier value is omitted from the request or does not match any known job identifier, Clara Deploy SDK will be unable to fulfill the request.
See Identifier for details.
17.43.1.2.1. Variables¶
type: message
Set of key/value pairs to be passed into the job as it starts. Variables passed to a job upon start are used to populate any pipeline parameter values defined by the pipeline the job is executing. Pipeline parameters are, in turn, used to complete any template placeholders present in the definition.
See NamedValue for details.
17.44. JobsStartResponse¶
message JobsStartResponse{ RequestHeader header = 1; JobState state = 2; JobStatus status = 3; }
Clara Deploy SDK Jobs service will respond to any start request with a JobsStartResponse message. Requestors can use the response message to determine the result of their request.