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

Class UpdateCollectionSettings

java.lang.Object

com.couchbase.client.java.manager.collection.UpdateCollectionSettings

public class UpdateCollectionSettings
extends Object

Allows to customize the behavior of the update collection operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	UpdateCollectionSettings.Built

Field Summary

Fields

Modifier and Type	Field	Description
Boolean	history
Duration	maxExpiry

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UpdateCollectionSettings()

Method Summary

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

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

UpdateCollectionSettings

protected UpdateCollectionSettings()

Method Details

updateCollectionSettings

public static UpdateCollectionSettings updateCollectionSettings()

Creates a new instance with default values.

Returns:

the instantiated default options.

maxExpiry

public UpdateCollectionSettings 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 UpdateCollectionSettings history(Boolean history)

build

@Internal
public UpdateCollectionSettings.Built build()

toCore

@Internal
public CoreCreateOrUpdateCollectionSettings toCore()