Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface QueryResponse

Package version

Query result.

Hierarchy

  • QueryResponse

Index

Properties

count

count: number

Number of records returned in the current response. In the case of paging, this is the number of records in the current page.

data

data: any

Query output in tabular format.

Optional facets

facets: FacetUnion[]

Query facets.

resultTruncated

resultTruncated: ResultTruncated

Indicates whether the query results are truncated. Possible values include: 'true', 'false'

Optional skipToken

skipToken: undefined | string

When present, the value can be passed to a subsequent query call (together with the same query and subscriptions used in the current request) to retrieve the next page of data.

totalRecords

totalRecords: number

Number of total records matching the query.

Generated using TypeDoc