Table of Contents

Search

  1. Preface
  2. Introduction to Edge Data Streaming Custom Entity Types
  3. Managing Custom Entity Types
  4. Custom Entities from Maven Archetypes
  5. REST APIs
  6. HTTP Request and Response Parameters
  7. Sample JSON Requests and Responses
  8. Glossary

Developer Guide

Developer Guide

Target Service Parameters

Target Service Parameters

The following table describe the common HTTP request parameters for target services:
Parameters
Description
name
Name of the target service.
pluginId
Identifier of the target service plug-in. For example, _VDS_TGT_CASSANDRA , _VDS_TGT_FILE, _VDS_TGT_HDFS, _VDS_TGT_HTTP, _VDS_TGT_JMS, _VDS_TGT_KAFKA, _VDS_TGT_KINESIS, _VDS_TGT_WS, _VDS_TGT_UM, _VDS_TGT_CEP, _VDS_TGT_EVENTHUB or _VDS_TGT_PC
config
Configuration for the target service.
stats
Statistics for the target service.

Cassandra Target Service

The following table describes the HTTP request parameters for a Cassandra target service:
Parameters
Description
contactpoints
URI of the Cassandra database. Use the following URI format: <hostname(s)>:<port>
keyspace
Keyspace to use when writing to the database.
tablename
Table name to use when writing to the database.
username
User name of the Cassandra database.
password
The password of the user account that you use to connect to the Cassandra keyspace.

EventHub Target Service

The following table describes the HTTP request parameters for an EventHub target service:
Parameters
Description
tenantId
The ID of the tenant that the data belongs to. This ID is the Directory ID of the Azure Active Directory.
subscriptionId
The ID of the Azure subscription.
resourceName
The name of the Azure resource group associated with the event hub namespace.
clientApplicationId
The ID of the application created under the Azure Active Directory.
clientSecretKey
The secret key generated for the application.
eventHubNamespace
The name of the Event Hub Namespace that is associated with the resource group name.
eventHubName
The name of the Event Hub.
sharedAccessPolicyName
The name of the Event Hub Namespace Shared Access Policy. To write to an Event hub, the policy must have Send permission.
sharedAccessPolicyKey
The primary key of the Event Hub Namespace Shared Access Policy.

File Target Service

The following table describes the HTTP request parameters for a File target service:
Parameters
Description
path
Full path to the directory that contains the target files.
fileName
Name of the target file. The following special characters are not allowed:
* : ? " < > | / \
Maximum length is 200 characters.
appendTimestamp
Indicate whether the timestamp must be appended to the file name.
dateFormat
Date and time format to append to the rollover file name. The following special characters are not allowed:
* : ? " < > | / \
For example, the following date string represents 3:00 pm on December 07, 2014 if you specify the format as <yyyy>-<MM>-<dd>-<HH>-<mm>-<ss>:
2014-12-07-15-00-00
rolloverSize
Target file size, in megabytes (MB), at which to trigger rollover. A value of zero (0) means that the target service does not roll the file over based on size. Default is 10.
rolloverTime
Length of time, in hours, to keep a target file active. After the time period has elapsed, the target service rolls the file over. A value of zero (0) means that the target service does not roll the file over based on time. Default is 0.
bufferSize
The size of the output stream buffer.
receiveIdleEvents
Indicate whether the target service should flush the data to the file system if the size of the data is less than the buffer size.
idleEventTimeOut
Time in seconds after which the target service flushes the data to the file system.

HDFS Target Service

The following table describes the HTTP request parameters for an HDFS target service:
Parameters
Description
destination
URI of the target file to which the target service writes data.
The HDFS target service type supports the following URI formats:
HDFS URI format. For example, hdfs://<namenode-name>[:<port>]/<path>/<file-name>
MapR URI format. For example, maprfs:///<path>/<file-name>
securityModeList
Indicates if HDFS has Kerberos authentication enabled. For example, NON_SECURE, SECURE. Default is NON_SECURE.
userPrincipal
User principal to log in to the HDFS super user account. Specify a user principal in the following format:
user@DOMAIN.COM
keytabPath
Location of the keytab files that HDFS uses. Specify this when the security mode is SECURE.
dateFormat
The time stamp that is appended to the name of the file written to the target. Specify this when the security mode is SECURE.
rolloverSize
Target file size, in gigabytes (GB), at which to trigger rollover. Default is 1.
rolloverTime
Length of time, in hours, to keep a target file active. After the time period has elapsed, the target service rolls the file over. A value of zero (0) means that the HDFS target service does not roll the file over based on time. Default is 0.
sync
Flush the client's buffer to the disk device once every second. If you enable forceful synchronization, the data written by the target service is visible to other readers immediately. Specify one of the following values:
  • hsyncTimeIntervalValue. Time in seconds after which the forceful synchronization occurs.
  • hsyncBufferLengthValue. The buffer size in bytes after which forceful synchronization occurs.
