Defines the builder to configure a category of a datamodel. With this builder you can configure a category

constructor

Parámetros

addDatastream(datastream)

Add a datastream to the category

Parámetros

Retorna

addDatastreams(datastreams)

Add a datastreams to the category

Parámetros

Retorna

Defines the builder to configure a datastream of IoT datamodel. With this builder you can configure a datastream

addQrating(qrating)

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

Parámetros

Retorna

build()

Build a Datastream json object

Retorna

Ejemplos

ogapi.DatastreamsBuilder().build()

withAccess(access)

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

Parámetros

Retorna

withDescription(description)

Set the description attribute

Parámetros

Retorna

withId(id)

Set the id attribute

Parámetros

Retorna

withName(name)

Set the name attribute

Parámetros

Retorna

withPeriod(period)

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

Parámetros

Retorna

withSchema(schema)

Set the schema object attribute.

Parámetros

Retorna

withStorage(period, total)

Set the storage object.

Parámetros

Retorna

withTags(tags)

Set the tags attribute.

Parámetros

Retorna

withUnit(type, label, symbol)

Set the unit object attribute

Parámetros

Retorna

Defines the builder to configure a qurating of datastream of IoT datamodel. With this builder you can configure a qrating

build()

Build a Qrating json object

Retorna

Ejemplos

ogapi.QratingsBuilder().build()

withConversionMatrix(conversionMatrix)

Set the conversionMatrix attribute

Parámetros

Retorna

withCumulativePeriodDivisor(cumulativePeriodDivisor)

Set the cumulativePeriodDivisor attribute

Parámetros

Retorna

withIdeal(label, value)

Set the ideal attribute

Parámetros

Retorna

withMaxAllowed(label, value)

Set the maxAllowed attribute

Parámetros

Retorna

withMaxDesired(label, value)

Set the maxDesired attribute

Parámetros

Retorna

withMaxScore(maxScore)

Set the maxScore attribute

Parámetros

Retorna

withMinDesired(label, value)

Set the minDesired attribute

Parámetros

Retorna

withMinRequired(label, value)

Set the minRequired attribute

Parámetros

Retorna

withVersion(version)

Set the version attribute

Parámetros

Retorna

This is a base object for create a IoT Datamodel

constructor

Constructor

Parámetros

addAllowedResourceType(resourceType)

Set the addAllowedResourceType attribute

Parámetros

Retorna

addCategory(category, datastreams)

Add a flavor. If the field datastreams have value, they will add to this flavor

Parámetros

Retorna

addDatastream(category, datastream)

Add a datastream to the indicated category

Parámetros

Retorna

delete()

Delete not supported on this builder. Use IoTDatamodelHelper instead.

update()

Update not supported on this builder. Use IoTDatamodelHelper instead.

withDescription(description)

Set the description attribute

Parámetros

Retorna

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Retorna

withName(name)

Set the name attribute

Parámetros

Retorna

withVersion(version)

Set the version attribute

Parámetros

Retorna

This class allow make get request to organization resource into Opengate North API.

constructor

Constructor

Parámetros

findByOrganizationAndId(organization, id)

Download a specific IoT Datamodel by its organization and id. This execute a GET http method

Parámetros

Retorna

This is a base object for update and delete a IoT Datamodel

constructor

Constructor

Parámetros

addCategory(category, datastreams)

Add a category. If the field datastreams have value, they will add to this category

Parámetros

Retorna

addDatastream(category, datastream)

Add a datastream to the indicated category

Parámetros

Retorna

create()

Create not supported on this builder. Use IoTDatamodelHelper instead.

removeCategory(category)

Remove category

Parámetros

Retorna

removeDatastream(category, id_datastream)

Remove datastream to the indicated category

Parámetros

Retorna

updateCategory(old_category, new_category)

Update category name

Parámetros

Retorna

updateDatastream(category, id_datastream, datastream)

Update datastream to the indicated category

Parámetros

Retorna

withDescription(description)

Set the description attribute

Parámetros

Retorna

withIdentifier(identifier)

Set the identifier attribute

Parámetros

Retorna

withName(name)

Set the name attribute

Parámetros

Retorna

withVersion(version)

Set the version attribute

Parámetros

Retorna