Timeserie Downsampler Builder

TimeserieDownsamplerBuilder

TimeserieDownsamplerBuilder Objects

class TimeserieDownsamplerBuilder()

Defined a search over timeseries

constructor
function constructor()

Arguments:

  • parent InternalOpenGateAPI - Instance of our InternalOpenGateAPI

addColumn
function addColumn(name: string,interpolation: string,aggregation: string,alias: string) -> 'TimeserieDownsamplerBuilder'

Add column that will be requested

Arguments:

  • name string
  • interpolation string
  • aggregation string
  • alias string

Returns:

  • TimeserieDownsamplerBuilder

bucketTime
function bucketTime(bucketTime: number) -> 'TimeserieDownsamplerBuilder'

The bucket for the downsampling (must be higher than the time series bucket)

Arguments:

  • bucketTime number

Returns:

  • TimeserieDownsamplerBuilder

build
function build() -> 'Search'

Build a instance of Search

Returns:

  • Search

Example:

 ogapi.timeserieDownsamplerBuilder(organization, timeserieId).build()

columns
function columns(columns: array) -> 'TimeserieDownsamplerBuilder'

Add columns that will be requested

Arguments:

  • columns array

Returns:

  • TimeserieDownsamplerBuilder

filter
function filter()

findFields
function findFields()

select
function select(select: object) -> 'TimeserieDownsamplerBuilder'

The search request will have this select

Arguments:

  • select object

Returns:

  • TimeserieDownsamplerBuilder

sort
function sort()

start
function start(start: string) -> 'TimeserieDownsamplerBuilder'

The start time for the downsampling

Arguments:

  • start string

Returns:

  • TimeserieDownsamplerBuilder