kotlin-client/com.couchbase.client.kotlin.manager.collection/CollectionSpec

CollectionSpec

class CollectionSpec(scopeName: String, name: String, maxExpiry: Duration?, history: Boolean?)

Information about a collection.

Constructors

CollectionSpec

~~fun~~ ~~CollectionSpec~~(~~scopeName~~: String, ~~name~~: String, ~~maxExpiry~~: Duration? = ~~null~~)

CollectionSpec

fun CollectionSpec(scopeName: String, name: String, maxExpiry: Duration? = null, history: Boolean? = null)

Types

Companion

object Companion

Functions

copy

~~fun~~ ~~copy~~(~~scopeName~~: String = ~~this.scopeName~~, ~~name~~: String = ~~this.name~~, ~~maxExpiry~~: Duration? = ~~this.maxExpiry~~): CollectionSpec

fun copy(scopeName: String = this.scopeName, name: String = this.name, maxExpiry: Duration? = this.maxExpiry, history: Boolean? = this.history): CollectionSpec

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

history

val history: Boolean? = null

maxExpiry

val maxExpiry: Duration? = null

Maximum expiry for documents in the collection. Null means the collection's max expiry is always the same as the bucket's max expiry. A duration equal to NEVER_EXPIRE (-1 seconds) means documents in the collection never expire, regardless of the bucket's max expiry.

name

val name: String

Name of the collection

scopeName

val scopeName: String

Name of the parent scope