io.kestra.plugin.fs.sftp.SftpInterface Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of plugin-fs Show documentation

Perform file system tasks in Kestra data orchestration pipelines.

The newest version!

package io.kestra.plugin.fs.sftp;

import io.kestra.core.models.annotations.PluginProperty;
import io.swagger.v3.oas.annotations.media.Schema;
import jakarta.validation.constraints.NotNull;
import lombok.Builder;

public interface SftpInterface {
    @Schema(
        title = "Private keyfile in the PEM file format to connect to a remote server using SSH",
        description = "To generate a PEM format key from OpenSSH, use the following command: `ssh-keygen -m PEM`"
    )
    @PluginProperty(dynamic = true)
    String getKeyfile();

    @Schema(
        title = "Passphrase of the ssh key"
    )
    @PluginProperty(dynamic = true)
    String getPassphrase();

    @Schema(
        title = "SFTP proxy host"
    )
    @PluginProperty(dynamic = true)
    String getProxyHost();

    @Schema(
        title = "SFTP proxy port"
    )
    @PluginProperty(dynamic = true)
    String getProxyPort();

    @Schema(
        title = "SFTP proxy user"
    )
    @PluginProperty(dynamic = true)
    String getProxyUser();

    @Schema(
        title = "SFTP proxy password"
    )
    @PluginProperty(dynamic = true)
    String getProxyPassword();

    @Schema(
        title = "SFTP proxy type"
    )
    @PluginProperty(dynamic = true)
    String getProxyType();

    @Schema(
        title = "Is path is relative to root dir"
    )
    @PluginProperty(dynamic = true)
    Boolean getRootDir();

    @Schema(
        title = "Configures Key exchange algorithm explicitly e. g diffie-hellman-group14-sha1, diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group1-sha1."
    )
    @PluginProperty
    String getKeyExchangeAlgorithm();
}