Mutations
Package Trax.Api.GraphQLSurface GraphQL schemaSource RootMutation.cs, OperationsMutations.cs
The root mutation type, RootMutation, has two namespaces:
type Mutation {
dispatch: DispatchMutations! # only when [TraxMutation] trains exist
operations: OperationsMutations! # only when ExposeOperationMutations() is set
}The root Mutation type is omitted when nothing contributes to it: no [TraxMutation] train and
no ExposeOperationMutations() call.
| Namespace | Resolved by | Holds | Page |
|---|---|---|---|
dispatch | DispatchMutations | One generated field per train marked [TraxMutation] | dispatch mutations |
operations | OperationsMutations | Manifest, group, execution, machine instance and effect operations, and the nested namespaces below. Off by default: the host opts in with ExposeOperationMutations() | this page, below |
operations.config | ConfigMutations | Scheduler settings and log levels | operations.config mutations |
operations.manifestGroups | ManifestGroupMutations | Group settings and enablement | operations.manifestGroups mutations |
operations.workQueue | WorkQueueMutations | Queue, run and cancel work queue entries | operations.workQueue mutations |
operations.deadLetters | DeadLetterMutations | Requeue and acknowledge dead letters | operations.deadLetters mutations |
Most operations fields return OperationResponse.
Operations mutations
The whole operations namespace sits behind the operations gate (GateOperations,
GateOperationsToAuthenticatedUsers or AllowAnonymousOperations; see
AddTraxGraphQL). The scheduler is reachable
through it, so an open namespace lets any caller change scheduled work. Mutations that enqueue a
train and input the caller chose (requeueExecution, resumeExecution, workQueue.queueTrain)
also apply that train's [TraxAuthorize] requirements. Mutations that enqueue what a manifest fixed
(triggerManifest, triggerManifestDelayed, triggerGroup, dead-letter requeues) answer to the
gate alone. See Authorization: The Operations Surface.
The fields directly under operations, each on the page that documents it:
triggerManifest
Queue an immediate run of a manifest. operations: manifest mutations
triggerManifestDelayed
Queue a run of a manifest after a delay. operations: manifest mutations
disableManifest
operations: manifest mutations
enableManifest
operations: manifest mutations
cancelManifest
Cancel every pending and running execution of a manifest. operations: manifest mutations
triggerGroup
Trigger every enabled manifest of a group. operations: manifest mutations
cancelGroup
Cancel every pending and running execution of a group. operations: manifest mutations
triggerManifests
Trigger many manifests by id. operations: manifest mutations
triggerGroups
Trigger many groups by id. operations: manifest mutations
cancelGroups
Cancel the executions of many groups. operations: manifest mutations
setManifestsEnabled
Enable or disable many manifests. operations: manifest mutations
setManifestsReplayDecisionsOnRetry
Set whether retries of many manifests replay decisions. operations: manifest mutations
updateManifest
Patch one manifest's schedule settings. operations: manifest mutations
cancelExecution
Cancel one execution. operations: execution mutations
cancelExecutions
Cancel many executions. operations: execution mutations
requeueExecution
Queue a new run of an execution's train with its recorded input. operations: execution mutations
resumeExecution
Queue a run that resumes a failed or cancelled execution from a checkpoint. operations: execution mutations
cancelMachineInstance
Cancel a system-owned state machine instance's live run. operations: machine instance mutations
startBulkOperation
Cancel, requeue, acknowledge, trigger, enable or disable every row a list filter matches, in the background, tracked. operations: bulk operations
setEffectEnabled
Turn an effect on or off in the API process. operations: effect mutations
configureEffect
Change an effect's runtime settings in the API process. operations: effect mutations
config (nested namespace)
updateScheduler and setLogLevels: operations.config mutations.
manifestGroups (nested namespace)
updateManifestGroup, setManifestGroupsEnabled and setAllManifestGroupsEnabled: operations.manifestGroups mutations.
workQueue (nested namespace)
queueTrain, runTrain, cancelWorkQueueEntry and cancelWorkQueueEntries: operations.workQueue mutations.
queueTrain
operations.workQueue mutations
runTrain
operations.workQueue mutations
deadLetters (nested namespace)
requeueDeadLetter, acknowledgeDeadLetter, requeueDeadLetters, acknowledgeDeadLetters,
requeueAllDeadLetters and acknowledgeAllDeadLetters: operations.deadLetters mutations.