Datamodels

Datamodels Objects

class Datamodels()

This is a base object for create a IoT Datamodel

constructor

function constructor()

Constructor

Arguments:

ogapi InternalOpenGateAPI - this is ogapi instance
organization string - Organization where the IoT datamodel will be created

addAllowedResourceType

function addAllowedResourceType(resourceType: string) -> 'Datamodels'

Set the addAllowedResourceType attribute

Arguments:

resourceType string - required field

Returns:

Datamodels

addCategory

function addCategory(category: Object,datastreams: Array) -> 'Datamodels'

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

Arguments:

category Object
datastreams Array

Returns:

Datamodels

addDatastream

function addDatastream(category: string,datastream: object) -> 'Datamodels'

Add a datastream to the indicated category

Arguments:

category string
datastream object

Returns:

Datamodels

delete

function delete()

Delete not supported on this builder. Use IoTDatamodelHelper instead.

update

function update()

Update not supported on this builder. Use IoTDatamodelHelper instead.

withDescription

function withDescription(description: string) -> 'Datamodels'

Set the description attribute

Arguments:

description string

Returns:

Datamodels

withIdentifier

function withIdentifier(identifier: string) -> 'Datamodels'

Set the identifier attribute

Arguments:

identifier string - required field

Returns:

Datamodels

withName

function withName(name: string) -> 'Datamodels'

Set the name attribute

Arguments:

name string - required field

Returns:

Datamodels

withVersion

function withVersion(version: string) -> 'Datamodels'

Set the version attribute

Arguments:

version string - required field

Returns:

Datamodels