Timeseries

Timeseries

Timeseries Objects

class Timeseries()

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

constructor
function constructor()

Constructor

Arguments:

  • Reference InternalOpenGateAPI - to the API object.
onlyPlan
function onlyPlan() -> '*'

Returns:

  • *
withBucketColumn
function withBucketColumn(bucketColumn: string) -> 'Timeseries'

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

Arguments:

  • bucketColumn string - pattern: ^[a-zA-Z0-9 _-]*$

Returns:

  • Timeseries
withBucketInitColumn
function withBucketInitColumn(bucketInitColumn: string) -> 'Timeseries'

Name of generated column with bucket init date.

Arguments:

  • bucketInitColumn string - pattern: ^[a-zA-Z0-9 _-]*$

Returns:

  • Timeseries
withColumns
function withColumns(columns: array) -> 'Timeseries'

List of data that is needed for each entity.

Arguments:

  • columns array - required field

Returns:

  • Timeseries
withContext
function withContext(context: array) -> 'Timeseries'

List of data that is needed for each entity.

Arguments:

  • context array

Returns:

  • Timeseries
withDescription
function withDescription(description: string) -> 'Timeseries'

Long text to explain timeserie definition

Arguments:

  • description string

Returns:

  • Timeseries
withIdentifier
function withIdentifier(identifier: string) -> 'Timeseries'

Set the identifier attribute

Arguments:

  • identifier string - required field

Returns:

  • Timeseries
withIdentifierColumn
function withIdentifierColumn(identifierColumn: string) -> 'Datasets'

Set the identifierColumn attribute

Arguments:

  • identifierColumn string - required field

Returns:

  • Datasets
withName
function withName(name: string) -> 'Timeseries'

Name which will be unique in each organization

Arguments:

  • name string - required field

Returns:

  • Timeseries
withOrganization
function withOrganization(organization: string) -> 'Timeseries'

Set the organization attribute

Arguments:

  • organization string - required field

Returns:

  • Timeseries
withOrigin
function withOrigin(origin: string) -> 'Timeseries'

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

Arguments:

  • origin string

Returns:

  • Timeseries
withRetention
function withRetention(retention: number) -> 'Timeseries'

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

Arguments:

  • retention number

Returns:

  • Timeseries
withTimeBucket
function withTimeBucket(timeBucket: integer) -> 'Timeseries'

Duration of buckets in seconds.

Arguments:

  • timeBucket integer - required field

Returns:

  • Timeseries