Class BulkLoadSuggestMappingSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

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

public class BulkLoadSuggestMappingSpecV1
extends AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

POST /bulkLoad/{tableName}/suggestMapping: core's suggested bulk load profile for an uploaded file's header row (assisted bulk load, design spec #1171 section 3.2).

Field Summary

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

qInstance

Constructor Summary

Constructors

Constructor	Description
BulkLoadSuggestMappingSpecV1()

Method Summary

Modifier and Type	Method	Description
BulkLoadSuggestMappingInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
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, defineAdditionalBasicResponses, 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

BulkLoadSuggestMappingSpecV1

public BulkLoadSuggestMappingSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

defineRequestBody

public RequestBody defineRequestBody()

Overrides:

defineRequestBody in class AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

buildInput

public BulkLoadSuggestMappingInput 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<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<BulkLoadSuggestMappingInput,BulkLoadSuggestMappingResponseV1,BulkLoadSuggestMappingExecutor>