Kafka Connector 25.3
Kafka Connector Help

# Synchronous and Asynchronous Actions

Some actions are synchronous and others are asynchronous.

Kafka Connector does not respond to a synchronous action until it has completed the task. The results of the task are included in the response.

Kafka Connector responds to an asynchronous action immediately. The request is added to a queue. Each asynchronous action described in the documentation has its own queue. The response to the request contains a token. You can use this token to determine whether the task has finished, and obtain the results. To do this, use the QueueInfo action.

## Check the Status of an Asynchronous Action

To check the status of an asynchronous action, use the QueueInfo action and specify the name of the action and the token that was returned.

To check the status of an asynchronous action

- Send the `QueueInfo` action with the following parameters.

  `QueueAction` | Set this parameter to `GetStatus`.
  `QueueName` | The name of the action that you requested.
  `Token` | (Optional) The token that the asynchronous action returned. If you do not specify a token, Kafka Connector returns the status of every action in the queue.

For example:

    /action=QueueInfo&QueueAction=getstatus&QueueName=...&Token=...

## Cancel an Asynchronous Action that is Queued

To cancel an asynchronous action that is waiting in a queue, use the following procedure.

To cancel an asynchronous action that is queued

- Send the `QueueInfo` action with the following parameters.

  `QueueAction` | Set this parameter to `Cancel`.
  `QueueName` | The name of the action queue that contains the action to cancel.
  `Token` | The token that the asynchronous action returned.

## Stop an Asynchronous Action that is Running

You can request that an asynchronous action stops. Actions that run for a long time might periodically check to see if there has been a request to stop (but this is not supported by every action).

To stop an asynchronous action that is running

- Send the `QueueInfo` action with the following parameters.

  `QueueAction` | Set this parameter to `Stop`.
  `QueueName` | The name of the action queue that contains the action to stop.
  `Token` | The token that the asynchronous action returned.

Copyright 2025 Open Text
Version 25.3 | Last updated July 2025

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: Knowledge Discovery Kafka Connector 25.3

Topic Title: Synchronous and Asynchronous Actions