Softwares Search Builder
SoftwaresSearchBuilder
SoftwaresSearchBuilder Objects
class SoftwaresSearchBuilder()Defined a search over Datastreams
constructor
function constructor()Arguments:
parentInternalOpenGateAPI - Instance of our InternalOpenGateAPI
fluentFilter
function fluentFilter()tagsFilter
function tagsFilter()withHardwareId
function withHardwareId(hardwareId: string) -> 'SoftwaresSearchBuilder'Sets hardware id to search
Arguments:
hardwareIdstring - hardware id
Returns:
SoftwaresSearchBuilder
Example:
ogapi.hardwareSearchBuilder().withHardwareId('myHardware').build()withId
function withId(softwareId: string) -> 'SoftwaresSearchBuilder'Sets softwareId to search
Arguments:
softwareIdstring - software id
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withId('mySoftwareId').build()withManufacturer
function withManufacturer(manufacturerName: string) -> 'SoftwaresSearchBuilder'Set feedName to search
Arguments:
manufacturerNamestring - manufacturer name
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withManufacturer('myManufacturer').build()withModel
function withModel(modelName: string) -> 'SoftwaresSearchBuilder'Set modelName to search
Arguments:
modelNamestring - model name
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withModel('myModel').build()withModelVersion
function withModelVersion(modelVersion: string) -> 'SoftwaresSearchBuilder'Set modelVersion to search
Arguments:
modelVersionstring - model version
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withModelVersion('myModelVersion).build()withName
function withName(softwareName: string) -> 'SoftwaresSearchBuilder'Set softwareName to search
Arguments:
softwareNamestring - software name
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withName('mySoftware').build()withType
function withType(softwareType: string) -> 'SoftwaresSearchBuilder'Set softwareType to search
Arguments:
softwareTypestring - software version
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withType('mySoftwareType).build()withVersion
function withVersion(softwareVersion: string) -> 'SoftwaresSearchBuilder'Set softwareVersion to search
Arguments:
softwareVersionstring - software version
Returns:
SoftwaresSearchBuilder
Example:
ogapi.softwareSearchBuilder().withVersion('mySoftwareVersion).build()