Package com.couchbase.client.java.manager.collection

Class CreateCollectionSettings

java.lang.Object

com.couchbase.client.java.manager.collection.CreateCollectionSettings

public class CreateCollectionSettings
extends Object

Allows to customize the behavior of the create collection operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	CreateCollectionSettings.Built

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	history
Duration	maxExpiry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CreateCollectionSettings()

Method Summary

Modifier and Type	Method	Description
CreateCollectionSettings.Built	build()
static CreateCollectionSettings	createCollectionSettings()	Creates a new instance with default values.
CreateCollectionSettings	history(Boolean history)
CreateCollectionSettings	maxExpiry(Duration maxExpiry)	The max expiry for documents in this collection, or a non-positive duration indicating special expiry behavior.
CoreCreateOrUpdateCollectionSettings	toCore()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

maxExpiry

public Duration maxExpiry

history

public Boolean history

Constructor Details

CreateCollectionSettings

protected CreateCollectionSettings()

Method Details

createCollectionSettings

public static CreateCollectionSettings createCollectionSettings()

Creates a new instance with default values.

Returns:

the instantiated default options.

maxExpiry

public CreateCollectionSettings maxExpiry(Duration maxExpiry)

The max expiry for documents in this collection, or a non-positive duration indicating special expiry behavior.

See Also:

• CollectionSpec.SAME_EXPIRY_AS_BUCKET
• CollectionSpec.NEVER_EXPIRE

history

public CreateCollectionSettings history(Boolean history)

build

@Internal
public CreateCollectionSettings.Built build()

toCore

@Internal
public CoreCreateOrUpdateCollectionSettings toCore()