import TimeserieDownsamplerBuilder from 'opengate-js/src/searching/builder/TimeserieDownsamplerBuilder.js'

public class | source

TimeserieDownsamplerBuilder

Extends:

SearchBuilder → TimeserieDownsamplerBuilder

Defined a search over timeseries

Example:

ogapi.timeserieDownsamplerBuilder(organization, timeserieId)

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Method Summary

Public Methods
public	addColumn(name: string, interpolation: string, aggregation: string, alias: string): TimeserieDownsamplerBuilder Add column that will be requested
public	bucketTime(bucketTime: number): TimeserieDownsamplerBuilder The bucket for the downsampling (must be higher than the time series bucket)
public	build(): Search Build a instance of Search
public	columns(columns: array): TimeserieDownsamplerBuilder Add columns that will be requested
public	filter()
public	findFields()
public	select(select: object): TimeserieDownsamplerBuilder The search request will have this select
public	sort()
public	start(start: string): TimeserieDownsamplerBuilder The start time for the downsampling

Inherited Summary

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

SearchBuilder#constructor

Params:

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

Public Methods

public addColumn(name: string, interpolation: string, aggregation: string, alias: string): TimeserieDownsamplerBuilder source

Add column that will be requested

Params:

Name	Type	Attribute	Description
name	string
interpolation	string
aggregation	string
alias	string

Return:

TimeserieDownsamplerBuilder

public bucketTime(bucketTime: number): TimeserieDownsamplerBuilder source

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

Params:

Name	Type	Attribute	Description
bucketTime	number

Return:

TimeserieDownsamplerBuilder

public build(): Search source

Build a instance of Search

Override:

SearchBuilder#build

Return:

Throw:

SearchBuilderError

Throw error on url build

Example:

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

public columns(columns: array): TimeserieDownsamplerBuilder source

Add columns that will be requested

Params:

Name	Type	Attribute	Description
columns	array

Return:

TimeserieDownsamplerBuilder

public filter() source

The search request will have this filter

Override:

SearchBuilder#filter

public findFields() source

Return a promise which it will contains an array with fields recommended with only identifier

Override:

SearchBuilder#findFields

public select(select: object): TimeserieDownsamplerBuilder source

The search request will have this select

Params:

Name	Type	Attribute	Description
select	object

Return:

TimeserieDownsamplerBuilder

public sort() source

public start(start: string): TimeserieDownsamplerBuilder source

The start time for the downsampling

Params:

Name	Type	Attribute	Description
start	string

Return:

TimeserieDownsamplerBuilder