Class BulkLoadUploadProfileSpecV1

java.lang.Object

com.kingsrook.qqq.middleware.javalin.specs.AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

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

public class BulkLoadUploadProfileSpecV1
extends AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

GET /bulkLoad/uploads/{uploadRef}/profile: the header guess and column profiles of an uploaded file, for a target table (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
BulkLoadUploadProfileSpecV1()

Method Summary

Modifier and Type	Method	Description
BulkLoadUploadProfileInput	buildInput(io.javalin.http.Context context)	build the endpoint's input object from a javalin context
BasicOperation	defineBasicOperation()
BasicResponse	defineBasicSuccessResponse()
Map<String,Schema>	defineComponentSchemas()
List<Parameter>	defineRequestParameters()

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

checkCredentialScopeOperation, customizeMethod, defineAdditionalBasicResponses, defineCompleteOperation, defineMethod, defineRequestBody, 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

BulkLoadUploadProfileSpecV1

public BulkLoadUploadProfileSpecV1()

Method Details

defineBasicOperation

public BasicOperation defineBasicOperation()

Overrides:

defineBasicOperation in class AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

defineRequestParameters

public List<Parameter> defineRequestParameters()

Overrides:

defineRequestParameters in class AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

buildInput

public BulkLoadUploadProfileInput 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<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

Throws:

Exception

defineComponentSchemas

public Map<String,Schema> defineComponentSchemas()

Overrides:

defineComponentSchemas in class AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>

defineBasicSuccessResponse

public BasicResponse defineBasicSuccessResponse()

Overrides:

defineBasicSuccessResponse in class AbstractEndpointSpec<BulkLoadUploadProfileInput,BulkLoadUploadProfileResponseV1,BulkLoadUploadProfileExecutor>