Function LambdaApiAxiosParamCreator

  • LambdaApi - axios parameter creator

    Parameters

    Returns {
        lambdaCreateFunctions: ((funcId, onlineFunctionCallRequest?, options?) => Promise<RequestArgs>);
        lambdaCreateRequests: ((functionCallRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>);
        lambdaDeleteRequests: ((id, options?) => Promise<RequestArgs>);
        lambdaListFunctions: ((options?) => Promise<RequestArgs>);
        lambdaListRequests: ((options?) => Promise<RequestArgs>);
        lambdaRetrieveFunctions: ((funcId, options?) => Promise<RequestArgs>);
        lambdaRetrieveRequests: ((id, options?) => Promise<RequestArgs>);
    }

    • lambdaCreateFunctions: ((funcId, onlineFunctionCallRequest?, options?) => Promise<RequestArgs>)
        • (funcId, onlineFunctionCallRequest?, options?): Promise<RequestArgs>
        • Allows to execute a function for immediate computation. Intended for short-lived executions, useful for interactive calls. When executed for interactive annotation, the job id must be specified in the 'job' input field. The task id is not required in this case, but if it is specified, it must match the job task id.

          Parameters

          • funcId: string
          • Optional onlineFunctionCallRequest: OnlineFunctionCallRequest
          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Throws

    • lambdaCreateRequests: ((functionCallRequest, xOrganization?, org?, orgId?, options?) => Promise<RequestArgs>)
        • (functionCallRequest, xOrganization?, org?, orgId?, options?): Promise<RequestArgs>
        • Parameters

          • functionCallRequest: FunctionCallRequest
          • Optional xOrganization: string

            Organization unique slug

          • Optional org: string

            Organization unique slug

          • Optional orgId: number

            Organization identifier

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method calls the function

          Throws

    • lambdaDeleteRequests: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: string

            Request id

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method cancels the request

          Throws

    • lambdaListFunctions: ((options?) => Promise<RequestArgs>)
        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns a list of functions

          Throws

    • lambdaListRequests: ((options?) => Promise<RequestArgs>)
        • (options?): Promise<RequestArgs>
        • Parameters

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns a list of requests

          Throws

    • lambdaRetrieveFunctions: ((funcId, options?) => Promise<RequestArgs>)
        • (funcId, options?): Promise<RequestArgs>
        • Parameters

          • funcId: string
          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns the information about the function

          Throws

    • lambdaRetrieveRequests: ((id, options?) => Promise<RequestArgs>)
        • (id, options?): Promise<RequestArgs>
        • Parameters

          • id: string

            Request id

          • Optional options: AxiosRequestConfig<any> = {}

            Override http request option.

          Returns Promise<RequestArgs>

          Summary

          Method returns the status of the request

          Throws

    Export

Generated using TypeDoc