Package com.mongodb.client.model

Class CreateIndexOptions

  • public class CreateIndexOptions
extends Object
    The options to apply to the command when creating indexes.
    Since:
    3.6
    MongoDB documentation
    Index options

    • 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

      • getCommitQuorum

        @Nullable
public CreateIndexCommitQuorum getCommitQuorum()
        Gets the create index commit quorum for this operation.
        Returns:
        the create index commit quorum
        Since:
        4.1
        Since server release
        4.4

      • commitQuorum

        public CreateIndexOptions commitQuorum​(CreateIndexCommitQuorum commitQuorum)
        Sets the create index commit quorum for this operation.
        Parameters:
        commitQuorum - the create index commit quorum
        Returns:
        this
        Since:
        4.1
        Since server release
        4.4