IRPCApplicationTaskQueue.OpenTaskQueue
Server integration API / specialized write session
Creates a task queue if it does not exist, or confirms an existing one.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/OpenTaskQueue |
| HTTP (mf-http-grpc) | POST /grpc/v1/open-task-queue |
| Request | OpenTaskQueueRequest |
| Response | OpenTaskQueueResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Safe to call repeatedly; there is no close call. Opening a queue that exists with a
different
queue_behaviorfails with "The parameter is incorrect.". - Requires a vault session and the vault right
change_full_control_role. Internal queue IDs are refused with "Access denied.".
Request: OpenTaskQueueRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
queue_id | string | The ID of the queue, chosen by the application; make it unique, for example prefixed with the application's name. Leading and trailing spaces are removed. |
queue_behavior | ApplicationTaskQueueProcessingBehavior | APPLICATION_TASK_QUEUE_PROCESSING_BEHAVIOR_SEQUENTIAL to process the tasks one at a time in the order they were added, or ..._CONCURRENT to process them in parallel.Values: APPLICATION_TASK_QUEUE_PROCESSING_BEHAVIOR_SEQUENTIAL (0), APPLICATION_TASK_QUEUE_PROCESSING_BEHAVIOR_CONCURRENT (1). |
Response: OpenTaskQueueResponse
No fields.