Requests creation of a new job based on a known pipeline.
rpc Create (JobsCreateRequest) returns (JobsCreateResponse)
Messages
- JobsCreateRequest
- JobsCreateResponse
message JobsCreateRequest {
RequestHeader header = 1;
Identifier pipeline_id = 2;
string name = 3;
}
Properties
header
type: message
Standard RPC request header.
See RequestHeader for details.
pipeline_id
type: message
Unique identifier of the pipeline the job will instance.
Required. If the identifier value is omitted from the request or does not match any known pipeline identifier, Clara Deploy SDK will be unable to fulfill the request.
See Identifier for details.
name
type: string
Human readable name to be assigned to the job.
message JobCreateResponse {
ResponseHeader header = 1;
Identifier job_id = 2;
Identifier payload_id = 3;
}
Clara Deploy SDK Jobs service will respond to any create request with a JobsCreateResponse message. Requestors can use the response message to determine the result of their request.
Properties
header
type: message
Standard RPC response header.
See ResponseHeader for details.
job_id
type: message
Unique identifier of the newly created job.
See Identifier for details.
payload_id
type: message
Unique payload identifier of the newly created job.
See Identifier for details.