From 3def847e286667b67f5f6d4cf7015b02c5d56c11 Mon Sep 17 00:00:00 2001 From: sahner Date: Mon, 24 Aug 2015 20:41:42 -0500 Subject: [PATCH] add documentation about TimedShutoff firehose --- docs/content/ingestion/firehose.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/docs/content/ingestion/firehose.md b/docs/content/ingestion/firehose.md index 106ee43e155..fe3408357ad 100644 --- a/docs/content/ingestion/firehose.md +++ b/docs/content/ingestion/firehose.md @@ -224,7 +224,7 @@ A sample ingest firehose spec is shown below - #### CombiningFirehose This firehose can be used to combine and merge data from a list of different firehoses. -This can be used to merge data from more than one firehoses. +This can be used to merge data from more than one firehose. ```json { @@ -259,3 +259,27 @@ When using this firehose, events can be sent by submitting a POST request to the |type|This should be "receiver"|yes| |serviceName|name used to announce the event receiver service endpoint|yes| |bufferSize| size of buffer used by firehose to store events|no default(100000)| + + +#### TimedShutoffFirehose + +This can be used to start a firehose that will shut down at a specified time. +An example is shown below: + +```json +{ + "type" : "timed", + "shutoffTime": "2015-08-25T01:26:05.119Z", + "delegate": { + "type": "receiver", + "serviceName": "eventReceiverServiceName", + "bufferSize": 100000 + } +} +``` + +|property|description|required?| +|--------|-----------|---------| +|type|This should be "timed"|yes| +|shutoffTime|time at which the firehose should shut down, in ISO8601 format|yes| +|delegate|firehose to use|yes|