Packages

class IndexApi extends CirceSchema

Linear Supertypes
CirceSchema, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. IndexApi
  2. CirceSchema
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new IndexApi(baseUrl: String)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit val AnyFormat: Encoder[Any] with Decoder[Any]
    Definition Classes
    CirceSchema
  5. implicit val ConfigFormat: Encoder[MongoCampConfiguration]
    Definition Classes
    CirceSchema
  6. implicit val DateFormat: Encoder[Date] with Decoder[Date]
    Definition Classes
    CirceSchema
  7. implicit val DateTimeFormat: Encoder[DateTime] with Decoder[DateTime]
    Definition Classes
    CirceSchema
  8. implicit val MapStringAnyFormat: Encoder[Map[String, Any]] with Decoder[Map[String, Any]]
    Definition Classes
    CirceSchema
  9. implicit val ObjectIdFormat: Encoder[ObjectId] with Decoder[ObjectId]
    Definition Classes
    CirceSchema
  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  12. def createExpiringIndex(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, fieldName: String, duration: String, sortAscending: Option[Boolean] = None, name: Option[String] = None): RequestT[Identity, Either[ResponseException[String, Error], IndexCreateResponse], Any with Any]

    Create expiring Index by Field for given Collection

    Create expiring Index by Field for given Collection

    Expected answers: code 200 : IndexCreateResponse () code 400 : String (Invalid value for: query parameter sortAscending, Invalid value for: query parameter name) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    fieldName

    The field Name for your index

    duration

    Expiring Duration in format 15d (https://www.scala-lang.org/api/2.13.7/scala/concurrent/duration/Duration.html)

    sortAscending

    Sort your index ascending

    name

    Name for your index

  13. def createIndex(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, indexCreateRequest: IndexCreateRequest): RequestT[Identity, Either[ResponseException[String, Error], IndexCreateResponse], Any with Any]

    Create Index for given Collection

    Create Index for given Collection

    Expected answers: code 200 : IndexCreateResponse () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

  14. def createIndexForField(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, fieldName: String, sortAscending: Option[Boolean] = None, indexOptionsRequest: Option[IndexOptionsRequest] = None): RequestT[Identity, Either[ResponseException[String, Error], IndexCreateResponse], Any with Any]

    Create Index by Field for given Collection

    Create Index by Field for given Collection

    Expected answers: code 200 : IndexCreateResponse () code 400 : String (Invalid value for: query parameter sortAscending, Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    fieldName

    The field Name for your index

    sortAscending

    Sort your index ascending

  15. def createTextIndex(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, fieldName: String, indexOptionsRequest: Option[IndexOptionsRequest] = None): RequestT[Identity, Either[ResponseException[String, Error], IndexCreateResponse], Any with Any]

    Create text index by field for given collection

    Create text index by field for given collection

    Expected answers: code 200 : IndexCreateResponse () code 400 : String (Invalid value for: body) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    fieldName

    The field Name for your index

  16. def createUniqueIndex(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, fieldName: String, sortAscending: Option[Boolean] = None, name: Option[String] = None): RequestT[Identity, Either[ResponseException[String, Error], IndexCreateResponse], Any with Any]

    Create Unique Index by Field for given Collection

    Create Unique Index by Field for given Collection

    Expected answers: code 200 : IndexCreateResponse () code 400 : String (Invalid value for: query parameter sortAscending, Invalid value for: query parameter name) code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    fieldName

    The field Name for your index

    sortAscending

    Sort your index ascending

    name

    Name for your index

  17. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  18. def deleteIndex(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, indexName: String): RequestT[Identity, Either[ResponseException[String, Error], IndexDropResponse], Any with Any]

    Delete Index by Name for given Collection

    Delete Index by Name for given Collection

    Expected answers: code 200 : IndexDropResponse () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    indexName

    The name of your Index

  19. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  20. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  21. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  23. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def index(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, indexName: String): RequestT[Identity, Either[ResponseException[String, Error], MongoIndex], Any with Any]

    Index by Name for given Collection

    Index by Name for given Collection

    Expected answers: code 200 : MongoIndex () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

    indexName

    The name of your Index

  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def listIndices(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String): RequestT[Identity, Either[ResponseException[String, Error], Seq[MongoIndex]], Any with Any]

    List all Indices for given Collection

    List all Indices for given Collection

    Expected answers: code 200 : Seq[MongoIndex] () code 0 : ErrorDescription () Headers : x-error-code - Error Code x-error-message - Message of the MongoCampException x-error-additional-info - Additional information for the MongoCampException

    Available security schemes: httpAuth1 (http) httpAuth (http) apiKeyAuth (apiKey)

    collectionName

    The name of your MongoDb Collection

  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  32. def toString(): String
    Definition Classes
    AnyRef → Any
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  35. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from CirceSchema

Inherited from AnyRef

Inherited from Any

Ungrouped