receiveIdleEvents
Indicate whether the target service should flush the data to the file system if the size of the data is less than the buffer size.
idleEventTimeOut
Time in seconds after which the target service flushes the data to the file system.

HTTP Target Service

The following table describes the HTTP request parameters for an HTTP target service:
Parameters
Description
connectionType
Connection type. For example, HTTP, HTTPS_ALLOW_ALL_CERTIFICATES, or HTTPS_ALLOW_CERTS_IN_TRUSTSTORE. Default is HTTP
targetUrl
URL of the HTTP server. Specify this URL when the connection type is HTTP. Enter the path in the following format:
http://<server>:<port>/myapp/path
targetUrlHttpsTrustall
URL of the HTTP server. Specify this URL when the connection type is HTTPS_ALLOW_ALL_CERTIFICATES. Enter the path in the following format:
http://<server>:<port>/myapp/path
targetUrlHttpsTruststore
URL of the HTTP server. Specify this URL when the connection type is HTTPS_ALLOW_CERTS_IN_TRUSTSTORE. Enter the path in the following format:
http://<server>:<port>/myapp/path
trustStorePath
Path and file name of the Java truststore file. Specify the path if connection type is HTTPS_ALLOW_CERTS_IN_TRUSTSTORE.
trustStorePassword
Password for the truststore file. Specify the password if connection type is HTTPS_ALLOW_CERTS_IN_TRUSTSTORE.

JMS Target Service

The following table describes the HTTP request parameters for a JMS target service:
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.

Kafka Target Service

The following table describes the HTTP request parameters for a JMS target service:
Parameters
Description
kafkaDestination
The IP address and port combination of the Kafka messaging system broker.
topic
Topic on which the Kafka target service sends messages.
clientId
An id string to pass to the server when making requests. The purpose of this is to be able to track the source of requests beyond just ip/port by allowing a logical application name to be included in server-side request logging.
securityMode
Indicates if Kafka has Kerberos authentication enabled.
textAreaProducerProps
The properties that are used to connect to Kafka.

Kinesis Target Service

The following table describes the HTTP request parameters for a Kinesis target service:
Parameters
Description
accessKey
Access key ID that the AWS IAM service generates when you create a user.
secretKey
Secret access key that the AWS IAM service generates when you create a user.
streamName
Name of the Kinesis stream to which to write data.
region
Region where the endpoint for your service is available.
parallelRequests
Number of threads in the thread pool. Default is 5.
queueLength
Length of the queue that the target service uses. Default is 10000.
partitionKeyName
Name of the partition key in the message header. For example, IP_ADDRESS, CUSTOM_PARTITION_KEY, or DYNAMIC_PARTITION_KEY. Default is DYNAMIC_PARTITION_KEY.
userDefinedPartitionKey
Name of the custom message header to use as the partition key. Specify this if you use a custom IP address message header as the partition key.

WebSocket Target Service

The following table describes the HTTP request parameters for a WebSocket target service:
Parameters
Description
connectionType
Connection type. For example, WS, WSS_ALLOW_ALL_CERTIFICATES, or WSS_ALLOW_CERTS_IN_TRUSTSTORE. Default is WS.
targetUrl
URL of the WebSocket server. Specify the URL if the connection type is WS. Enter the path in the following format:
ws://<server>:<port>/myapp/path
targetUrlWssTrustall
URL of the WebSocket server. Specify the URL if the connection type is WSS_ALLOW_ALL_CERTIFICATES. Enter the path in the following format:
wss://<server>:<port>/myapp/path
targetUrlWssTruststore
URL of the WebSocket server. Specify the URL if the connection type is WSS_ALLOW_CERTS_IN_TRUSTSTORE. Enter the path in the following format:
wss://<server>:<port>/myapp/path
trustStorePath
Path and file name of the Java truststore file. Specify the path and name if the connection type is WSS_ALLOW_CERTS_IN_TRUSTSTORE.
trustStorePassword
Password for the truststore file. Specify the password if the connection type is WSS_ALLOW_CERTS_IN_TRUSTSTORE.

0 COMMENTS

We’d like to hear from you!