Qrating

Qrating

Qrating Objects

class Qrating()

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

constructor
function constructor()

build
function build() -> 'Object'

Build a Qrating json object

Returns:

  • Object - Datastream json object

Example:

ogapi.QratingsBuilder().build()

withConversionMatrix
function withConversionMatrix(conversionMatrix: Object) -> 'Qrating'

Set the conversionMatrix attribute

Arguments:

  • conversionMatrix Object

Returns:

  • Qrating

withCumulativePeriodDivisor
function withCumulativePeriodDivisor(cumulativePeriodDivisor: string) -> 'Qrating'

Set the cumulativePeriodDivisor attribute

Arguments:

  • cumulativePeriodDivisor string

Returns:

  • Qrating

withIdeal
function withIdeal(label: string,value: number) -> 'Qrating'

Set the ideal attribute

Arguments:

  • label string - required field
  • value number - required field

Returns:

  • Qrating

withMaxAllowed
function withMaxAllowed(label: string,value: number) -> 'Qrating'

Set the maxAllowed attribute

Arguments:

  • label string - required field
  • value number - required field

Returns:

  • Qrating

withMaxDesired
function withMaxDesired(label: string,value: number) -> 'Qrating'

Set the maxDesired attribute

Arguments:

  • label string - required field
  • value number - required field

Returns:

  • Qrating

withMaxScore
function withMaxScore(maxScore: number) -> 'Qrating'

Set the maxScore attribute

Arguments:

  • maxScore number - required field

Returns:

  • Qrating

withMinDesired
function withMinDesired(label: string,value: number) -> 'Qrating'

Set the minDesired attribute

Arguments:

  • label string - required field
  • value number - required field

Returns:

  • Qrating

withMinRequired
function withMinRequired(label: string,value: number) -> 'Qrating'

Set the minRequired attribute

Arguments:

  • label string - required field
  • value number - required field

Returns:

  • Qrating

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

Set the version attribute

Arguments:

  • version string - required field

Returns:

  • Qrating