Karbone/com.ekino.oss.karbone.model/UploadOptions

UploadOptions

data class UploadOptions(val id: TemplateId? = null, val versioning: Boolean = false, val name: String? = null, val comment: String? = null, val category: String? = null, val tags: List<String> = emptyList(), val expireAt: Instant? = null, val deployedAt: Instant? = null, val sample: TemplateSample? = null)

Metadata sent with POST /template. All optional; versioning-related fields are ignored by Community edition.

Constructors

constructor(id: TemplateId? = null, versioning: Boolean = false, name: String? = null, comment: String? = null, category: String? = null, tags: List<String> = emptyList(), expireAt: Instant? = null, deployedAt: Instant? = null, sample: TemplateSample? = null)

Types

object Companion

Properties

val category: String?

Category name, at most MAX_TEXT_LENGTH characters.

val comment: String?

Free-form comment, at most MAX_TEXT_LENGTH characters.

val deployedAt: Instant?

Deployment time used to pick the active version. null keeps the server default.

val expireAt: Instant?

Scheduled deletion. null means never.

val id: TemplateId?

Versioned mode: attach the upload as a new version of this template id.

val name: String?

Display name, at most MAX_TEXT_LENGTH characters.

val sample: TemplateSample?

Sample data stored alongside the template for Studio previews.

val tags: List<String>

Free-form tags used to search and filter templates.

val versioning: Boolean

Store the upload with version history instead of replacing the template in place.