http
Latest release
- conduit-connector-http_0.4.0_Darwin_arm64.tar.gz
- conduit-connector-http_0.4.0_Darwin_x86_64.tar.gz
- conduit-connector-http_0.4.0_Linux_arm64.tar.gz
- conduit-connector-http_0.4.0_Linux_i386.tar.gz
- conduit-connector-http_0.4.0_Linux_x86_64.tar.gz
- conduit-connector-http_0.4.0_Windows_arm64.tar.gz
- conduit-connector-http_0.4.0_Windows_i386.tar.gz
- conduit-connector-http_0.4.0_Windows_x86_64.tar.gz
Description
Conduit HTTP source and destination connectors, they connect to an HTTP URL and send HTTP requests.
Source Parameters
version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example-source
type: source
plugin: "http"
name: example-source
settings:
# Http url to send requests to
# Type: string
url: ""
# Http headers to use in the request, comma separated list of :
# separated pairs
# Type: string
headers: ""
# HTTP method to use in the request
# Type: string
method: "GET"
# parameters to use in the request, use params.* as the config key and
# specify its value, ex: set "params.id" as "1".
# Type: string
params.*: ""
# how often the connector will get data from the url
# Type: duration
pollingPeriod: "5m"
# The path to a .js file containing the code to prepare the request
# data. The signature of the function needs to be: `function
# getRequestData(cfg, previousResponse, position)` where: * `cfg` (a
# map) is the connector configuration * `previousResponse` (a map)
# contains data from the previous response (if any), returned by
# `parseResponse` * `position` (a byte array) contains the starting
# position of the connector. The function needs to return a Request
# object.
# Type: string
script.getRequestData: ""
# The path to a .js file containing the code to parse the response.
# The signature of the function needs to be: `function
# parseResponse(bytes)` where `bytes` are the original response's raw
# bytes (i.e. unparsed). The response should be a Response object.
# Type: string
script.parseResponse: ""
# ValidateConnection sends a HEAD request when opening the connector
# to check if the connection works.
# Type: bool
validateConnection: "true"
# Maximum delay before an incomplete batch is read from the source.
# Type: duration
sdk.batch.delay: "0"
# Maximum size of batch before it gets read from the source.
# Type: int
sdk.batch.size: "0"
# Specifies whether to use a schema context name. If set to false, no
# schema context name will be used, and schemas will be saved with the
# subject name specified in the connector (not safe because of name
# conflicts).
# Type: bool
sdk.schema.context.enabled: "true"
# Schema context name to be used. Used as a prefix for all schema
# subject names. If empty, defaults to the connector ID.
# Type: string
sdk.schema.context.name: ""
# Whether to extract and encode the record key with a schema.
# Type: bool
sdk.schema.extract.key.enabled: "true"
# The subject of the key schema. If the record metadata contains the
# field "opencdc.collection" it is prepended to the subject name and
# separated with a dot.
# Type: string
sdk.schema.extract.key.subject: "key"
# Whether to extract and encode the record payload with a schema.
# Type: bool
sdk.schema.extract.payload.enabled: "true"
# The subject of the payload schema. If the record metadata contains
# the field "opencdc.collection" it is prepended to the subject name
# and separated with a dot.
# Type: string
sdk.schema.extract.payload.subject: "payload"
# The type of the payload schema.
# Type: string
sdk.schema.extract.type: "avro"
Destination Parameters
version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example-destination
type: destination
plugin: "http"
name: example-destination
settings:
# URL is a Go template expression for the URL used in the HTTP
# request, using Go [templates](https://pkg.go.dev/text/template). The
# value provided to the template is
# [opencdc.Record](https://conduit.io/docs/using/opencdc-record), so
# the template has access to all its fields (e.g. .Position, .Key,
# .Metadata, and so on). We also inject all template functions
# provided by [sprig](https://masterminds.github.io/sprig/) to make it
# easier to write templates.
# Type: string
url: ""
# Http headers to use in the request, comma separated list of :
# separated pairs
# Type: string
headers: ""
# HTTP method to use in the request
# Type: string
method: "POST"
# parameters to use in the request, use params.* as the config key and
# specify its value, ex: set "params.id" as "1".
# Type: string
params.*: ""
# ValidateConnection sends a HEAD request when opening the connector
# to check if the connection works.
# Type: bool
validateConnection: "true"
# Maximum delay before an incomplete batch is written to the
# destination.
# Type: duration
sdk.batch.delay: "0"
# Maximum size of batch before it gets written to the destination.
# Type: int
sdk.batch.size: "0"
# Allow bursts of at most X records (0 or less means that bursts are
# not limited). Only takes effect if a rate limit per second is set.
# Note that if `sdk.batch.size` is bigger than `sdk.rate.burst`, the
# effective batch size will be equal to `sdk.rate.burst`.
# Type: int
sdk.rate.burst: "0"
# Maximum number of records written per second (0 means no rate
# limit).
# Type: float
sdk.rate.perSecond: "0"
# The format of the output record. See the Conduit documentation for a
# full list of supported formats
# (https://conduit.io/docs/using/connectors/configuration-parameters/output-format).
# Type: string
sdk.record.format: "opencdc/json"
# Options to configure the chosen output record format. Options are
# normally key=value pairs separated with comma (e.g.
# opt1=val2,opt2=val2), except for the `template` record format, where
# options are a Go template.
# Type: string
sdk.record.format.options: ""
# Whether to extract and decode the record key with a schema.
# Type: bool
sdk.schema.extract.key.enabled: "true"
# Whether to extract and decode the record payload with a schema.
# Type: bool
sdk.schema.extract.payload.enabled: "true"