{%- import "macro.peb" -%}
---
title: {{ shortName }}
editLink: false
{% if docDescription -%}
description: {{ docDescription | json }}
{% endif -%}

{% if icon -%}
icon: {{ icon }}
{% endif -%}

---


<h1>
    {% if icon %}<img width="25" src="data:image/svg+xml;base64,{{ icon }}" alt="{{ shortName }}" />{% endif%} {{ shortName }}
</h1>

{% if deprecated %}
    {%- if replacement -%}
::alert{type="info"}
🛈 This feature has been moved to a new location, please use `{{ replacement }}` instead.
::
    {%- else -%}
::alert{type="warning"}
⚠ This feature is deprecated and will be removed in the future. We encourage you to migrate to the new plugin, but you can still use the deprecated version.
::
    {%- endif -%}
{%- endif %}

{% if beta %}
::alert{type="info"}
This plugin is currently in beta. While it is considered safe for use, please be aware that its API could change in ways that are not compatible with earlier versions in future releases, or it might become unsupported.
::
{%- endif %}


{% if docLicense == "EE" %}
::alert{type="info"}
This plugin is exclusively available on the Cloud and Enterprise editions of Kestra.
::
{%- endif %}

```yaml
type: "{{ cls }}"
```

{% if docDescription -%}
<span style="font-size:1.25em;">{{ docDescription }}</span>
{%- endif %}

{% if docBody -%}
  {{ docBody }}
{%- endif %}

{% if docExamples != null %}
## Examples
    {%- for example in docExamples %}
        {%- if example.title %}
> {{ example.title }}
        {%- endif %}
```{{- example.lang | default("yaml") }}
{{ example.task }}
```
    {% endfor -%}
{%- endif %}


{% if inputs != null -%}
## Properties
    {%- for entry in inputs %}
### `{{ entry.key }}`
{{ fieldType(entry.value) }}
* **Dynamic:** {{ dynamic(entry.value) -}}
* **Required:** {{ entry.value['$required'] == true ? "✔️" : (entry.value['$required'] == false ? "❌" : "❓") }}
{{ fieldDetail(entry.value) }}
    {%- endfor -%}
{% endif %}


{% if outputs != null and outputs|length > 0 -%}
## Outputs
    {%- for entry in outputs %}
### `{{ entry.key }}`
{{ fieldType(entry.value) }}
* **Required:** {{ entry.value['$required'] == true ? "✔️" : (entry.value['$required'] == false ? "❌" : "❓") }}
{{ fieldDetail(entry.value) }}
    {%- endfor -%}
{% endif %}


{% if defs != null and defs|length > 0 -%}
## Definitions
    {%- for entry in defs %}
### `{{ entry.key }}`
{% if entry.value.properties != null -%}
#### Properties
    {%- for entryProps in entry.value.properties %}
##### `{{ entryProps.key }}`
{{ fieldType(entryProps.value) }}
* **Dynamic:** {{ dynamic(entryProps.value) }}
* **Required:** {{ entryProps.value['$required'] == true ? "✔️" : (entryProps.value['$required'] == false ? "❌" : "❓") }}
{{ fieldDetail(entryProps.value) }}
    {%- endfor -%}
{% endif %}

    {%- endfor -%}
{% endif %}


{% if docMetrics != null -%}
## Metrics
    {%- for entry in docMetrics %}
### `{{ entry.name }}`
* **Type:** =={{ entry.type }}== {% if entry.unit %} ({{ entry.unit }}) {% endif %}
{%- if data.description %}
{{ data.description }}
{%- endif %}

    {%- endfor -%}
{% endif %}
