Edge Data Streaming
- Edge Data Streaming 2.3.0
- All Products
Parameters
| Description
|
---|---|
name
| Name of the source service.
|
pluginId
| Identifier of the source service plug-in. For example, _VDS_SRC_FLAT_FILE, _VDS_SRC_HTTP, _VDS_SRC_JMS, _VDS_SRC_MQTT, _VDS_SRC_STATIC_FILE, _VDS_SRC_SYSLOG_TCP, _VDS_SRC_SYSLOG_UDP, _VDS_SRC_SYSLOG_UDS, _VDS_SRC_TCP, _VDS_SRC_UDP, _VDS_SRC_UDS, _VDS_SRC_SYSLOG_TCP, _VDS_SRC_SYSLOG_UDP, _VDS_SRC_UM, or _VDS_SRC_WS.
|
config
| Configuration for the source service.
|
stats
| Statistics for the source service.
|
Parameters
| Description
|
---|---|
directory
| Full path to the directory that contains the source files.
|
fileNameRegex
| Exact file name or Java regular expression that matches the active source file name.
|
isRegexFileName
| Indicates that the file name is a regular expression
|
moveCompletedFilesTo
| Location to where the files should be moved after they are processed.
|
delimiter
| End-of-line character sequence that marks the end of a line in the source file. For example, LF, CRLF, or CUSTOM. Default is LF.
|
customDelimiter
| Custom character sequence that you want to specify as delimiter for the file source services.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default is 8192. Minimum is 1.
|
Parameters
| Description
|
---|---|
directory
| Full path to the directory that contains the source files.
|
fileNameRegex
| Exact file name or Java regular expression that matches the active source file name.
|
isRegexFileName
| Indicates that the file name is a regular expression
|
noOfThreads
| The number of threads used to process the files in parallel. Default is 5. Minimum is 1.
|
coolingTime
| The time in seconds from file modification after which the file should be processed. Specify a waiting time that is greater than the time taken by the application to write to the active file. Default is 5.
|
moveCompletedFilesTo
| Location to where the files should be moved after they are processed.
|
delimiter
| End-of-line character sequence that marks the end of a line in the source file. For example, LF, CRLF, or CUSTOM. Default is LF.
|
customDelimiter
| Custom character sequence that you want to specify as delimiter for the file source service.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
connectionType
| Connection type. For example, HTTP or HTTPS.
|
httpPostPath
| Path of the HTTP POST requests that you want the HTTP service to receive.
|
httpsPostPath
| Path of the HTTPS POST requests that you want the HTTP service to receive.
|
keystorePath
| Directory that contains the keystore file. Specify the absolute path to file if you select the HTTPS connection type.
|
keystorePassword
| Password for the keystore file. Specify the password if you select the HTTPS connection type.
|
isPartialPath
| Indicate that the path is a prefix.
|
healthCheckUrl
| Path to which an HTTP GET request is sent to verify if the server is running.
|
port
| Port on which to listen for incoming connections.
|
idleTimeout
| Time after which the connection is closed when there is no incoming data. Specify a value of 0 to disable timeout.
|
syncOption
| Type of synchronous response. For example, NO_SYNC_RESPONSE, TARGET_ACK_BASED_SYNC_RESPONSE, or HTTP_RESPONSE_BASED_SYNC_RESPONSE. Default is NO_SYNC_RESPONSE.
|
responseExpiryTime
| Time in milliseconds for which the source waits for a POST at the response URL.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
ctxFactory
| The JMS provider specific initial JNDI context factory implementation for connecting to the JNDI service. This value is a fully qualified class name of the Initial Context Factory. Add the JMS Client jar files to the VDS server.
|
connFactory
| The name of the object in the JNDI server that enables the JMS Client to create JMS connections.
|
providerURL
| The location and port of the JMS provider on which to connect.
|
username
| User name to the connection factory.
|
password
| The password of the user account that you use to connect to the connection factory.
|
destType
| The type of destination on which the source service receives JMS messages. For example, TOPIC or QUEUE. Default is TOPIC.
|
dSubName
| Durable subscriptions can receive messages sent while the subscribers are not active. Durable subscriptions provide the flexibility and reliability of queues, but still allow clients to send messages to many recipients. Specify the subscription name if the destination type is TOPIC.
|
destname
| Name of the queue or topic on the JMS Provider as defined in the JMS Connection Factory created by the JMS Administrator. The source service receives JMS messages from this queue or topic.
|
msgType
| Type of source. For example, BYTE, TEXT, or MAP.
|
ackMode
| Acknowledgment mode for non-transacted sessions.
You can select one of the following acknowledgment modes:
Specify AUTO_ACK or CLIENT_ACK. Default is AUTO_ACK
|
clientId
| Client identifier to identify the connection and set up a durable connections. To ensure that a publish-subscribe application receives all published messages, use PERSISTENT delivery mode for the publishers. In addition, use durable subscriptions for the subscribers.
|
selector
| Criteria for filtering message header or message properties, to limit which JMS messages the source service receives.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
url
| URL of the MQTT broker or server to which to connect to receive messages. The URL is of the form tcp://<IP_address>:<port>
|
mqttTopics
| Names of the topics to which to subscribe. The MQTT source service supports the topic wildcards that the MQTT specification describes. Specify a comma-separated list of topic names.
|
clientId
| Unique identifier that identifies the connection between the MQTT source service and MQTT broker, and the file-based persistence store that the MQTT source service uses to store messages when they are being processed.
|
maxEnqueuedMsg
| Maximum number of messages that can be stored in the persistence store.
|
maxMsgPerBatch
| Maximum number of messages that are sent by the persistence store in a batch, to a target service.
|
retryCount
| Number of times that the MQTT source service tries to add messages to the internal queue if the internal queue is full.
|
retryInterval
| The time in milliseconds between retries.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
portTCP
| TCP port that the source application uses to connect to the Syslog TCP source service.
|
delimiter
| Line feed character sequence that marks the end of a message in the TCP data stream.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
portUDP
| UDP port that the source application uses to connect to the Syslog UDP source service.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
sockAddress
| The socket address that the source writes to. The Syslog UDS source service should have write access to the folder that contains the socket file. The socket file is used for communication between the Syslog client and server. For example, /dev/log
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
portTCP
| TCP port that the source application uses to connect to the Syslog TCP source service.
|
delimiter
| Line feed character sequence that marks the end of a message in the TCP data stream.
|
msgLen
| Length of each record that is read, in bytes. Specify the length when the source data stream consists of records of a fixed length. The maximum value is 51200.
|
customDelimiter
| Custom character sequence that you want to specify as delimiter for the file source services.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
portUDP
| UDP port that the source application uses to connect to the Syslog UDP source service.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameter
| Description
|
---|---|
UMRcv_TopicName
| Topic on which the UM sending application publishes messages.
|
UMRcv_XMLConfig
| UM configurations in XML format that the service uses.
|
UMRcv_AppName
| UM sending application name that the source service uses to get the configuration.
|
ctxName
| Context name that the source service uses to get the configuration. If you do not specify a name, the source service gets the configuration from a context with no name.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|
Parameters
| Description
|
---|---|
connectionType
| Connection type. For example, WS or WSS.
|
websocketPath
| Path of the WebSocket requests that you want the source service to receive.
|
websocketSecurePath
| Path of the WebSocket secure requests that you want the source service to receive.
|
keystorePath
| Directory that contains the keystore file. Specify the absolute path to file if you select the HTTPS connection type.
|
keystorePassword
| Password for the keystore file. Specify the password if you select the WSS connection type.
|
isPartialPath
| Indicate that the path is a prefix.
|
healthCheckUrl
| Path to which an HTTP GET request is sent to verify if the server is running.
|
port
| Port on which to listen for incoming connections.
|
idleTimeout
| Time after which the connection is closed when there is no incoming data. Specify a value of 0 to disable timeout.
|
eventSize
| Maximum length of data that the source service can read at a time, in bytes. Default value is 8192. Minimum value is 1.
|