Package eu.binjr.sources.netdata.api

Class Chart

java.lang.Object
eu.binjr.sources.netdata.api.Chart
public class Chart extends Object
Chart

  • Field Details

  • Constructor Details

    • Chart

      public Chart()

  • Method Details

    • id

      public Chart id(String id)

    • getId

      public String getId()
      The unique id of the chart.
      Returns:
      id

    • setId

      public void setId(String id)

    • name

      public Chart name(String name)

    • getName

      public String getName()
      The name of the chart.
      Returns:
      name

    • setName

      public void setName(String name)

    • type

      public Chart type(String type)

    • getType

      public String getType()
      The type of the chart. Types are not handled by netdata. You can use this field for anything you like.
      Returns:
      type

    • setType

      public void setType(String type)

    • family

      public Chart family(String family)

    • getFamily

      public String getFamily()
      The family of the chart. Families are not handled by netdata. You can use this field for anything you like.
      Returns:
      family

    • setFamily

      public void setFamily(String family)

    • title

      public Chart title(String title)

    • getTitle

      public String getTitle()
      The title of the chart.
      Returns:
      title

    • setTitle

      public void setTitle(String title)

    • priority

      public Chart priority(BigDecimal priority)

    • getPriority

      public BigDecimal getPriority()
      The relative priority of the chart. NetData does not care about priorities. This is just an indication of importance for the chart viewers to sort charts of higher priority (lower number) closer to the top. Priority sorting should only be used among charts of the same type or family.
      Returns:
      priority

    • setPriority

      public void setPriority(BigDecimal priority)

    • enabled

      public Chart enabled(Boolean enabled)

    • getEnabled

      public Boolean getEnabled()
      True when the chart is enabled. Disabled charts do not currently collect values, but they may have historical values available.
      Returns:
      enabled

    • setEnabled

      public void setEnabled(Boolean enabled)

    • units

      public Chart units(String units)

    • getUnits

      public String getUnits()
      The unit of measurement for the values of all dimensions of the chart.
      Returns:
      units

    • setUnits

      public void setUnits(String units)

    • dataUrl

      public Chart dataUrl(String dataUrl)

    • getDataUrl

      public String getDataUrl()
      The absolute path to get data values for this chart. You are expected to use this path as the base when constructing the URL to fetch data values for this chart.
      Returns:
      dataUrl

    • setDataUrl

      public void setDataUrl(String dataUrl)

    • chartType

      public Chart chartType(Chart.ChartTypeEnum chartType)

    • getChartType

      public Chart.ChartTypeEnum getChartType()
      The chart type.
      Returns:
      chartType

    • setChartType

      public void setChartType(Chart.ChartTypeEnum chartType)

    • duration

      public Chart duration(BigDecimal duration)

    • getDuration

      public BigDecimal getDuration()
      The duration, in seconds, of the round robin database maintained by netdata.
      Returns:
      duration

    • setDuration

      public void setDuration(BigDecimal duration)

    • firstEntry

      public Chart firstEntry(BigDecimal firstEntry)

    • getFirstEntry

      public BigDecimal getFirstEntry()
      The UNIX timestamp of the first entry (the oldest) in the round robin database.
      Returns:
      firstEntry

    • setFirstEntry

      public void setFirstEntry(BigDecimal firstEntry)

    • lastEntry

      public Chart lastEntry(BigDecimal lastEntry)

    • getLastEntry

      public BigDecimal getLastEntry()
      The UNIX timestamp of the latest entry in the round robin database.
      Returns:
      lastEntry

    • setLastEntry

      public void setLastEntry(BigDecimal lastEntry)

    • updateEvery

      public Chart updateEvery(BigDecimal updateEvery)

    • getUpdateEvery

      public BigDecimal getUpdateEvery()
      The update frequency of this chart, in seconds. One value every this amount of time is kept in the round robin database.
      Returns:
      updateEvery

    • setUpdateEvery

      public void setUpdateEvery(BigDecimal updateEvery)

    • dimensions

      public Chart dimensions(Map<String,ChartDimensions> dimensions)

    • putDimensionsItem

      public Chart putDimensionsItem(String key, ChartDimensions dimensionsItem)

    • getDimensions

      public Map<String,ChartDimensions> getDimensions()
      An object containing all the chart dimensions available for the chart. This is used as an indexed array. For each pair in the dictionary: the key is the id of the dimension and the value is a dictionary containing the name.
      Returns:
      dimensions

    • setDimensions

      public void setDimensions(Map<String,ChartDimensions> dimensions)

    • green

      public Chart green(BigDecimal green)

    • getGreen

      public BigDecimal getGreen()
      Chart health green threshold.
      Returns:
      green

    • setGreen

      public void setGreen(BigDecimal green)

    • red

      public Chart red(BigDecimal red)

    • getRed

      public BigDecimal getRed()
      Chart health red threshold.
      Returns:
      red

    • setRed

      public void setRed(BigDecimal red)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object