Web Dav Store
Web Dav Store (web-dav-store)
Write to a WebDAV-compatible object store.
Object Store WebDAV binary json raw
Minimal example
output: web-dav-store: base-url: ~ object-name: name: ~JSON
{ "output": { "web-dav-store": { "base-url": null, "object-name": { "name": null } } }}Contents
Fields
| Field | Type | Required | Description |
|---|---|---|---|
base-url Location | string | ✅ | Base URL for the WebDAV endpoint (e.g., https://host/webdav). |
object-name Location | Object Name | ✅ | File name (may contain slashes). |
retry Reliability | Retry | Retry on failure. | |
batch Processing | Batch | Write events as batches. | |
bucket-name Location | string | Optional bucket or root path that will be prepended to object names. | |
mode Behavior | Mode | Specify whether we’re putting or deleting. Allowed values: put, delete | |
input-field Processing | field (string) | Use the specified field as the content for the file line. Examples: data_field | |
disable-object-name-guid Object Properties | boolean (bool) | Disable the GUID prefix if you want object name to be treated literally (off for deletes). | |
guid-prefix Object Properties | string | GUID Prefix, will be prepended to the GUID, the default value is ”/”. | |
guid-suffix Object Properties | string | GUID Suffix, will be appended to the GUID if specified. | |
preprocessors Processing | Preprocessors[] | Preprocessors (process data before making it available for upload) these processors will be run in the order they are specified. Allowed values: gzip, parquet, base64 | |
track-schema Reliability | boolean (bool) | Check the schema of the written data and update __SCHEMA_NUMBER (written data must be JSON). | |
config Advanced | map (string) | Additional configuration passed directly to the HTTP client (see object_store http configs). |
Reliability
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
retry | Retry | Retry on failure. | |
track-schema | boolean (bool) | Check the schema of the written data and update __SCHEMA_NUMBER (written data must be JSON). |
Processing
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
batch | Batch | Write events as batches. | |
input-field | field (string) | Use the specified field as the content for the file line. Examples: data_field | |
preprocessors | Preprocessors[] | Preprocessors (process data before making it available for upload) these processors will be run in the order they are specified. Allowed values: gzip, parquet, base64 |
Location
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
base-url | string | ✅ | Base URL for the WebDAV endpoint (e.g., https://host/webdav). |
object-name | Object Name | ✅ | File name (may contain slashes). |
bucket-name | string | Optional bucket or root path that will be prepended to object names. |
Behavior
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
mode | Mode | Specify whether we’re putting or deleting. Allowed values: put, delete |
Object Properties
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
disable-object-name-guid | boolean (bool) | Disable the GUID prefix if you want object name to be treated literally (off for deletes). | |
guid-prefix | string | GUID Prefix, will be prepended to the GUID, the default value is ”/”. | |
guid-suffix | string | GUID Suffix, will be appended to the GUID if specified. |
Advanced
Show fields
| Field | Type | Required | Description |
|---|---|---|---|
config | map (string) | Additional configuration passed directly to the HTTP client (see object_store http configs). |
Schema
- Object Name Options
- Retry Fields
- Batch Fields
- Config Table
- Batch - Mode Options
- Mode Options
- Preprocessors Options
Object Name Options
| Option | Name | Type | Description |
|---|---|---|---|
name | Name | string | Object Name. |
field | Field | string | Field containing the Object Name. |
Retry Fields
| Field | Type | Required | Description |
|---|---|---|---|
timeout | time-interval (string) | ✅ | timeout (e.g. 500ms, 2s etc. - default is 30). Examples: 500ms, 2h |
retries | number (integer) | number of retries. Examples: 42, 1.2e-10 |
Batch Fields
| Field | Type | Required | Description |
|---|---|---|---|
fixed-size | number (integer) | maximum number of events in an output batch. Examples: 42, 1.2e-10 | |
mode | Mode | ✅ | If ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.Allowed values: fixed, document |
timeout | time-interval (string) | ✅ | interval after which the batch is sent, to keep throughput going (default 100ms). Examples: 500ms, 2h |
header | multiline-text (string) | put a header line before the batch. | |
footer | multiline-text (string) | put a header line after the last line of the batch. | |
use-document-marker | boolean (bool) | Enrich the job metadata with a document marker (for document handling in batch mode). | |
wrap-as-json | boolean (bool) | Format the output batch as a JSON array. |
Config Table
| Setting | Value |
|---|---|
setting.name | value |
Value format: templated-text.
Batch - Mode Options
| Value | Description |
|---|---|
fixed | Fixed |
document | Document |
Mode Options
| Value | Description |
|---|---|
put | Put Objects |
delete | Delete Objects |
Preprocessors Options
| Value | Description |
|---|---|
gzip | Gzip the output data |
parquet | Extract the received data as JSON rows from a parquet file |
base64 | Decode base64 as binary |