Packages

class CollectionApi extends CirceSchema

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

Instance Constructors

  1. new CollectionApi(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. def aggregate(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, mongoAggregateRequest: MongoAggregateRequest, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[Map[String, Any]]], Any with Any]

    Aggregate in a given Collection

    Aggregate in a given Collection

    Expected answers: code 200 : Seq[Map[String, String]] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: body, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) 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

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  11. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  12. def clearCollection(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Delete all Document in Collection

    Delete all Document in Collection

    Expected answers: code 200 : JsonValueBoolean () 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

  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def decodeFromJson(json: Json): Any
    Definition Classes
    CirceSchema
  15. def deleteCollection(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String): RequestT[Identity, Either[ResponseException[String, Error], JsonValueBoolean], Any with Any]

    Delete a given Collection

    Delete a given Collection

    Expected answers: code 200 : JsonValueBoolean () 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

  16. def distinct(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, field: String, rowsPerPage: Option[Long] = None, page: Option[Long] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[Any]], Any with Any]

    Distinct for Field in a given Collection

    Distinct for Field in a given Collection

    Expected answers: code 200 : Seq[String] () Headers : x-pagination-count-rows - count all elements x-pagination-rows-per-page - Count elements per page x-pagination-current-page - Current page x-pagination-count-pages - Count pages code 400 : String (Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page) 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

    field

    The field for your distinct Request.

    rowsPerPage

    Count elements per page

    page

    Requested page of the ResultSets

  17. def encodeAnyToJson(a: Any, deepth: Int): Json
    Definition Classes
    CirceSchema
  18. def encodeMapStringAny(a: Map[String, Any]): Json
    Definition Classes
    CirceSchema
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  22. def getCollectionFields(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, sampleSize: Option[Int] = None): RequestT[Identity, Either[ResponseException[String, Error], Seq[String]], Any with Any]

    List the Fields in a given collection

    List the Fields in a given collection

    Expected answers: code 200 : Seq[String] () code 400 : String (Invalid value for: query parameter sample size) 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

    sampleSize

    Use sample size greater 0 (e.g. 1000) for better performance on big collections

  23. def getCollectionInformation(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, includeDetails: Option[Boolean] = None): RequestT[Identity, Either[ResponseException[String, Error], CollectionStatus], Any with Any]

    All Information about a single Collection

    All Information about a single Collection

    Expected answers: code 200 : CollectionStatus () code 400 : String (Invalid value for: query parameter includeDetails) 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

    includeDetails

    Include all details for the Collection

  24. def getJsonSchema(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, sampleSize: Option[Int] = None, deepth: Option[Int] = None): RequestT[Identity, Either[ResponseException[String, Error], JsonSchema], Any with Any]

    List the Fields in a given collection

    List the Fields in a given collection

    Expected answers: code 200 : JsonSchema () code 400 : String (Invalid value for: query parameter sampleSize, Invalid value for: query parameter deepth) 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

    sampleSize

    Use sample size greater 0 (e.g. 5000) for better performance on big collections

    deepth

    How deep should the objects extracted

  25. def getSchemaAnalysis(username: String, password: String, bearerToken: String, apiKey: String)(collectionName: String, sampleSize: Option[Int] = None, deepth: Option[Int] = None): RequestT[Identity, Either[ResponseException[String, Error], SchemaAnalysis], Any with Any]

    List the Fields in a given collection

    List the Fields in a given collection

    Expected answers: code 200 : SchemaAnalysis () code 400 : String (Invalid value for: query parameter sampleSize, Invalid value for: query parameter deepth) 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

    sampleSize

    Use sample size greater 0 (e.g. 5000) for better performance on big collections

    deepth

    How deep should the objects extracted

  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def listCollections(username: String, password: String, bearerToken: String, apiKey: String)(): RequestT[Identity, Either[ResponseException[String, Error], Seq[String]], Any with Any]

    List of all Collections of the default database

    List of all Collections of the default database

    Expected answers: code 200 : Seq[String] () 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)

  29. def listCollectionsByDatabase(username: String, password: String, bearerToken: String, apiKey: String)(databaseName: String): RequestT[Identity, Either[ResponseException[String, Error], Seq[String]], Any with Any]

    List of all Collections of the given database

    List of all Collections of the given database

    Expected answers: code 200 : Seq[String] () 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)

    databaseName

    Name of your Database

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