Class ProcessJobLaunchSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

com.kingsrook.qqq.middleware.javalin.specs.v1.ProcessJobLaunchSpecV1

public class ProcessJobLaunchSpecV1
extends AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

POST /processes/{processName}/jobs: run any eligible process as a durable job ("Run in background"). Docs: docs/specs/DURABLE-JOBS-AND-ASSISTED-BULK-LOAD.md.

Field Summary

Fields inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

qInstance

Constructor Summary

Constructors

Constructor	Description
ProcessJobLaunchSpecV1()

Method Summary

Modifier and Type	Method	Description
ProcessJobLaunchInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
List<BasicResponse>	defineAdditionalBasicResponses()	Too many queued jobs for the user is a documented 429.
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
RequestBody	defineRequestBody()
List<Parameter>	defineRequestParameters()

Methods inherited from class com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec

checkCredentialScopeOperation, customizeMethod, defineCompleteOperation, defineMethod, defineResponses, defineRoute, getOperationId, getRequestBodyAsJsonObject, getRequestParam, getRequestParamInteger, getRequestParamMap, handleException, handleOutput, isSecured, newExecutor, newOutput, serveRequest, setQInstance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ProcessJobLaunchSpecV1

public ProcessJobLaunchSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

buildInput

public ProcessJobLaunchInput buildInput(io.javalin.http.Context context)
                                 throws Exception

Description copied from class: AbstractEndpointSpec

build the endpoint's input object from a javalin context

Specified by:

buildInput in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>

defineAdditionalBasicResponses

public List<BasicResponse> defineAdditionalBasicResponses()

Too many queued jobs for the user is a documented 429.

Overrides:

defineAdditionalBasicResponses in class AbstractEndpointSpec<ProcessJobLaunchInput,ProcessJobLaunchResponseV1,ProcessJobLaunchExecutor>