Package com.mongodb.client.model

Class CreateIndexOptions

java.lang.Object

com.mongodb.client.model.CreateIndexOptions

public class CreateIndexOptions
extends Object

The options to apply to the command when creating indexes.

Since:

3.6

MongoDB documentation

Index options

Constructor Summary

Constructors

Constructor	Description
CreateIndexOptions()

Method Summary

Modifier and Type	Method	Description
long	getMaxTime(TimeUnit timeUnit)	Gets the maximum execution time on the server for this operation.
CreateIndexOptions	maxTime(long maxTime, TimeUnit timeUnit)	Sets the maximum execution time on the server for this operation.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateIndexOptions

public CreateIndexOptions()

Method Detail

getMaxTime

public long getMaxTime(TimeUnit timeUnit)

Gets the maximum execution time on the server for this operation. The default is 0, which places no limit on the execution time.

Parameters:

timeUnit - the time unit to return the result in

Returns:

the maximum execution time in the given time unit

maxTime

public CreateIndexOptions maxTime(long maxTime,
                                  TimeUnit timeUnit)

Sets the maximum execution time on the server for this operation.

Parameters:

maxTime - the max time

timeUnit - the time unit, which may not be null

Returns:

this

toString

public String toString()

Overrides:

toString in class Object