import DatamodelsHelper from 'opengate-js/src/iot/datamodels/DatamodelsHelper.js'

public class | source

DatamodelsHelper

Extends:

BaseProvision → DatamodelsHelper

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

Constructor Summary

Public Constructor
public	constructor(ogapi: InternalOpenGateAPI, organization: string, datamodel: object) Constructor

Method Summary

Public Methods
public	addCategory(category: Object, datastreams: Array): DatamodelsHelper Add a category.
public	addDatastream(category: string, datastream: object): DatamodelsHelper Add a datastream to the indicated category
public	create() Create not supported on this builder.
public	removeCategory(category: string): DatamodelsHelper Remove category
public	removeDatastream(category: string, id_datastream: string): DatamodelsHelper Remove datastream to the indicated category
public	updateCategory(old_category: string, new_category: string): DatamodelsHelper Update category name
public	updateDatastream(category: string, id_datastream: string, datastream: Object): DatamodelsHelper Update datastream to the indicated category
public	withDescription(description: string): DatamodelsHelper Set the description attribute
public	withIdentifier(identifier: string): Datamodels Set the identifier attribute
public	withName(name: string): DatamodelsHelper Set the name attribute
public	withVersion(version: string): DatamodelsHelper Set the version attribute

Inherited Summary

From class BaseProvision
public	create(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function create a entity of provision
public	delete(body: *): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function deletes a entity of provision
public	update(): Promise This invoke a request to OpenGate North API and the callback is managed by promises This function updates a entity of provision

Public Constructors

public constructor(ogapi: InternalOpenGateAPI, organization: string, datamodel: object) source

Constructor

Override:

BaseProvision#constructor

Params:

Name	Type	Attribute	Description
ogapi	InternalOpenGateAPI	nullable: false	this is ogapi instance
organization	string	nullable: false	Organization where the IoT datamodel was create
datamodel	object	nullable: false	Json object of IoT datamodel to modify or delete.

Public Methods

public addCategory(category: Object, datastreams: Array): DatamodelsHelper source

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

Params:

Name	Type	Attribute	Description
category	Object	nullable: false
datastreams	Array

Return:

DatamodelsHelper

public addDatastream(category: string, datastream: object): DatamodelsHelper source

Add a datastream to the indicated category

Params:

Name	Type	Attribute	Description
category	string	nullable: false
datastream	object	nullable: false

Return:

DatamodelsHelper

public create() source

Create not supported on this builder. Use IoTDatamodelHelper instead.

Override:

BaseProvision#create

public removeCategory(category: string): DatamodelsHelper source

Remove category

Params:

Name	Type	Attribute	Description
category	string	nullable: false

Return:

DatamodelsHelper

public removeDatastream(category: string, id_datastream: string): DatamodelsHelper source

Remove datastream to the indicated category

Params:

Name	Type	Attribute	Description
category	string	nullable: false
id_datastream	string	nullable: false	of datastream

Return:

DatamodelsHelper

public updateCategory(old_category: string, new_category: string): DatamodelsHelper source

Update category name

Params:

Name	Type	Attribute	Description
old_category	string	nullable: false	name
new_category	string	nullable: false	name

Return:

DatamodelsHelper

public updateDatastream(category: string, id_datastream: string, datastream: Object): DatamodelsHelper source

Update datastream to the indicated category

Params:

Name	Type	Attribute	Description
category	string	nullable: false
id_datastream	string	nullable: false	of datastream
datastream	Object	nullable: false	json object

Return:

DatamodelsHelper

public withDescription(description: string): DatamodelsHelper source

Set the description attribute

Params:

Name	Type	Attribute	Description
description	string

Return:

DatamodelsHelper

public withIdentifier(identifier: string): Datamodels source

Set the identifier attribute

Params:

Name	Type	Attribute	Description
identifier	string	nullable: false	required field

Return:

Datamodels

public withName(name: string): DatamodelsHelper source

Set the name attribute

Params:

Name	Type	Attribute	Description
name	string	nullable: false	required field

Return:

DatamodelsHelper

public withVersion(version: string): DatamodelsHelper source

Set the version attribute

Params:

Name	Type	Attribute	Description
version	string	nullable: false	required field

Return:

DatamodelsHelper