queues
http://www.sifassociation.org/infrastructure/3.2
Documentation
The Queues Service supports creation, deletion and querying of Queue (Instance) / Queue Messages Service pairs.
Tree
Table
Name | Mandatory | Characteristics | Type | Description | XPath | Format |
---|---|---|---|---|---|---|
@id | uuidType | /queues/queue/@id | [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} | |||
polling | O | string | Determines, when no messages are queued, whether the Consumer will have to periodically reissue Polling Requests at timed intervals or can reissue a Polling Request immediately. | /queues/queue/polling | IMMEDIATE, LONG | |
ownerId | C | uuidType | The Environment ID of the owning Consumer for which this Queue is buffering messages. It is not specified at Queue create time, but is returned as part of the response to a query operation, and serves to allow an administrative application to identify which application the Queue instance is assigned to. | /queues/queue/ownerId | [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[14][a-fA-F0-9]{3}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12} | |
name | O | token | A name which the Consumer assigns to the Queue. It is useful for reporting purposes, but is not guaranteed to be unique. | /queues/queue/name | ||
queueUri | M | anyURI | The URI of the Messages Service associated with the Queue instance. This is the endpoint where the 'get next message' requests are issued. | /queues/queue/queueUri | ||
ownerUri | O | anyURI | When present, this contains the URL which the Queue instance will use when it determines the owner needs to be asynchronously alerted that a new message has arrived in the Queue. | /queues/queue/ownerUri | ||
idleTimeout | M | unsignedInt | Is the maximum time in seconds the Messages Service will wait for a message to arrive, before returning an HTTPS Response of 'no message seen' to the Consumer. | /queues/queue/idleTimeout | ||
minWaitTime | C | unsignedInt | indicates the minimum time in seconds that the Consumer should wait after receiving a 'no message seen' response to a previous query, before posting another. | /queues/queue/minWaitTime | ||
maxConcurrentConnections | O | string | Number of (properly identified) concurrent connections supported by (the consumer, if suggested, and) the queue. | /queues/queue/maxConcurrentConnections | ||
created | M | dateTime | Time that Queue Instance was Created | /queues/queue/created | ||
lastAccessed | M | dateTime | Time that Queue Instance was last Accessed and a message was dequeued. | /queues/queue/lastAccessed | ||
lastModified | M | dateTime | Time that Queue Instance was last Modified by receiving a new incoming message. | /queues/queue/lastModified | ||
messageCount | M | unsignedInt | The number of messages currently residing in the Queue. | /queues/queue/messageCount |
Download: .xlsx
XML Structure
Download: .xml