algoliasearch-scala
API
Generated with
algoliasearch-scala/algoliasearch/algoliasearch.monitoring

algoliasearch.monitoring

package algoliasearch.monitoring

Members list

Type members

Classlikes

case class ErrorBase(message: Option[String], additionalProperties: Option[List[JField]])

Error.

Error.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class ErrorBaseSerializer extends Serializer[ErrorBase]

Attributes

Supertypes
trait Serializer[ErrorBase]
class Object
trait Matchable
class Any
case class GetInventory403Response(reason: Option[String])

GetInventory403Response

GetInventory403Response

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Incident(title: Option[String], status: Option[Status])

Incident details.

Incident details.

Value parameters

title

Description of the incident.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IncidentsInner(t: Option[Long], v: Option[Incident])

IncidentsInner

IncidentsInner

Value parameters

t

Timestamp in Unix epoch time in milliseconds.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IncidentsResponse(incidents: Option[Map[String, Seq[IncidentsInner]]])

IncidentsResponse

IncidentsResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IndexingTimeResponse(metrics: Option[IndexingTimeResponseMetrics])

IndexingTimeResponse

IndexingTimeResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class IndexingTimeResponseMetrics(indexing: Option[Map[String, Seq[TimeInner]]])

IndexingTimeResponseMetrics

IndexingTimeResponseMetrics

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InfrastructureResponse(metrics: Option[InfrastructureResponseMetrics])

InfrastructureResponse

InfrastructureResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InfrastructureResponseMetrics(cpuUsage: Option[Map[String, Seq[ProbesMetric]]], ramIndexingUsage: Option[Map[String, Seq[ProbesMetric]]], ramSearchUsage: Option[Map[String, Seq[ProbesMetric]]], ssdUsage: Option[Map[String, Seq[ProbesMetric]]], avgBuildTime: Option[Map[String, Seq[ProbesMetric]]])

InfrastructureResponseMetrics

InfrastructureResponseMetrics

Value parameters

avgBuildTime

Average build time of the indices in seconds.

cpuUsage

CPU idleness in %.

ramIndexingUsage

RAM used for indexing in MB.

ramSearchUsage

RAM used for search in MB.

ssdUsage

Solid-state disk (SSD) usage expressed as % of RAM. 0% means no SSD usage. A value of 50% indicates 32 GB SSD usage for a machine with 64 RAM.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class InventoryResponse(inventory: Option[Seq[Server]])

InventoryResponse

InventoryResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object JsonSupport

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class LatencyResponse(metrics: Option[LatencyResponseMetrics])

LatencyResponse

LatencyResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class LatencyResponseMetrics(latency: Option[Map[String, Seq[TimeInner]]])

LatencyResponseMetrics

LatencyResponseMetrics

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Metric

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object AvgBuildTime.type
object CpuUsage.type
object RamIndexingUsage.type
object RamSearchUsage.type
object SsdUsage.type
object Star.type
Show all
object Metric

Metric enumeration

Metric enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Metric.type
class MetricSerializer extends CustomSerializer[Metric]

Attributes

Supertypes
class CustomSerializer[Metric]
trait Serializer[Metric]
class Object
trait Matchable
class Any
sealed trait ModelType

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Cluster.type
object ModelType

ModelType enumeration

ModelType enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ModelType.type
class ModelTypeSerializer extends CustomSerializer[ModelType]

Attributes

Supertypes
class CustomSerializer[ModelType]
trait Serializer[ModelType]
class Object
trait Matchable
class Any
sealed trait Period

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Day.type
object Hour.type
object Minute.type
object Month.type
object Week.type
object Period

Period enumeration

Period enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Period.type
class PeriodSerializer extends CustomSerializer[Period]

Attributes

Supertypes
class CustomSerializer[Period]
trait Serializer[Period]
class Object
trait Matchable
class Any
case class ProbesMetric(t: Option[Long], v: Option[Int])

ProbesMetric

ProbesMetric

Value parameters

t

Timestamp in Unix epoch time in milliseconds.

v

Value of the metric.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait Region

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Au.type
object Br.type
object Ca.type
object De.type
object Eu.type
object Hk.type
object In.type
object Jp.type
object Sg.type
object Uae.type
object Uk.type
object Usc.type
object Use.type
object Usw.type
object Za.type
Show all
object Region

The region where the cluster is located.

The region where the cluster is located.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Region.type
class RegionSerializer extends CustomSerializer[Region]

Attributes

Supertypes
class CustomSerializer[Region]
trait Serializer[Region]
class Object
trait Matchable
class Any
case class Server(name: Option[String], region: Option[Region], isSlave: Option[Boolean], isReplica: Option[Boolean], cluster: Option[String], status: Option[ServerStatus], `type`: Option[ModelType])

Server

Server

Value parameters

cluster

Name of the cluster to which this server belongs.

isReplica

Indicates whether this server is a replica of another server.

isSlave

Included to support legacy applications. Do not rely on this attribute being present in the response. Use is_replica instead.

name

Server name.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait ServerStatus

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object PRODUCTION.type
object ServerStatus

ServerStatus enumeration

ServerStatus enumeration

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
class ServerStatusSerializer extends CustomSerializer[ServerStatus]

Attributes

Supertypes
class CustomSerializer[ServerStatus]
trait Serializer[ServerStatus]
class Object
trait Matchable
class Any
sealed trait Status

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DegradedPerformance.type
object MajorOutage.type
object Operational.type
object PartialOutage.type
object Status

Status of the cluster.

Status of the cluster.

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Status.type
case class StatusResponse(status: Option[Map[String, Status]])

StatusResponse

StatusResponse

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
class StatusSerializer extends CustomSerializer[Status]

Attributes

Supertypes
class CustomSerializer[Status]
trait Serializer[Status]
class Object
trait Matchable
class Any
case class TimeInner(t: Option[Long], v: Option[Int])

TimeInner

TimeInner

Value parameters

t

Timestamp in Unix epoch time in milliseconds.

v

Time in ms.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Generated with