Package com.mongodb.client.model

Class IndexOptionDefaults

java.lang.Object

com.mongodb.client.model.IndexOptionDefaults

public final class IndexOptionDefaults
extends Object

The default options for a collection to apply on the creation of indexes.

Since:

3.2

MongoDB documentation

Create Collection

Index options

Since server release

3.2

Constructor Summary

Constructors

Constructor	Description
IndexOptionDefaults()

Method Summary

Modifier and Type	Method	Description
Bson	getStorageEngine()	Gets the default storage engine options document for indexes.
IndexOptionDefaults	storageEngine(Bson storageEngine)	Sets the default storage engine options document for indexes.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

IndexOptionDefaults

public IndexOptionDefaults()

Method Detail

getStorageEngine

@Nullable
public Bson getStorageEngine()

Gets the default storage engine options document for indexes.

Returns:

the storage engine options

storageEngine

public IndexOptionDefaults storageEngine(@Nullable
                                         Bson storageEngine)

Sets the default storage engine options document for indexes.

Parameters:

storageEngine - the storage engine options

Returns:

this

toString

public String toString()

Overrides:

toString in class Object