io.vertx.ext.mongo

## Class IndexModel

- java.lang.Object
- - io.vertx.ext.mongo.IndexModel

-     public class IndexModel
      extends Object

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `IndexModel(JsonObject key)` Construct an isntance with the given key
    `IndexModel(JsonObject key, IndexOptions options)`

  - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method and Description
    --- | ---
    `JsonObject` | `getKey()` Get the index key
    `IndexOptions` | `getOptions()` Get the index options
    `JsonObject` | `toJson()`
    `String` | `toString()`

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### IndexModel

          public IndexModel(JsonObject key)

      Construct an isntance with the given key
      Parameters:
        `key` - - the index key

    - #### IndexModel

          public IndexModel(JsonObject key,
                            IndexOptions options)

  - ### Method Detail

    - #### getKey

          public JsonObject getKey()

      Get the index key
      Returns:
        - the index keys

    - #### getOptions

          public IndexOptions getOptions()

      Get the index options
      Returns:
        - the index options

    - #### toJson

          public JsonObject toJson()

    - #### toString

          public String toString()

      Overrides:
        `toString` in class `Object`

Copyright © 2020 Eclipse. All rights reserved.