import Timeseries from 'opengate-js/src/timeseries/Timeseries.js'

public class | source

Timeseries

Extends:

BaseProvision → Timeseries

This is a base object that contains all you can do about Timeseries.

Constructor Summary

Public Constructor
public	constructor(Reference: InternalOpenGateAPI) Constructor

Method Summary

Public Methods
public	onlyPlan(): *
public	withBucketColumn(bucketColumn: string): Timeseries Name of generated column with bucket date.Required if timeBucket > 0.
public	withBucketInitColumn(bucketInitColumn: string): Timeseries Name of generated column with bucket init date.
public	withColumns(columns: array): Timeseries List of data that is needed for each entity.
public	withContext(context: array): Timeseries List of data that is needed for each entity.
public	withDescription(description: string): Timeseries Long text to explain timeserie definition
public	withIdentifier(identifier: string): Timeseries Set the identifier attribute
public	withIdentifierColumn(identifierColumn: string): Datasets Set the identifierColumn attribute
public	withName(name: string): Timeseries Name which will be unique in each organization
public	withOrganization(organization: string): Timeseries Set the organization attribute
public	withOrigin(origin: string): Timeseries Initial date to first bucket with ISO date time format.
public	withRetention(retention: number): Timeseries Time that a row is stored to be got in searching.
public	withTimeBucket(timeBucket: integer): Timeseries Duration of buckets in seconds.

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(Reference: InternalOpenGateAPI) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
Reference	InternalOpenGateAPI		to the API object.

Public Methods

public onlyPlan(): * source

Return:

public withBucketColumn(bucketColumn: string): Timeseries source

Name of generated column with bucket date.Required if timeBucket > 0.

Params:

Name	Type	Attribute	Description
bucketColumn	string		pattern: ^[a-zA-Z0-9 _-]*$

Return:

Timeseries

public withBucketInitColumn(bucketInitColumn: string): Timeseries source

Name of generated column with bucket init date.

Params:

Name	Type	Attribute	Description
bucketInitColumn	string		pattern: ^[a-zA-Z0-9 _-]*$

Return:

Timeseries

public withColumns(columns: array): Timeseries source

List of data that is needed for each entity.

Params:

Name	Type	Attribute	Description
columns	array		required field

Return:

Timeseries

public withContext(context: array): Timeseries source

List of data that is needed for each entity.

Params:

Name	Type	Attribute	Description
context	array

Return:

Timeseries

public withDescription(description: string): Timeseries source

Long text to explain timeserie definition

Params:

Name	Type	Attribute	Description
description	string

Return:

Timeseries

public withIdentifier(identifier: string): Timeseries source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string		required field

Return:

Timeseries

public withIdentifierColumn(identifierColumn: string): Datasets source

Set the identifierColumn attribute

Params:

Name	Type	Attribute	Description
identifierColumn	string		required field

Return:

Datasets

public withName(name: string): Timeseries source

Name which will be unique in each organization

Params:

Name	Type	Attribute	Description
name	string		required field

Return:

Timeseries

public withOrganization(organization: string): Timeseries source

Set the organization attribute

Params:

Name	Type	Attribute	Description
organization	string		required field

Return:

Timeseries

public withOrigin(origin: string): Timeseries source

Initial date to first bucket with ISO date time format. Next bucket will be calcullated from this date. Default value is created date with time equals 00:00:00.000Z

Params:

Name	Type	Attribute	Description
origin	string

Return:

Timeseries

public withRetention(retention: number): Timeseries source

Time that a row is stored to be got in searching. Default value is 1 month

Params:

Name	Type	Attribute	Description
retention	number

Return:

Timeseries

public withTimeBucket(timeBucket: integer): Timeseries source

Duration of buckets in seconds.

Params:

Name	Type	Attribute	Description
timeBucket	integer		required field

Return:

Timeseries