package peloton.api.v0.job.svc
Get desktop application:
View/edit binary Protocol Buffers messages
service JobService
job_svc.proto:23* Job service defines the job related methods such as create, get, query and kill jobs.
rpc CreateJob (, )
job_svc.proto:26Create a job entity for a given config.
message
job_svc.proto:67* Request message for JobService.CreateJob method.
optional id = 1
The unique job UUID specified by the client. This can be used by the client to re-create a failed job without the side-effect of creating duplicated jobs. If unset, the server will create a new UUID for the job for each invocation.
optional pool = 2
The resource pool under which the job should be created. The scheduling of all tasks in the job will be subject to the resource availablity of the resource pool.
optional config = 3
The detailed configuration of the job to be created.
repeated secrets = 4
The list of secrets for this job
message
job_svc.proto:95* Response message for JobService.CreateJob method. Return errors: ALREADY_EXISTS: if the job ID already exists.o INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the resource pool is not found.
optional jobId = 1
The job ID of the newly created job. Will be the same as the one in CreateJobRequest if provided. Otherwise, a new job ID will be generated by the server.
rpc GetJob (, )
job_svc.proto:29Get the config of a job entity.
message
job_svc.proto:106* Request message for JobService.GetJob method.
optional id = 1
The job ID to look up the job.
message
job_svc.proto:118* Response message for JobService.GetJob method. Return errors: NOT_FOUND: if the job is not found in Peloton.
optional result = 1
The job configuration of the matching job.
repeated secrets = 3
The list of secrets for this job, secret.Value will be empty. SecretID and path will be populated, so that caller can identify which secret is associated with this job.
rpc QueryJobs (, )
job_svc.proto:32Query the jobs that match a list of labels.
message
job_svc.proto:133* Request message for JobService.QueryJobs method.
optional spec = 1
The spec of query criteria for the jobs.
optional pagination = 2
The spec of how to do pagination for the query results.
message
job_svc.proto:148* Response message for JobService.QueryJobs method. Return errors: INVALID_ARGUMENT: if the resource pool path or job states are invalid.
repeated records = 1
List of jobs that match the job query criteria.
optional pagination = 2
Pagination result of the job query.
optional spec = 3
Return the spec of query criteria from the request.
rpc DeleteJob (, )
job_svc.proto:35Delete a job and stop all related tasks.
message
job_svc.proto:163* Request message for JobService.DeleteJob method.
optional id = 1
The job ID to be deleted.
message
job_svc.proto:175* Response message for JobService.DeleteJob method. Return errors: NOT_FOUND: if the job is not found in Peloton.
(message has no fields)
rpc UpdateJob (, )
job_svc.proto:41Update a job entity with a new config. This is a temporary API for updating batch jobs. It only supports adding new instances to an existing job. It will be deprecated when the UpgradeService API is implemented.
message
job_svc.proto:182* Request message for JobService.UpdateJob method.
optional id = 1
The job ID to be updated.
optional config = 2
The new job config to be applied to the job.
repeated secrets = 3
The list of secrets for this job
message
job_svc.proto:199* Response message for JobService.UpdateJob method. Return errors: INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the job ID is not found.
(message has no fields)
rpc RestartJob (, )
job_svc.proto:45Restart the tasks specified in restart request Experimental only
message
job_svc.proto:216* Request message for JobService.RestartJob method. Experimental only
optional id = 1
The job to restart
repeated ranges = 2
The instances to restart, default to all
uint64 resourceVersion = 3
The resourceVersion received from last job operation call for concurrency control
optional restartConfig = 4
The config for restart a job
message
job_svc.proto:237* Response message for JobService.RestartJob method. Return errors: INVALID_ARGUMENT: if the job ID or job resourceVersion is invalid. NOT_FOUND: if the job ID is not found. Experimental only
uint64 resourceVersion = 1
The new resourceVersion after the operation
optional updateID = 2
updateID associated with the restart
rpc StartJob (, )
job_svc.proto:49StartJob the tasks specified in start request Experimental only
message
job_svc.proto:298* Request message for JobService.StartJob method. Experimental only
optional id = 1
The job to start
repeated ranges = 2
The instances to start, default to all
uint64 resourceVersion = 3
The resourceVersion received from last job operation call for concurrency control
optional startConfig = 4
The config for starting a job
message
job_svc.proto:319* Response message for JobService.StartJob method. Return errors: INVALID_ARGUMENT: if the job ID or job resourceVersion is invalid. NOT_FOUND: if the job ID is not found. Experimental only
uint64 resourceVersion = 1
The new resourceVersion after the operation
optional updateID = 2
updateID associated with the start
rpc StopJob (, )
job_svc.proto:53Stop the tasks specified in stop request Experimental only
message
job_svc.proto:339* Request message for JobService.StopJobRequest method. Experimental only
optional id = 1
The job to stop
repeated ranges = 2
The instances to stop, default to all
uint64 resourceVersion = 3
The resourceVersion received from last job operation call for concurrency control
optional stopConfig = 4
The config for stopping a job
message
job_svc.proto:360* Response message for JobService.StopJob method. Return errors: INVALID_ARGUMENT: if the job ID or job resourceVersion is invalid. NOT_FOUND: if the job ID is not found. Experimental only
uint64 resourceVersion = 1
The new resourceVersion after the operation
optional updateID = 2
updateID associated with the stop
rpc RefreshJob (, )
job_svc.proto:57Debug only method. Allows user to load job runtime state from DB and re-execute the action associated with current state.
message
job_svc.proto:248* Request message for JobService.RefreshJob method. Experimental only
optional id = 1
The job ID to look up the job.
message
job_svc.proto:260* Response message for JobService.RefreshJob method. Return errors: NOT_FOUND: if the job is not found in Peloton.
(message has no fields)
rpc GetJobCache (, )
job_svc.proto:60Debug only method. Get the cache of a job stored in Peloton.
message
job_svc.proto:265* Request message for JobService.GetJobCache method.
optional id = 1
The job ID to look up the job.
message
job_svc.proto:277* Response message for JobService.GetJobCache method. Return errors: NOT_FOUND: if the job is not found in Peloton cache. INTERNAL_ERROR: if fail to read cache due to internal error.
optional config = 1
The job configuration in cache of the matching job.
optional runtime = 2
The job runtime in cache of the matching job.
message
job_svc.proto:206* RestartConfig is the optional config for RestartJobRequest Experimental only
Used in:
uint32 batchSize = 1
batch size of rolling restart, if unset or 0 all tasks specified will be restarted at the same time.
message
job_svc.proto:288* StartConfig is the optional config for StartJobRequest
Used in:
uint32 batchSize = 1
batch size of rolling start, if unset or 0 all tasks specified will be started at the same time.
message
job_svc.proto:329* StopConfig is the optional config for StopJobRequest
Used in:
uint32 batchSize = 1
batch size of rolling stop, if unset or 0 all tasks specified will be stop at the same time.