Packages

c

scalograf.client

GrafanaClient

case class GrafanaClient[F[_]](config: GrafanaConfig, backend: SttpBackend[F, Any]) extends FolderApi[F] with Product with Serializable

Linear Supertypes
Serializable, Product, Equals, FolderApi[F], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GrafanaClient
  2. Serializable
  3. Product
  4. Equals
  5. FolderApi
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new GrafanaClient(config: GrafanaConfig, backend: SttpBackend[F, Any])

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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val backend: SttpBackend[F, Any]
  6. def clientContext(): GrafanaClientContext[F]
    Attributes
    protected[client]
    Definition Classes
    GrafanaClientFolderApi
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def close(): F[Unit]
  9. val config: GrafanaConfig
  10. def createDatasource(datasource: Datasource): F[Response[Either[ResponseException[ErrorResponse, Error], DatasourceCreateResponse]]]
  11. def createFolder(request: CreateFolderRequest): F[Response[Either[ResponseException[ErrorResponse, Error], Folder]]]

    Create folder

    request

    CreateFolderRequest

    returns

    response

    Definition Classes
    FolderApi
  12. def createNotificationChannel(channel: NotificationChannel): F[Response[Either[ResponseException[ErrorResponse, Error], NotificationChannel]]]
  13. def deleteFolder(uid: String): F[Response[Either[ResponseException[ErrorResponse, Error], Json]]]

    Delete folder

    uid

    current uid of folder

    returns

    response

    Definition Classes
    FolderApi
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  16. def getById(id: Long): F[Response[Either[ResponseException[ErrorResponse, Error], Folder]]]

    Get folder by id

    id

    id of folder

    returns

    response

    Definition Classes
    FolderApi
  17. def getByUid(uid: String): F[Response[Either[ResponseException[ErrorResponse, Error], Folder]]]

    Get folder by uid

    uid

    uid of folder

    returns

    response

    Definition Classes
    FolderApi
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  19. def getDashboard(uid: String): F[Response[Either[ResponseException[ErrorResponse, Error], GetDashboardResponse]]]
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. def listDataSources(): F[Response[Either[ResponseException[ErrorResponse, Error], Json]]]
  22. def listFolders(): F[Response[Either[ResponseException[ErrorResponse, Error], List[FolderInfo]]]]

    Get list of folders

    returns

    response

    Definition Classes
    FolderApi
  23. def listNotificationChannels(): F[Response[Either[ResponseException[ErrorResponse, Error], List[NotificationChannel]]]]

    * https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/#get-all-notification-channels

  24. def lookupNotificationChannels(): F[Response[Either[ResponseException[ErrorResponse, Error], List[NotificationChannel]]]]

    * https://grafana.com/docs/grafana/latest/http_api/alerting_notification_channels/#get-all-notification-channels-lookup

  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. def productElementNames: Iterator[String]
    Definition Classes
    Product
  29. def search(params: Map[String, String]): F[Response[Either[ResponseException[ErrorResponse, Error], Seq[DashboardSnippet]]]]

    Allow to add query parameters for a request.

    Allow to add query parameters for a request.

    e.g. https://grafana.com/docs/grafana/latest/http_api/folder_dashboard_search/

    params

    map of query parameters

    returns

    response

  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def updateFolder(uid: String, request: UpdateFolderRequest): F[Response[Either[ResponseException[ErrorResponse, Error], Folder]]]

    Update folder

    uid

    current uid of folder

    request

    UpdateFolderRequest

    returns

    response

    Definition Classes
    FolderApi
  32. def uploadDashboard(request: DashboardUploadRequest): F[Response[Either[ResponseException[ErrorResponse, Error], DashboardUploadResponse]]]
  33. val url: String
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  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()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from FolderApi[F]

Inherited from AnyRef

Inherited from Any

Ungrouped