QueueService gRPC API
QueueService provides async job queue operations for gRPC plugins
Proto file: plugin/grpc/protocol/queue.proto
Service Methods
| Method | Request | Response | Streaming |
|---|
| Enqueue | EnqueueRequest | EnqueueResponse | No |
| GetJob | GetJobRequest | GetJobResponse | No |
| UpdateJob | UpdateJobRequest | UpdateJobResponse | No |
| ListJobs | ListJobsRequest | ListJobsResponse | No |
Enqueue
Enqueue adds a new job to the queue
- Request:
EnqueueRequest
- Response:
EnqueueResponse
GetJob
GetJob retrieves a job by ID
- Request:
GetJobRequest
- Response:
GetJobResponse
UpdateJob
UpdateJob updates a job's status and progress
- Request:
UpdateJobRequest
- Response:
UpdateJobResponse
ListJobs
ListJobs lists jobs with optional status filter
- Request:
ListJobsRequest
- Response:
ListJobsResponse
Message Types
Job
Job represents an async operation
| Field | Type | Description |
|---|
| id | string | - |
| handler_name | string | - |
| payload | bytes | - |
| source | string | - |
| status | string | - |
| progress | Progress | - |
| cost_estimate | double | - |
| cost_actual | double | - |
| pulse_state | PulseState | - |
| error | string | - |
| parent_job_id | string | - |
| retry_count | int32 | - |
| created_at | int64 | - |
| started_at | int64 | - |
| completed_at | int64 | - |
Progress
| Field | Type | Description |
|---|
| current | int32 | - |
| total | int32 | - |
PulseState
| Field | Type | Description |
|---|
| calls_this_minute | int32 | - |
| calls_remaining | int32 | - |
| spend_today | double | - |
| spend_this_month | double | - |
| budget_remaining | double | - |
| is_paused | bool | - |
| pause_reason | string | - |
EnqueueRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| job | Job | - |
EnqueueResponse
| Field | Type | Description |
|---|
| success | bool | - |
| error | string | - |
| job_id | string | - |
GetJobRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| job_id | string | - |
GetJobResponse
| Field | Type | Description |
|---|
| success | bool | - |
| error | string | - |
| job | Job | - |
UpdateJobRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| job | Job | - |
UpdateJobResponse
| Field | Type | Description |
|---|
| success | bool | - |
| error | string | - |
ListJobsRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| status | string | - |
ListJobsResponse
| Field | Type | Description |
|---|
| success | bool | - |
| error | string | - |
| jobs | Job | - |
← Back to API Index