// This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1247543314/Generate+reference+docs+for+Redpanda+Connect

= {{name}}
{{#if signature}}

*Signature*: `{{signature}}`
{{/if}}
{{#if (eq status "deprecated")}}

[WARNING]
====
This {{#if signature}}function{{else}}method{{/if}} is deprecated and will be removed in a future version.
====
{{/if}}
{{#if description}}

{{{ensurePeriod description}}}
{{/if}}

{{#if params}}
{{#if params.named}}

== Parameters

[cols="1,1,3"]
|===
| Name | Type | Description

{{#each params.named}}
| `{{name}}`{{#if is_optional}} (optional){{/if}}
| `{{type}}`
| {{{description}}}

{{/each}}
|===

{{/if}}
{{/if}}

{{#if examples}}
== Examples

{{#each examples}}
{{{bloblangExample this}}}
{{/each}}
{{/if}}

{{#if related}}
== Related

{{#each related}}
* {{this}}
{{/each}}
{{/if}}