Package io.iworkflow.gen.api

Interface DefaultApi

  • All Superinterfaces:
    ApiClient.Api
    @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-11-01T13:04:07.524035-07:00[America/Los_Angeles]")
public interface DefaultApi
extends ApiClient.Api

    • Method Detail

      • apiV1WorkflowConfigUpdatePost

        void apiV1WorkflowConfigUpdatePost​(WorkflowConfigUpdateRequest workflowConfigUpdateRequest)
        update the config of a workflow
        Parameters:
        workflowConfigUpdateRequest - (optional)

      • apiV1WorkflowConfigUpdatePostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowConfigUpdatePostWithHttpInfo​(WorkflowConfigUpdateRequest workflowConfigUpdateRequest)
        update the config of a workflow Similar to apiV1WorkflowConfigUpdatePost but it also returns the http response headers .
        Parameters:
        workflowConfigUpdateRequest - (optional)

      • apiV1WorkflowDataobjectsGetPost

        WorkflowGetDataObjectsResponse apiV1WorkflowDataobjectsGetPost​(WorkflowGetDataObjectsRequest workflowGetDataObjectsRequest)
        get workflow data objects aka data attributes
        Parameters:
        workflowGetDataObjectsRequest - (optional)
        Returns:
        WorkflowGetDataObjectsResponse

      • apiV1WorkflowDataobjectsGetPostWithHttpInfo

        ApiResponse<WorkflowGetDataObjectsResponse> apiV1WorkflowDataobjectsGetPostWithHttpInfo​(WorkflowGetDataObjectsRequest workflowGetDataObjectsRequest)
        get workflow data objects aka data attributes Similar to apiV1WorkflowDataobjectsGetPost but it also returns the http response headers .
        Parameters:
        workflowGetDataObjectsRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowDataobjectsSetPost

        void apiV1WorkflowDataobjectsSetPost​(WorkflowSetDataObjectsRequest workflowSetDataObjectsRequest)
        set workflow data objects aka data attributes
        Parameters:
        workflowSetDataObjectsRequest - (optional)

      • apiV1WorkflowDataobjectsSetPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowDataobjectsSetPostWithHttpInfo​(WorkflowSetDataObjectsRequest workflowSetDataObjectsRequest)
        set workflow data objects aka data attributes Similar to apiV1WorkflowDataobjectsSetPost but it also returns the http response headers .
        Parameters:
        workflowSetDataObjectsRequest - (optional)

      • apiV1WorkflowGetPost

        WorkflowGetResponse apiV1WorkflowGetPost​(WorkflowGetRequest workflowGetRequest)
        get a workflow's status and results(if completed & requested)
        Parameters:
        workflowGetRequest - (optional)
        Returns:
        WorkflowGetResponse

      • apiV1WorkflowGetPostWithHttpInfo

        ApiResponse<WorkflowGetResponse> apiV1WorkflowGetPostWithHttpInfo​(WorkflowGetRequest workflowGetRequest)
        get a workflow's status and results(if completed & requested) Similar to apiV1WorkflowGetPost but it also returns the http response headers .
        Parameters:
        workflowGetRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowGetWithWaitPost

        WorkflowGetResponse apiV1WorkflowGetWithWaitPost​(WorkflowGetRequest workflowGetRequest)
        get a workflow's status and results(if completed & requested), wait if the workflow is still running
        Parameters:
        workflowGetRequest - (optional)
        Returns:
        WorkflowGetResponse

      • apiV1WorkflowGetWithWaitPostWithHttpInfo

        ApiResponse<WorkflowGetResponse> apiV1WorkflowGetWithWaitPostWithHttpInfo​(WorkflowGetRequest workflowGetRequest)
        get a workflow's status and results(if completed & requested), wait if the workflow is still running Similar to apiV1WorkflowGetWithWaitPost but it also returns the http response headers .
        Parameters:
        workflowGetRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowInternalDumpPost

        WorkflowDumpResponse apiV1WorkflowInternalDumpPost​(WorkflowDumpRequest workflowDumpRequest)
        dump internal info of a workflow
        Parameters:
        workflowDumpRequest - (optional)
        Returns:
        WorkflowDumpResponse

      • apiV1WorkflowInternalDumpPostWithHttpInfo

        ApiResponse<WorkflowDumpResponse> apiV1WorkflowInternalDumpPostWithHttpInfo​(WorkflowDumpRequest workflowDumpRequest)
        dump internal info of a workflow Similar to apiV1WorkflowInternalDumpPost but it also returns the http response headers .
        Parameters:
        workflowDumpRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowResetPost

        WorkflowResetResponse apiV1WorkflowResetPost​(WorkflowResetRequest workflowResetRequest)
        reset a workflow
        Parameters:
        workflowResetRequest - (optional)
        Returns:
        WorkflowResetResponse

      • apiV1WorkflowResetPostWithHttpInfo

        ApiResponse<WorkflowResetResponse> apiV1WorkflowResetPostWithHttpInfo​(WorkflowResetRequest workflowResetRequest)
        reset a workflow Similar to apiV1WorkflowResetPost but it also returns the http response headers .
        Parameters:
        workflowResetRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowRpcPost

        WorkflowRpcResponse apiV1WorkflowRpcPost​(WorkflowRpcRequest workflowRpcRequest)
        execute an RPC of a workflow
        Parameters:
        workflowRpcRequest - (optional)
        Returns:
        WorkflowRpcResponse

      • apiV1WorkflowRpcPostWithHttpInfo

        ApiResponse<WorkflowRpcResponse> apiV1WorkflowRpcPostWithHttpInfo​(WorkflowRpcRequest workflowRpcRequest)
        execute an RPC of a workflow Similar to apiV1WorkflowRpcPost but it also returns the http response headers .
        Parameters:
        workflowRpcRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowSearchPost

        WorkflowSearchResponse apiV1WorkflowSearchPost​(WorkflowSearchRequest workflowSearchRequest)
        search for workflows by a search attribute query
        Parameters:
        workflowSearchRequest - (optional)
        Returns:
        WorkflowSearchResponse

      • apiV1WorkflowSearchPostWithHttpInfo

        ApiResponse<WorkflowSearchResponse> apiV1WorkflowSearchPostWithHttpInfo​(WorkflowSearchRequest workflowSearchRequest)
        search for workflows by a search attribute query Similar to apiV1WorkflowSearchPost but it also returns the http response headers .
        Parameters:
        workflowSearchRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowSearchattributesGetPostWithHttpInfo

        ApiResponse<WorkflowGetSearchAttributesResponse> apiV1WorkflowSearchattributesGetPostWithHttpInfo​(WorkflowGetSearchAttributesRequest workflowGetSearchAttributesRequest)
        get workflow search attributes Similar to apiV1WorkflowSearchattributesGetPost but it also returns the http response headers .
        Parameters:
        workflowGetSearchAttributesRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowSearchattributesSetPost

        void apiV1WorkflowSearchattributesSetPost​(WorkflowSetSearchAttributesRequest workflowSetSearchAttributesRequest)
        set workflow search attributes
        Parameters:
        workflowSetSearchAttributesRequest - (optional)

      • apiV1WorkflowSearchattributesSetPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowSearchattributesSetPostWithHttpInfo​(WorkflowSetSearchAttributesRequest workflowSetSearchAttributesRequest)
        set workflow search attributes Similar to apiV1WorkflowSearchattributesSetPost but it also returns the http response headers .
        Parameters:
        workflowSetSearchAttributesRequest - (optional)

      • apiV1WorkflowSignalPost

        void apiV1WorkflowSignalPost​(WorkflowSignalRequest workflowSignalRequest)
        signal a workflow
        Parameters:
        workflowSignalRequest - (optional)

      • apiV1WorkflowSignalPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowSignalPostWithHttpInfo​(WorkflowSignalRequest workflowSignalRequest)
        signal a workflow Similar to apiV1WorkflowSignalPost but it also returns the http response headers .
        Parameters:
        workflowSignalRequest - (optional)

      • apiV1WorkflowStartPost

        WorkflowStartResponse apiV1WorkflowStartPost​(WorkflowStartRequest workflowStartRequest)
        start a workflow
        Parameters:
        workflowStartRequest - (optional)
        Returns:
        WorkflowStartResponse

      • apiV1WorkflowStartPostWithHttpInfo

        ApiResponse<WorkflowStartResponse> apiV1WorkflowStartPostWithHttpInfo​(WorkflowStartRequest workflowStartRequest)
        start a workflow Similar to apiV1WorkflowStartPost but it also returns the http response headers .
        Parameters:
        workflowStartRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowStateDecidePost

        WorkflowStateExecuteResponse apiV1WorkflowStateDecidePost​(WorkflowStateExecuteRequest workflowStateExecuteRequest)
        for invoking WorkflowState.execute API
        Parameters:
        workflowStateExecuteRequest - (optional)
        Returns:
        WorkflowStateExecuteResponse

      • apiV1WorkflowStateDecidePostWithHttpInfo

        ApiResponse<WorkflowStateExecuteResponse> apiV1WorkflowStateDecidePostWithHttpInfo​(WorkflowStateExecuteRequest workflowStateExecuteRequest)
        for invoking WorkflowState.execute API Similar to apiV1WorkflowStateDecidePost but it also returns the http response headers .
        Parameters:
        workflowStateExecuteRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowStateStartPostWithHttpInfo

        ApiResponse<WorkflowStateWaitUntilResponse> apiV1WorkflowStateStartPostWithHttpInfo​(WorkflowStateWaitUntilRequest workflowStateWaitUntilRequest)
        for invoking WorkflowState.waitUntil API Similar to apiV1WorkflowStateStartPost but it also returns the http response headers .
        Parameters:
        workflowStateWaitUntilRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowStopPost

        void apiV1WorkflowStopPost​(WorkflowStopRequest workflowStopRequest)
        stop a workflow
        Parameters:
        workflowStopRequest - (optional)

      • apiV1WorkflowStopPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowStopPostWithHttpInfo​(WorkflowStopRequest workflowStopRequest)
        stop a workflow Similar to apiV1WorkflowStopPost but it also returns the http response headers .
        Parameters:
        workflowStopRequest - (optional)

      • apiV1WorkflowTimerSkipPost

        void apiV1WorkflowTimerSkipPost​(WorkflowSkipTimerRequest workflowSkipTimerRequest)
        skip the timer of a workflow
        Parameters:
        workflowSkipTimerRequest - (optional)

      • apiV1WorkflowTimerSkipPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowTimerSkipPostWithHttpInfo​(WorkflowSkipTimerRequest workflowSkipTimerRequest)
        skip the timer of a workflow Similar to apiV1WorkflowTimerSkipPost but it also returns the http response headers .
        Parameters:
        workflowSkipTimerRequest - (optional)

      • apiV1WorkflowTriggerContinueAsNewPost

        void apiV1WorkflowTriggerContinueAsNewPost​(TriggerContinueAsNewRequest triggerContinueAsNewRequest)
        trigger ContinueAsNew for a workflow
        Parameters:
        triggerContinueAsNewRequest - (optional)

      • apiV1WorkflowTriggerContinueAsNewPostWithHttpInfo

        ApiResponse<java.lang.Void> apiV1WorkflowTriggerContinueAsNewPostWithHttpInfo​(TriggerContinueAsNewRequest triggerContinueAsNewRequest)
        trigger ContinueAsNew for a workflow Similar to apiV1WorkflowTriggerContinueAsNewPost but it also returns the http response headers .
        Parameters:
        triggerContinueAsNewRequest - (optional)

      • apiV1WorkflowWaitForStateCompletionPostWithHttpInfo

        ApiResponse<WorkflowWaitForStateCompletionResponse> apiV1WorkflowWaitForStateCompletionPostWithHttpInfo​(WorkflowWaitForStateCompletionRequest workflowWaitForStateCompletionRequest)
        Similar to apiV1WorkflowWaitForStateCompletionPost but it also returns the http response headers .
        Parameters:
        workflowWaitForStateCompletionRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • apiV1WorkflowWorkerRpcPost

        WorkflowWorkerRpcResponse apiV1WorkflowWorkerRpcPost​(WorkflowWorkerRpcRequest workflowWorkerRpcRequest)
        for invoking workflow RPC API in the worker
        Parameters:
        workflowWorkerRpcRequest - (optional)
        Returns:
        WorkflowWorkerRpcResponse

      • apiV1WorkflowWorkerRpcPostWithHttpInfo

        ApiResponse<WorkflowWorkerRpcResponse> apiV1WorkflowWorkerRpcPostWithHttpInfo​(WorkflowWorkerRpcRequest workflowWorkerRpcRequest)
        for invoking workflow RPC API in the worker Similar to apiV1WorkflowWorkerRpcPost but it also returns the http response headers .
        Parameters:
        workflowWorkerRpcRequest - (optional)
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.

      • infoHealthcheckGet

        HealthInfo infoHealthcheckGet()
        return health info of the server
        Returns:
        HealthInfo

      • infoHealthcheckGetWithHttpInfo

        ApiResponse<HealthInfo> infoHealthcheckGetWithHttpInfo()
        return health info of the server Similar to infoHealthcheckGet but it also returns the http response headers .
        Returns:
        A ApiResponse that wraps the response boyd and the http headers.