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

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

FTPUpload

fun FTPUpload()

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>

Functions

anonymous

fun anonymous(): FTPUpload.AuthMethod.Anonymous

booleanParameter

fun booleanParameter( customName: String? = null, trueValue: String? = "true", falseValue: String? = "false"): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

clear

fun clear()

clearConditions

fun clearConditions()

Deletes all configured build step conditions

compoundParameter

fun <T : CompoundParam<T>> compoundParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, 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

fun doubleParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

enumParameter

fun <E : Enum<E>> enumParameter(customName: String? = null, mapping: Map<E, String?>? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

findRawParam

fun findRawParam(paramName: String): Parameter?

hasParam

fun hasParam(paramName: String): Boolean

intParameter

fun intParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

param

fun param(name: String, value: String)

Adds parameter with specified name and value

removeRawParam

fun removeRawParam(paramName: String)

stringParameter

open fun stringParameter(customName: String? = null): <ERROR CLASS><Parametrized, <ERROR CLASS><Parametrized, T?>>

toString

open override fun toString(): String

usernameAndPassword

fun usernameAndPassword(init: FTPUpload.AuthMethod.UsernameAndPassword.() -> Unit = {}): FTPUpload.AuthMethod.UsernameAndPassword

validate

open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer

Properties

authMethod

var authMethod: <ERROR CLASS>

Authentication method.

conditions

var conditions: BuildStepConditions

Optional collection of build step execution conditions

dataChannelProtection

var dataChannelProtection: <ERROR CLASS>

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

enabled

var enabled: Boolean = true

Specifies whether the step is enabled, true by default

executionMode

var executionMode: BuildStep.ExecutionMode

Build step execution mode

ftpMode

var ftpMode: <ERROR CLASS>

FTP Mode.

var id: String? = null

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: <ERROR CLASS>

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

sourcePath

var sourcePath: <ERROR CLASS>

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: <ERROR CLASS>

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

transferMode

var transferMode: <ERROR CLASS>

Optional. An FTP transfer mode to force.

type

var type: String

Build step type

FTPUpload

See also

Constructors

Types

Functions

Properties