IDatasetsQuery
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Service to query datasets.
export interface IDatasetsQuery
Methods
Method | Description |
|---|---|
(BETA) Starts the query. | |
(BETA) Sets filter for the query. | |
(BETA) Sets include for the query. | |
(BETA) Selects which backend endpoint flavor to use when listing datasets. Default method: “GET” | |
(BETA) Sets origin for the query. | |
(BETA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 | |
(BETA) Sets number of datasets to return per page. Default size: 50 | |
(BETA) Sets sorting for the query. |
Method details
IDatasetsQuery.query()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Starts the query.
query(): Promise<IDatasetsQueryResult>;
Returns
Promise<IDatasetsQueryResult>
promise of first page of the results
IDatasetsQuery.withFilter()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets filter for the query.
withFilter(filter: IDatasetsQueryFilterOptions): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
filter | filter to apply |
Returns
datasets query
IDatasetsQuery.withInclude()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets include for the query.
withInclude(include: string[]): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
include | string[] | include to apply |
Returns
datasets query
IDatasetsQuery.withMethod()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Selects which backend endpoint flavor to use when listing datasets. Default method: “GET”
withMethod(method: QueryMethod): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
method | endpoint flavor to use (“GET” or “POST”) |
Returns
datasets query
IDatasetsQuery.withOrigin()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets origin for the query.
withOrigin(origin: ObjectOrigin | (string & {})): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
origin | ObjectOrigin | (string & {}) | origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals. |
Returns
datasets query
IDatasetsQuery.withPage()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0
withPage(page: number): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
page | number | zero indexed, must be non-negative |
Returns
datasets query
IDatasetsQuery.withSize()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets number of datasets to return per page. Default size: 50
withSize(size: number): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
size | number | desired max number of datasets per page must be a positive number |
Returns
datasets query
IDatasetsQuery.withSorting()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Sets sorting for the query.
withSorting(sort: string[]): IDatasetsQuery;
Parameters
Parameter | Type | Description |
|---|---|---|
sort | string[] | Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
Returns
datasets query