IAgentsQuery

Home > @gooddata/sdk-backend-spi > IAgentsQuery

IAgentsQuery interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Service to query agents.

Signature:

export interface IAgentsQuery

Methods

Method

Description

query()

(ALPHA) Starts the agents query.

queryAll()

(ALPHA) Starts the agents query.

withFilter(filter)

(ALPHA) Sets filter for the query.

withPage(page)

(ALPHA) Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0

withSize(size)

(ALPHA) Sets number of agents to return per page. Default size: 100

withSorting(sort)

(ALPHA) Sets sorting for the query.

← FilterWithResolvableElementsIAgentsQueryResult →