TeamCity Kotlin DSL/jetbrains.buildServer.configs.kotlin.buildSteps/FTPUpload

FTPUpload

fun BuildSteps.ftpUpload(init: FTPUpload.() -> Unit): FTPUpload

An FTP Upload build step.

Example. Adds an FTP Upload build step with FTPS security connection mode, private protection mode, authentication via username and password, binary transfer mode and active FTP mode. See options in documentation.

buildType {
    // Other Build Type settings ...
    steps {
        // Other Build Steps ...
        ftpUpload {
            name = "My FTP Upload step"
            targetUrl = "8.8.8.8"
            securityMode = FTPUpload.SecurityMode.FTPS
            dataChannelProtection = FTPUpload.DataChannelProtectionMode.PRIVATE
            authMethod = usernameAndPassword {
                username = "username"
                password = "credentialsJSON:******"
            }
            ftpMode = FTPUpload.FTPMode.ACTIVE
            transferMode = FTPUpload.TransferMode.BINARY
            sourcePath = """
                dir/**/*.zip
                 *.zip => winFiles
                 unix/distro.tgz => linuxFile
             """.trimIndent()
         }
Content copied to clipboard
    }
}

Constructors

FTPUpload

constructor(init: FTPUpload.() -> Unit)

constructor()

Types

AuthMethod

sealed class AuthMethod : CompoundParam<FTPUpload.AuthMethod>

DataChannelProtectionMode

enum DataChannelProtectionMode : Enum<FTPUpload.DataChannelProtectionMode>

FTPMode

enum FTPMode : Enum<FTPUpload.FTPMode>

SecurityMode

enum SecurityMode : Enum<FTPUpload.SecurityMode>

TransferMode

enum TransferMode : Enum<FTPUpload.TransferMode>

Properties

authMethod

var authMethod: FTPUpload.AuthMethod?

Authentication method.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

dataChannelProtection

var dataChannelProtection: FTPUpload.DataChannelProtectionMode?

Choose a data protection scheme if FTPS or FTPES is used.

enabled

var enabled: Boolean

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

ftpMode

var ftpMode: FTPUpload.FTPMode?

FTP Mode.

var id: String?

Optional id of the step. Usually the id is not required, however if a build configuration inherits from a template and wants to override a build step defined there, then both steps should have the same id.

name

var name: String

Build step name

params

val params: List<Parameter>

securityMode

var securityMode: FTPUpload.SecurityMode?

Choose between an insecure and a secure connection (FTPS, FTPES).

sourcePath

var sourcePath: String?

Newline- or comma-separated paths to files/directories to be deployed. Ant-style wildcards like dir/**/*.zip and target directories like *.zip => winFiles,unix/distro.tgz => linuxFiles, where winFiles and linuxFiles are target directories, are supported.

targetUrl

var targetUrl: String?

An FTP server (use a hostname or IP address) and a remote directory (relative to the FTP user's home).

transferMode

var transferMode: FTPUpload.TransferMode?

Optional. An FTP transfer mode to force.

type

var type: String

Build step type

Functions

anonymous

fun anonymous(): FTPUpload.AuthMethod.Anonymous

booleanParameter

fun booleanParameter(customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): DelegateProvider<Boolean?>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): DelegateProvider<T>

conditions

fun conditions(init: BuildStepConditions.() -> Unit = {})

Configures build step conditions

copyParamsTo

fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

create

open fun create(): BuildStep

Creates an instance of this build step via reflection using a no argument constructor, used during copying. Throws an error if this class doesn't have a default constructor. Subclasses can override it to create an instance without using a default constructor.

doubleParameter