package peloton.api.v1alpha.job.stateless.svc
Get desktop application:
View/edit binary Protocol Buffers messages
Job service defines the job related methods such as create, get, query and kill jobs.
Methods which mutate the state of the job.
rpc CreateJob (, )
stateless_svc.proto:504Create a new job with the given configuration.
message
stateless_svc.proto:16Request message for JobService.CreateJob method.
optional job_id = 1
The unique job UUID specified by the client. This can be used by the client to re-create a deleted job. If unset, the server will create a new UUID for the job for each invocation.
optional spec = 2
The configuration of the job to be created.
repeated secrets = 3
Experimental: This is a batch feature. The implementation is subject to change (or removal) from stateless. The list of secrets for this job
optional create_spec = 4
The creation SLA specification.
optional opaque_data = 5
Opaque data supplied by the client
message
stateless_svc.proto:42Response message for JobService.CreateJob method. Return errors: ALREADY_EXISTS: if the job ID already exists INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the resource pool is not found.
optional job_id = 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.
optional version = 2
The current version of the job.
rpc ReplaceJob (, )
stateless_svc.proto:509Replace the configuration of an existing job with the new configuration. The caller is expected to provide the entire job configuration including the fields which are unchanged.
message
stateless_svc.proto:53Request message for JobService.ReplaceJob method.
optional job_id = 1
The job ID to be updated.
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
optional spec = 3
The new job configuration to be applied.
repeated secrets = 4
The list of secrets for this job
optional update_spec = 5
The update SLA specification.
optional opaque_data = 6
Opaque data supplied by the client
message
stateless_svc.proto:79Response message for JobService.ReplaceJob method. Return errors: INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
rpc PatchJob (, )
stateless_svc.proto:515Patch the configuration of an existing job. The caller is not expected to provide all the configuration fields and can provide only subset (e.g. provide only the fields which have changed). This is not supported yet.
message
stateless_svc.proto:85Request message for JobService.PatchJob method.
optional job_id = 1
The job ID to be updated.
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
optional spec = 3
The new job configuration to be patched.
repeated secrets = 4
The list of secrets for this job
optional update_spec = 5
The update SLA specification.
optional opaque_data = 6
Opaque data supplied by the client
message
stateless_svc.proto:111Response message for JobService.PatchJob method. Return errors: INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
rpc RestartJob (, )
stateless_svc.proto:518Restart the pods specified in the request.
message
stateless_svc.proto:117Request message for JobService.RestartJob method.
optional job_id = 1
The job to restart.
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
optional restart_spec = 3
The restart specification.
optional opaque_data = 5
Opaque data supplied by the client
message
stateless_svc.proto:136Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
Pause the current running workflow. If there is no current running workflow, or the current workflow is already paused, then the method is a no-op.
message
stateless_svc.proto:142Request message for JobService.PauseJobWorkflow method.
optional job_id = 1
The job identifier.
optional version = 2
The current version of the job.
optional opaque_data = 3
Opaque data supplied by the client
message
stateless_svc.proto:158Response message for JobService.PauseJobWorkflow method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
Resume the current running workflow. If there is no current running workflow, or the current workflow is not paused, then the method is a no-op.
message
stateless_svc.proto:164Request message for JobService.ResumeJobWorkflow method.
optional job_id = 1
The job identifier.
optional version = 2
The current version of the job.
optional opaque_data = 3
Opaque data supplied by the client
message
stateless_svc.proto:180Response message for JobService.ResumeJobWorkflow method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
Abort the current running workflow. If there is no current running workflow, then the method is a no-op.
message
stateless_svc.proto:186Request message for JobService.AbortJobWorkflow method.
optional job_id = 1
The job identifier.
optional version = 2
The current version of the job.
optional opaque_data = 3
Opaque data supplied by the client
message
stateless_svc.proto:202Response message for JobService.AbortJobWorkflow method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
rpc StartJob (, )
stateless_svc.proto:535Start the pods specified in the request.
message
stateless_svc.proto:208Request message for JobService.StartJob method.
optional job_id = 1
The job to start
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
message
stateless_svc.proto:222Response message for JobService.StartJob method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
rpc StopJob (, )
stateless_svc.proto:538Stop the pods specified in the request.
message
stateless_svc.proto:228Request message for JobService.StopJob method.
optional job_id = 1
The job to stop
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
message
stateless_svc.proto:242Response message for JobService.StopJob method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
optional version = 1
The new version of the job.
rpc DeleteJob (, )
stateless_svc.proto:541Delete a job and all related state.
message
stateless_svc.proto:248Request message for JobService.DeleteJob method.
optional job_id = 1
The job to be deleted.
optional version = 2
The current version of the job. It is used to implement optimistic concurrency control.
bool force = 3
If set to true, it will force a delete of the job even if it is running. The job will be first stopped and deleted. This step cannot be undone, and the job cannot be re-created (with same uuid) till the delete is complete. So, it is recommended to not set force to true.
message
stateless_svc.proto:269Response message for JobService.DeleteJob method. Response message for JobService.RestartJob method. Return errors: NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid or job is still running. FailedPrecondition: if the job has not been stopped before delete.
(message has no fields)
rpc GetJob (, )
stateless_svc.proto:546Get the configuration and runtime status of a job.
message
stateless_svc.proto:272Request message for JobService.GetJob method.
optional job_id = 1
The job ID to look up the job.
optional version = 2
The version of the job object to fetch. If not provided, then the latest job configuration specification and runtime status are returned. If provided, only the job configuration specification (and no runtime) at a given version is returned.
bool summary_only = 3
If set to true, only return the job summary.
message
stateless_svc.proto:290Response message for JobService.GetJob method. Return errors: NOT_FOUND: if the job ID is not found.
optional job_info = 1
The configuration specification and runtime status of the job.
optional summary = 2
The job summary.
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.
optional workflow_info = 4
Information about the current/last completed workflow including its state and specification.
Get the job UUID from job name.
message
stateless_svc.proto:308Request message for JobService.GetJobIDFromJobName method.
string job_name = 1
Job name to lookup for job UUID.
message
stateless_svc.proto:316Response message for JobService.GetJobIDFromJobName method. Return errors: NOT_FOUND: if the job name is not found.
repeated job_id = 1
The job UUIDs for the job name. Job UUIDs are sorted by descending create timestamp.
Get the events of the current / last completed workflow of a job
message
stateless_svc.proto:323Request message for JobService.GetWorkflowEvents
optional job_id = 1
The job ID to look up the job.
uint32 instance_id = 2
The instance to get workflow events.
uint32 limit = 3
Limits the number of workflow events. If limit is 0, then all events are fetched.
message
stateless_svc.proto:338Response message for JobService.GetWorkflowEvents Return errors: NOT_FOUND: if the job ID is not found.
repeated events = 1
Workflow events for the given workflow
rpc ListPods (, stream )
stateless_svc.proto:555List all pods in a job for a given range of pod IDs.
message
stateless_svc.proto:344Request message for JobService.ListPods method.
optional job_id = 1
The job identifier of the pods to list.
optional range = 2
The instance ID range of the pods to list. If unset, all pods in the job will be returned.
message
stateless_svc.proto:356Response message for JobService.ListPods method. Return errors: NOT_FOUND: if the job ID is not found.
repeated pods = 1
Pod summary for all matching pods.
rpc QueryPods (, )
stateless_svc.proto:558Query pod info in a job using a set of filters.
message
stateless_svc.proto:362Request message for JobService.QueryPods method.
optional job_id = 1
The job identifier of the pods to query.
optional spec = 2
The spec of query criteria for the pods.
optional pagination = 3
The spec of how to do pagination for the query results.
bool summary_only = 4
If set to true, only return the pod status and not the configuration.
message
stateless_svc.proto:379Response message for JobService.QueryPods method. Return errors: NOT_FOUND: if the job ID is not found.
repeated pods = 1
List of pods that match the pod query criteria.
optional pagination = 2
Pagination result of the pod query.
rpc QueryJobs (, )
stateless_svc.proto:562Query the jobs using a set of filters. TODO find the appropriate service to put this method in.
message
stateless_svc.proto:388Request message for JobService.QueryJobs method.
optional spec = 1
The spec of query criteria for the jobs.
message
stateless_svc.proto:396Response 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 ListJobs (, stream )
stateless_svc.proto:566Get summary for all jobs. Results are streamed back to the caller in batches and the stream is closed once all results have been sent.
message
stateless_svc.proto:491Request message for JobService.ListJobs method.
(message has no fields)
message
stateless_svc.proto:494Response message for JobService.ListJobs method.
repeated jobs = 1
List of all jobs.
List all workflows (including current and previously completed) for a given job. Optional parameters to limit the number of updates to list and whether to include instance workflow events can be set. Default is to list of all the updates and do not to fetch instance workflow events.
message
stateless_svc.proto:408Request message for JobService.ListJobWorkflows method.
optional job_id = 1
The job identifier.
uint32 updates_limit = 2
Limits the number of updates to list for a job.
bool instance_events = 3
Flag to indicate whether to fetch instance workflow events for that job update.
uint32 instance_events_limit = 4
Limits the number of events per instance. If limit is 0, then all events are fetched.
message
stateless_svc.proto:427Response message for JobService.ListJobWorkflows method. Return errors: NOT_FOUND: if the job ID is not found.
repeated workflow_infos = 1
Get the list of instances which will be added/removed/updated if the given job specification is applied via the ReplaceJob API.
message
stateless_svc.proto:432Request message for JobService.GetReplaceJobDiffRequest method.
optional job_id = 1
The job ID to be updated.
optional version = 2
The current version of the job.
optional spec = 3
The new job configuration to be applied.
message
stateless_svc.proto:448Response message for JobService.GetReplaceJobDiff method. Return errors: INVALID_ARGUMENT: if the job ID or job config is invalid. NOT_FOUND: if the job ID is not found. ABORTED: if the job version is invalid.
repeated instances_added = 1
Instances which are being added
repeated instances_removed = 2
Instances which are being removed
repeated instances_updated = 3
Instances which are being updated
repeated instances_unchanged = 4
Instances which are unchanged
rpc RefreshJob (, )
stateless_svc.proto:583Allows user to load job runtime status from the database and re-execute the action associated with current state.
message
stateless_svc.proto:463Request message for JobService.RefreshJob method.
optional job_id = 1
The job ID to look up the job.
message
stateless_svc.proto:471Response message for JobService.RefreshJob method. Return errors: NOT_FOUND: if the job ID is not found.
(message has no fields)
rpc GetJobCache (, )
stateless_svc.proto:586Get the job state in the cache.
message
stateless_svc.proto:474Request message for JobService.GetJobCache method.
optional job_id = 1
The job ID to look up the job.
message
stateless_svc.proto:482Response message for JobService.GetJobCache method. Return errors: NOT_FOUND: if the job ID is not found.
optional spec = 1
The job configuration in cache of the matching job.
optional status = 2
The job runtime in cache of the matching job.