IWorkspacesQuery

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

IWorkspacesQuery interface

Query to retrieve available workspaces.

Signature:

export interface IWorkspacesQuery 

Methods

Method	Description
query()	Executes the query and returns the result asynchronously.
queryAllDescriptors()	Executes the query and returns all workspace descriptors. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services.
queryDescriptors()	Executes the query and returns workspace descriptors in a paged result. This is more efficient when you only need workspace metadata (id, title, etc.) and don't need the full workspace services.
withFilter(filter)	(ALPHA) Sets filter of workspaces by given attributes
withLimit(limit)	Sets a limit on how many items to retrieve at once.
withOffset(offset)	Sets a number of items to skip.
withOptions(options)	(ALPHA) Sets additional options for the query.
withParent(workspaceId)	Sets a identifier of the parent workspace to get its children, otherwise the root workspace.
withSearch(search)	Sets a text to search.