import DatasetEntitiesSearchBuilder from 'opengate-js/src/searching/builder/DatasetEntitiesSearchBuilder.js'

public class | source

DatasetEntitiesSearchBuilder

Extends:

SearchBuilder → SearchWithSummaryBuilder → DatasetEntitiesSearchBuilder

Defined a search over Executions

Example:

ogapi.datasetEntitiesSearchBuilder()

Constructor Summary

Public Constructor
public	constructor(parent: InternalOpenGateAPI)

Method Summary

Public Methods
public	build(): Search Build a instance of Search
public	disableCaseSensitive(flag: *): DatasetEntitiesSearchBuilder The response will return a response by applying the filter with likes case-no-sensitive
public	disableDefaultSorted(): DatasetEntitiesSearchBuilder The response will return a response without sorted
public	flattened(): DatasetEntitiesSearchBuilder The response will return a flattened response
public	group(group: object): DatasetEntitiesSearchBuilder The search request will have this group by
public	removeCaseSensitive(): DatasetEntitiesSearchBuilder The response will return a response by deleteing the parameters with likes case-no-sensitive
public	select(select: SelectBuilder \| object): DatasetEntitiesSearchBuilder The search request will have this filter

Inherited Summary

From class SearchBuilder
public	[route]: *
public	addSortAscendingBy(filterField: string): SearchBuilder Add ascending param into the sort search object
public	addSortBy(filterField: string, typeSort: string): SearchBuilder Add ascending/descending param into the sort search object
public	addSortDescendingBy(filterField: string): SearchBuilder Add descending param into the sort search object
public	build(): Search Build a instance of Search
public	filter(filter: FilterBuilder \| object): SearchBuilder The search request will have this filter
public	findAllFields(input: *): Promise Return a promise which it will contains an array with fields recommended with complete structure
public	findFieldPath(field: *): Promise Return a promise which it will contains an string with the path of a field
public	findFields(input: *): Promise Return a promise which it will contains an array with fields recommended with only identifier
public	limit(size: number, start: number): SearchBuilder Set reponse pagination.
public	removeSortBy(filterField: string): SearchBuilder Remove sort param from the search object
public	withTimeout(ms: number): SearchBuilder The request will have a specific time out if it will be exceeded then the promise throw an exception

From class SearchWithSummaryBuilder
public	summary(): SearchWithSummaryBuilder The response will only have a summary information

Public Constructors

public constructor(parent: InternalOpenGateAPI) source

Constructor

Override:

SearchWithSummaryBuilder#constructor

Params:

Name	Type	Attribute	Description
parent	InternalOpenGateAPI	nullable: false	Instance of our InternalOpenGateAPI

Public Methods

public build(): Search source

Build a instance of Search

Override:

SearchBuilder#build

Return:

Throw:

SearchBuilderError

Throw error on url build

Example:

 ogapi.datasetEntitiesSearchBuilder()

public disableCaseSensitive(flag: *): DatasetEntitiesSearchBuilder source

The response will return a response by applying the filter with likes case-no-sensitive

Params:

Name	Type	Attribute	Description
flag	*

Return:

DatasetEntitiesSearchBuilder

Example:

ogapi.datasetEntitiesSearchBuilder().disableCaseSensitive()

public disableDefaultSorted(): DatasetEntitiesSearchBuilder source

The response will return a response without sorted

Return:

DatasetEntitiesSearchBuilder

Example:

ogapi.datasetEntitiesSearchBuilder().disableDefaultSorted()

public flattened(): DatasetEntitiesSearchBuilder source

The response will return a flattened response

Return:

DatasetEntitiesSearchBuilder

Example:

ogapi.datasetEntitiesSearchBuilder().flattened()

public group(group: object): DatasetEntitiesSearchBuilder source

The search request will have this group by

Params:

Name	Type	Attribute	Description
group	object	nullable: false

Return:

DatasetEntitiesSearchBuilder

Example:

public removeCaseSensitive(): DatasetEntitiesSearchBuilder source

The response will return a response by deleteing the parameters with likes case-no-sensitive

Return:

DatasetEntitiesSearchBuilder

Example:

ogapi.datasetEntitiesSearchBuilder().disableCaseSensitive()

public select(select: SelectBuilder | object): DatasetEntitiesSearchBuilder source

The search request will have this filter

Params:

Name	Type	Attribute	Description
select	SelectBuilder \| object	nullable: false

Return:

DatasetEntitiesSearchBuilder

Example:

 ogapi.datasetEntitiesSearchBuilder().select(
     ogapi.newSelectBuilder().add(SE.element("provision.device.identifier", ["value"], "id"), SE.add("device.temperature.value", ["value"]))
 ) // Setting SelectBuilder
 ogapi.datasetEntitiesSearchBuilder().select({ "elements": [{"name": "provision.device.identifier",
	"fields": [{"field": "value","alias": "identifier"}]},
     {"name": "device.temperature.value","fields": [{"field": "value","alias": "identifier"}]}]
  }) //Custom select