Import Close
- Nina Cardillo
Close ends an open import session. This has no effect on databases because all actual import action is in a transaction within begin and end (or cancel), but it can change the state of the targeted engines.
Closing an import when no import is active has no effect, and it is not an error.
Close Request Arguments
A close request can include the following arguments.
Argument | Type | Description |
|---|---|---|
step | string | (Required) The Close argument. |
respond | string | (Optional) A topic where the response object is expected. The response topic is allocated by the initiator. The topic must be within the feedback channel for this segment to allow communication across bridged message brokers. Example: |
meta | any | (Optional) If provided, the meta data is returned with the response. |
protocols | list of strings | (Required) A list of affected edge protocols using standard IAP/MP protocol identifiers. Example: |
reason | string | (Optional) If provided, this gives a reason for closing and is used in log files or for similar diagnostics. Example: |
option | object | (Optional) The option argument is either undefined, or an object whose keys equal an IAP/MQ protocol identifier. See option argument under Import Open for more details and an example. |
Close Response
When the open request includes a response topic, the edge server publishes the response object at the requested respond topic when ready:
Parameters | Type | Description |
|---|---|---|
step | string | (Required) The step from the corresponding request. In this case it’s the Close argument. |
meta | any | (Optional) Meta data from the corresponding request, if any. |
error | string | An error description, undefined if no error occurred. Errors not in direct relation to this request are reported through the IAP/MQ event channel, captured by the IAP/REST engine and reported with the IAP/REST import responses. Example: |