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

Class CollectionSpec

java.lang.Object

com.couchbase.client.java.manager.collection.CollectionSpec

public class CollectionSpec
extends Object

The CollectionSpec describes properties of a collection that can be managed.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	NEVER_EXPIRE	A special collection "max expiry" value that means documents in the collection never expire, regardless of the bucket's max expiry setting.
static final Duration	SAME_EXPIRY_AS_BUCKET	A special collection "max expiry" value that means the collection's max expiry is always the same as the bucket's max expiry.

Method Summary

Modifier and Type	Method	Description
static CollectionSpec	create(String name)	Creates a new CollectionSpec using the default scope.
static CollectionSpec	create(String name, String scopeName)	Creates a new CollectionSpec with default properties.
static CollectionSpec	create(String name, String scopeName, Duration maxExpiry)	Creates a new CollectionSpec with a custom max expiry.
static CollectionSpec	create(String name, Duration maxExpiry)	Creates a new CollectionSpec with a custom max expiry on the default scope.
boolean	equals(Object o)
int	hashCode()
Boolean	history()	whether history retention is enabled on this collection.
protected static CollectionSpec	internalCreate(String name, String scopeName, Duration maxExpiry, Boolean history)	Creates a new CollectionSpec with a custom max expiry.
Duration	maxExpiry()	The max expiry for documents in this collection, or a non-positive duration indicating special expiry behavior.
String	name()	The name of the collection.
String	scopeName()	The name of the parent scope.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

SAME_EXPIRY_AS_BUCKET

@Volatile
public static final Duration SAME_EXPIRY_AS_BUCKET

A special collection "max expiry" value that means the collection's max expiry is always the same as the bucket's max expiry.

Use the bucket management API to discover the actual expiry value.

NEVER_EXPIRE

@SinceCouchbase("7.6")
@Volatile
public static final Duration NEVER_EXPIRE

A special collection "max expiry" value that means documents in the collection never expire, regardless of the bucket's max expiry setting.

Requires Couchbase Server 7.6 or later.

Method Details

create

public static CollectionSpec create(String name)

Creates a new CollectionSpec using the default scope.

Parameters:

name - the name of the collection.

Returns:

the created CollectionSpec.

create

public static CollectionSpec create(String name,
 String scopeName)

Creates a new CollectionSpec with default properties.

Parameters:

name - the name of the collection.

scopeName - the name of the parent scope.

Returns:

the created CollectionSpec.

create

@Volatile
public static CollectionSpec create(String name,
 Duration maxExpiry)

Creates a new CollectionSpec with a custom max expiry on the default scope.

Parameters:

name - the name of the collection.

maxExpiry - the maximum expiry (ttl) to use for this collection.

Returns:

the created CollectionSpec.

create

@Volatile
public static CollectionSpec create(String name,
 String scopeName,
 Duration maxExpiry)

Creates a new CollectionSpec with a custom max expiry.

Parameters:

name - the name of the collection.

scopeName - the name of the parent scope.

maxExpiry - the maximum expiry (ttl) to use for this collection.

Returns:

the created CollectionSpec.

internalCreate

@Volatile
@Internal
protected static CollectionSpec internalCreate(String name,
 String scopeName,
 Duration maxExpiry,
 Boolean history)

Creates a new CollectionSpec with a custom max expiry.

Parameters:

name - the name of the collection.

scopeName - the name of the parent scope.

maxExpiry - the maximum expiry (ttl) to use for this collection.

history - whether history retention is enabled on this collection.

Returns:

the created CollectionSpec.

name

public String name()

The name of the collection.

scopeName

public String scopeName()

The name of the parent scope.

maxExpiry

@Volatile
public Duration maxExpiry()

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

See Also:

• SAME_EXPIRY_AS_BUCKET
• NEVER_EXPIRE

history

@Volatile
public Boolean history()

whether history retention is enabled on this collection.

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object