14.22. Jobs Create RPC

Requests creation of a new job based on a known pipeline.

rpc Cancel (JobsCreateRequest) returns (JobsCreateResponse)

14.22.1. Messages

  • JobsCreateRequest

  • JobsCreateResponse


14.23. JobsCreateRequest

message JobsCreateRequest {
  RequestHeader header = 1;
  Identifier pipeline_id = 2;
  string name = 3;
}

14.23.1. Properties

14.23.1.2. 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.

14.23.1.3. name

type: string

Human readable name to be assigned to the job.


14.24. JobsCreateResponse

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.

14.24.1. Properties

14.24.1.1. header

type: message

Standard RPC response header.

See ResponseHeader for details.

14.24.1.2. job_id

type: message

Unique identifier of the newly created job.

See Identifier for details.

14.24.1.3. payload_id

type: message

Unique payload identifier of the newly created job.

See Identifier for details.