Subsections of catalog

Category

Defines the builder used to configure a category of a datamodel, including the datastreams it groups.

constructor

Parámetros

Nombre Tipo Opcional Descripción
ogapi InternalOpenGateAPI ❌ Reference to the API object.
identifier identifier ❌ of category
datastreams Array ❌ of category

addDatastream(datastream)

Add a datastream to the category

Parámetros

Nombre Tipo Opcional Descripción
datastream Object ❌ json object

Retorna

Tip

Tipo: Category


addDatastreams(datastreams)

Add a datastreams to the category

Parámetros

Nombre Tipo Opcional Descripción
datastreams Object ❌ of datastream json object

Retorna

Tip

Tipo: Category


Datastream

Defines the builder used to configure a datastream of an IoT datamodel.

addQrating(qrating)

Set the qrating attribute. Use {Qrating} utility for create this object

Parámetros

Nombre Tipo Opcional Descripción
qrating Object ❌

Retorna

Tip

Tipo: Datastream


build()

Build a Datastream json object

Retorna

Tip

Tipo: Object
Datastream json object

Ejemplos

ogapi.DatastreamsBuilder().build()

withAccess(access)

Set the access object. Possible values: [READ, WRITE], [READ], [WRITE], []

Parámetros

Nombre Tipo Opcional Descripción
access Array ❌

Retorna

Tip

Tipo: Datastream


withDescription(description)

Set the description attribute

Parámetros

Nombre Tipo Opcional Descripción
description string ❌

Retorna

Tip

Tipo: Datastream


withId(id)

Set the id attribute

Parámetros

Nombre Tipo Opcional Descripción
id string ❌ required field

Retorna

Tip

Tipo: Datastream


withName(name)

Set the name attribute

Parámetros

Nombre Tipo Opcional Descripción
name string ❌ required field

Retorna

Tip

Tipo: Datastream


withPeriod(period)

Set the period attribute. Possible values: PULSE, CUMULATIVE, INSTANT

Parámetros

Nombre Tipo Opcional Descripción
period string ❌ required field

Retorna

Tip

Tipo: Datastream


withSchema(schema)

Set the schema object attribute.

Parámetros

Nombre Tipo Opcional Descripción
schema Object ❌

Retorna

Tip

Tipo: Datastream


withStorage(period, total)

Set the storage object.

Parámetros

Nombre Tipo Opcional Descripción
period string ❌
total number ❌

Retorna

Tip

Tipo: Datastream


withTags(tags)

Set the tags attribute.

Parámetros

Nombre Tipo Opcional Descripción
tags Array ❌

Retorna

Tip

Tipo: Datastream


withUnit(type, label, symbol)

Set the unit object attribute

Parámetros

Nombre Tipo Opcional Descripción
type string ❌ required field
label string ❌ required field
symbol string ❌ required field

Retorna

Tip

Tipo: Datastream


Qrating

Defines the builder used to configure the quality rating (Qrating) of a datastream in an IoT datamodel.

build()

Build a Qrating json object

Retorna

Tip

Tipo: Object
Datastream json object

Ejemplos

ogapi.QratingsBuilder().build()

withConversionMatrix(conversionMatrix)

Set the conversionMatrix attribute

Parámetros

Nombre Tipo Opcional Descripción
conversionMatrix Object ❌

Retorna

Tip

Tipo: Qrating


withCumulativePeriodDivisor(cumulativePeriodDivisor)

Set the cumulativePeriodDivisor attribute

Parámetros

Nombre Tipo Opcional Descripción
cumulativePeriodDivisor string ❌

Retorna

Tip

Tipo: Qrating


withIdeal(label, value)

Set the ideal attribute

Parámetros

Nombre Tipo Opcional Descripción
label string ❌ required field
value number ❌ required field

Retorna

Tip

Tipo: Qrating


withMaxAllowed(label, value)

Set the maxAllowed attribute

Parámetros

Nombre Tipo Opcional Descripción
label string ❌ required field
value number ❌ required field

Retorna

Tip

Tipo: Qrating


withMaxDesired(label, value)

Set the maxDesired attribute

Parámetros

Nombre Tipo Opcional Descripción
label string ❌ required field
value number ❌ required field

Retorna

Tip

Tipo: Qrating


withMaxScore(maxScore)

Set the maxScore attribute

Parámetros

Nombre Tipo Opcional Descripción
maxScore number ❌ required field

Retorna

Tip

Tipo: Qrating


withMinDesired(label, value)

Set the minDesired attribute

Parámetros

Nombre Tipo Opcional Descripción
label string ❌ required field
value number ❌ required field

Retorna

Tip

Tipo: Qrating


withMinRequired(label, value)

Set the minRequired attribute

Parámetros

Nombre Tipo Opcional Descripción
label string ❌ required field
value number ❌ required field

Retorna

Tip

Tipo: Qrating


withVersion(version)

Set the version attribute

Parámetros

Nombre Tipo Opcional Descripción
version string ❌ required field

Retorna

Tip

Tipo: Qrating