S3CompatibleStorage

S3 Compatible Artifact Storage

Example. Adds new storage that allows TeamCity to store build artifacts in S3

project {
    // Other Project settings ...
    features {
        // Other Project Features ...
        s3CompatibleStorage {
          id = "S3_STORAGE_ID"
          storageName = "Storage Name"
          bucketName = "Bucket Name"
          bucketPrefix = "path/prefix"

          forceVirtualHostAddressing = true
          verifyIntegrityAfterUpload = false

          multipartThreshold = "8MB"
          multipartChunksize = "8MB"

          // Endpoint is required:
          endpoint = "https://s3-compatible-endpoint.com"
          // Storage also requires configured Credentials
          accessKeyID = "Access key ID"
          accessKey = "credentialsJSON:link-to-property-containing-access-key"
        }
















} }

See also

Constructors

Link copied to clipboard
constructor(init: S3CompatibleStorage.() -> Unit)
constructor()

Properties

Link copied to clipboard
var accessKey: <Error class: unknown class>

Account secret access key

Link copied to clipboard
var accessKeyID: <Error class: unknown class>

Account access key ID

Link copied to clipboard
var bucketName: <Error class: unknown class>

Bucket name

Link copied to clipboard
var bucketPrefix: <Error class: unknown class>

Bucket path prefix

Link copied to clipboard
var enablePresignedURLUpload: <Error class: unknown class>

Whether to use Pre-Signed URLs to upload

Link copied to clipboard
var endpoint: <Error class: unknown class>

Endpoint URL

Link copied to clipboard
var forceVirtualHostAddressing: <Error class: unknown class>

Whether to force Virtual Host Addressing

Link copied to clipboard
var id: String?

Project feature id, if not specified will be generated

Link copied to clipboard
var multipartChunksize: <Error class: unknown class>

Specify the maximum allowed part size. Minimum value is 5MB. Allowed suffixes: KB, MB, GB, TB. Leave empty to use the default value.

Link copied to clipboard
var multipartThreshold: <Error class: unknown class>

Initiates multipart upload for files larger than the specified value. Minimum value is 5MB. Allowed suffixes: KB, MB, GB, TB. Leave empty to use the default value.

Link copied to clipboard
Link copied to clipboard
var storageName: <Error class: unknown class>

Storage name

Link copied to clipboard

Project feature type

Link copied to clipboard
var verifyIntegrityAfterUpload: <Error class: unknown class>

Whether to verify integrity of artifacts after upload

Functions

Link copied to clipboard
fun booleanParameter(    customName: String? = null,     trueValue: String? = "true",     falseValue: String? = "false"): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun clear()
Link copied to clipboard
fun <T : CompoundParam<T>> compoundParameter(    customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <T : Parametrized> copyParamsTo(target: T): T

Copies parameters of this object to the specified target

Link copied to clipboard

Creates an instance of this project feature 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.

Link copied to clipboard
fun doubleParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun <E : Enum<E>> enumParameter(    customName: String? = null,     mapping: Map<E, String?>? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun findRawParam(paramName: String): Parameter?
Link copied to clipboard
fun hasParam(paramName: String): Boolean
Link copied to clipboard
fun intParameter(customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
fun param(name: String, value: String)

Adds parameter with specified name and value

Link copied to clipboard
fun removeRawParam(paramName: String)
Link copied to clipboard
open fun stringParameter(    customName: String? = null): <Error class: unknown class><Parametrized, <Error class: unknown class><Parametrized, T?>>
Link copied to clipboard
open override fun toString(): String
Link copied to clipboard
open override fun validate(consumer: ErrorConsumer)

Validates this object and reports found errors to the provided consumer