timeseries
This section covers the Timeseries class, for defining and configuring timeseries, and the Timeseries Finder class, for looking up timeseries by organization.
Subsections of timeseries
Timeseries
This object represents a timeseries and exposes all the attributes you can configure for it.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
onlyPlan()
Mark timeseries as plan only
Retorna
Tip
Tipo: Timeseries
optimizationPlan()
Request optimization plan
Retorna
Tip
Tipo: Promise
withBucketColumn(bucketColumn)
Name of generated column with bucket date.Required if timeBucket > 0.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| bucketColumn | string |
❌ | pattern: ^[a-zA-Z0-9 _-]*$ |
Retorna
Tip
Tipo: Timeseries
withBucketInitColumn(bucketInitColumn)
Name of generated column with bucket init date.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| bucketInitColumn | string |
❌ | pattern: ^[a-zA-Z0-9 _-]*$ |
Retorna
Tip
Tipo: Timeseries
withColumns(columns)
List of data that is needed for each entity.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| columns | array |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
withContext(context)
List of data that is needed for each entity.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| context | array |
❌ |
Retorna
Tip
Tipo: Timeseries
withDescription(description)
Long text to explain timeserie definition
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| description | string |
❌ |
Retorna
Tip
Tipo: Timeseries
withIdentifier(identifier)
Set the identifier attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifier | string |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
withIdentifierColumn(identifierColumn)
Set the identifierColumn attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| identifierColumn | string |
❌ | required field |
Retorna
Tip
Tipo: Datasets
withName(name)
Name which will be unique in each organization
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| name | string |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
withOrganization(organization)
Set the organization attribute
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
withOrigin(origin)
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
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| origin | string |
❌ |
Retorna
Tip
Tipo: Timeseries
withRetention(retention)
Time that a row is stored to be got in searching. Default value is 1 month
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| retention | number |
❌ |
Retorna
Tip
Tipo: Timeseries
withSorts(sorts)
List of sorting fields
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| sorts | array |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
withTimeBucket(timeBucket)
Duration of buckets in seconds.
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| timeBucket | integer |
❌ | required field |
Retorna
Tip
Tipo: Timeseries
Timeseries Finder
This class performs GET requests against the timeseries resource in the OpenGate North API.
constructor
Constructor
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| ogapi | InternalOpenGateAPI |
❌ | Reference to the API object. |
findByOrganization(organization, expand, dataStreams)
Performs a get that returns list of timeseries
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| expand | Array |
❌ | ['columns', 'context'] |
| dataStreams | Array |
❌ | ["ds_id_1","ds_id_2"] |
Retorna
Tip
Tipo: Promise
findByOrganizationAndName(organization, name)
Performs a get that returns a definition of timeserie
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| name | string |
❌ | timeserie name |
Retorna
Tip
Tipo: Promise
findByOrganizationAndTimeserieId(organization, timeserieId)
Performs a get that returns a definition of timeserie
Parámetros
| Nombre | Tipo | Opcional | Descripción |
|---|---|---|---|
| organization | string |
❌ | organization |
| timeserieId | string |
❌ | timeserie identifier |
Retorna
Tip
Tipo: Promise