journal_advance_cursor_for_consumer
The following is a list of properties for the function journal_advance_cursor_for_consumer:
| Property | Value |
|---|---|
brief | Advance journal cursor for consumer |
category | journal |
description | Update the advance cursor for a consumer referenced by the consumerId parameter. The limit parameter specifies the maximum number of entries to scan for an applicable entry for consumer before returning. NULL is always returned. There are no response properties set by this function. The properties of the _AdaptiveProvisioningPeer_ object associated with the consumer_id are used in the following way: The consumerFilter expression is used to determine if an entry is applicable. Journal entries are scanned beginning at the entry at the cursor in the advanceCursor property. If the advanceCursor property is not present, the scan begins after the cursor in currentCursor. If neither are present, the scan begins at the start of the journal. If an new applicable entry is found or if the limit is met, the advanceCursor property is set to the currently scanned entry's cursor. |
functionId | journal_advance_cursor_for_consumer |
functionLabel | journal_advance_cursor_for_consumer |
parameters | [ { "dataType": "string", "description": "Id of adaptor.", "name": "adaptorId" }, { "dataType": "string", "description": "The consumerId property value of the associated _AdaptiveProvisioningPeer_ object.", "name": "consumerId" }, { "dataType": "integer", "description": "The maximum number of entries that will be scanned for an entry where the consumerFilter expression in the associated _AdaptiveProvisioningPeer_ object evaluates to true.", "name": "limit", "optional": true } ] |
returns | { "dataType": "object", "description": "Response object." } |
sideEffects | [ "Journal cursor consumed" ] |