createDataQueue
The service creates a sequential or keyed dataqueue in the IBM® Power system.
- Input parameters
-
- $connectionAlias
- String. Required. Connection alias of the IBM Power system.
- queueName
- String. Required. Name of the dataqueue. The dataqueue name must be between 1 to 10 characters in length. Example, MYQUEUE.
- libraryName
- String. Required. Library in which the dataqueue must be created. The library name must be between 1 to 10 characters in length.
- queueType
- String. Required. Dataqueue type. Following are the possible values.
- FIFO - Processes records in a sequential order of First In, First Out (FIFO) in the dataqueue.
- LIFO - Processes records in a sequential order of Last In, First Out (LIFO) in the dataqueue.
- Keyed - Processes records as a key-value pair in the dataqueue.
- keyLength
- String. Optional. Length of the key in bytes if the queueType is
Keyed. If the queueType is
- FIFO or LIFO - keyLength is not required.
- Keyed - LIFO is mandatory. Valid values are 1 to 256.
- maxEntryLength
- String. Required. Maximum number of bytes per dataqueue record. Valid values are 1 to 64512.
- authority
- String. Required. Public authority for the dataqueue. Valid values are *ALL, *CHANGE, *EXCLUDE, *USE, *LIBCRTAUT.
- saveSenderInformation
- String. Optional. The default value is false. Set to true when the sender (origin) information of the records must be saved.
- forceToAuxiliaryStorage
- String. Optional. The default value is false. Set the value to true to immediately write the records to a permanent storage. Set the value to false to keep the records to write in memory, which might be lost if power outage.
- description
- String. Text description of the dataqueue. The string must be 50 characters or less.
- Return values
-
- success
- String. Status of the service execution. It returns true when the dataqueue is successfully created, else returns false.
- error
- String. Error message if the dataqueue creation fails.