commonMain.aws.sdk.kotlin.services.transfer.model.StartFileTransferRequest.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of transfer-jvm Show documentation
The AWS SDK for Kotlin client for Transfer
There is a newer version: 1.3.79
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.transfer.model

import aws.smithy.kotlin.runtime.SdkDsl

public class StartFileTransferRequest private constructor(builder: Builder) {
    /**
     * The unique identifier for the connector.
     */
    public val connectorId: kotlin.String? = builder.connectorId
    /**
     * For an inbound transfer, the `LocaDirectoryPath` specifies the destination for one or more files that are transferred from the partner's SFTP server.
     */
    public val localDirectoryPath: kotlin.String? = builder.localDirectoryPath
    /**
     * For an outbound transfer, the `RemoteDirectoryPath` specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a `RemoteDirectoryPath`, the destination for transferred files is the SFTP user's home directory.
     */
    public val remoteDirectoryPath: kotlin.String? = builder.remoteDirectoryPath
    /**
     * One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
     */
    public val retrieveFilePaths: List? = builder.retrieveFilePaths
    /**
     * One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
     *
     * Replace ` DOC-EXAMPLE-BUCKET ` with one of your actual buckets.
     */
    public val sendFilePaths: List? = builder.sendFilePaths

    public companion object {
        public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.transfer.model.StartFileTransferRequest = Builder().apply(block).build()
    }

    override fun toString(): kotlin.String = buildString {
        append("StartFileTransferRequest(")
        append("connectorId=$connectorId,")
        append("localDirectoryPath=$localDirectoryPath,")
        append("remoteDirectoryPath=$remoteDirectoryPath,")
        append("retrieveFilePaths=$retrieveFilePaths,")
        append("sendFilePaths=$sendFilePaths")
        append(")")
    }

    override fun hashCode(): kotlin.Int {
        var result = connectorId?.hashCode() ?: 0
        result = 31 * result + (localDirectoryPath?.hashCode() ?: 0)
        result = 31 * result + (remoteDirectoryPath?.hashCode() ?: 0)
        result = 31 * result + (retrieveFilePaths?.hashCode() ?: 0)
        result = 31 * result + (sendFilePaths?.hashCode() ?: 0)
        return result
    }

    override fun equals(other: kotlin.Any?): kotlin.Boolean {
        if (this === other) return true
        if (other == null || this::class != other::class) return false

        other as StartFileTransferRequest

        if (connectorId != other.connectorId) return false
        if (localDirectoryPath != other.localDirectoryPath) return false
        if (remoteDirectoryPath != other.remoteDirectoryPath) return false
        if (retrieveFilePaths != other.retrieveFilePaths) return false
        if (sendFilePaths != other.sendFilePaths) return false

        return true
    }

    public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.transfer.model.StartFileTransferRequest = Builder(this).apply(block).build()

    @SdkDsl
    public class Builder {
        /**
         * The unique identifier for the connector.
         */
        public var connectorId: kotlin.String? = null
        /**
         * For an inbound transfer, the `LocaDirectoryPath` specifies the destination for one or more files that are transferred from the partner's SFTP server.
         */
        public var localDirectoryPath: kotlin.String? = null
        /**
         * For an outbound transfer, the `RemoteDirectoryPath` specifies the destination for one or more files that are transferred to the partner's SFTP server. If you don't specify a `RemoteDirectoryPath`, the destination for transferred files is the SFTP user's home directory.
         */
        public var remoteDirectoryPath: kotlin.String? = null
        /**
         * One or more source paths for the partner's SFTP server. Each string represents a source file path for one inbound file transfer.
         */
        public var retrieveFilePaths: List? = null
        /**
         * One or more source paths for the Amazon S3 storage. Each string represents a source file path for one outbound file transfer. For example, ` DOC-EXAMPLE-BUCKET/myfile.txt `.
         *
         * Replace ` DOC-EXAMPLE-BUCKET ` with one of your actual buckets.
         */
        public var sendFilePaths: List? = null

        @PublishedApi
        internal constructor()
        @PublishedApi
        internal constructor(x: aws.sdk.kotlin.services.transfer.model.StartFileTransferRequest) : this() {
            this.connectorId = x.connectorId
            this.localDirectoryPath = x.localDirectoryPath
            this.remoteDirectoryPath = x.remoteDirectoryPath
            this.retrieveFilePaths = x.retrieveFilePaths
            this.sendFilePaths = x.sendFilePaths
        }

        @PublishedApi
        internal fun build(): aws.sdk.kotlin.services.transfer.model.StartFileTransferRequest = StartFileTransferRequest(this)

        internal fun correctErrors(): Builder {
            return this
        }
    }
}