Class QueriesClient

Index

Constructors

Methods

createQuery getQuery listQueries listQueriesIter listVisualizationsForQuery listVisualizationsForQueryIter trashQuery updateQuery

Constructors

constructor

new QueriesClient(options: ClientOptions): QueriesClient
Parameters
- options: ClientOptions
Returns QueriesClient
- Defined in client.ts:60

Methods

createQuery

createQuery(req: CreateQueryRequest, options?: CallOptions): Promise<Query>
Creates a query.
Parameters
- req: CreateQueryRequest
- Optionaloptions: CallOptions
Returns Promise<Query>
- Defined in client.ts:76

getQuery

getQuery(req: GetQueryRequest, options?: CallOptions): Promise<Query>
Gets a query.
Parameters
- req: GetQueryRequest
- Optionaloptions: CallOptions
Returns Promise<Query>
- Defined in client.ts:106

listQueries

listQueries(
req: ListQueriesRequest,
options?: CallOptions,
): Promise<ListQueriesResponse>
Gets a list of queries accessible to the user, ordered by creation time. Warning: Calling this API concurrently 10 or more times could result in throttling, service degradation, or a temporary ban.
Parameters
- req: ListQueriesRequest
- Optionaloptions: CallOptions
Returns Promise<ListQueriesResponse>
- Defined in client.ts:132

listQueriesIter

listQueriesIter(
req: ListQueriesRequest,
options?: CallOptions,
): AsyncGenerator<ListQueryObjectsResponseQuery>
Parameters
- req: ListQueriesRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<ListQueryObjectsResponseQuery>
- Defined in client.ts:169

listVisualizationsForQuery

listVisualizationsForQuery(
req: ListVisualizationsForQueryRequest,
options?: CallOptions,
): Promise<ListVisualizationsForQueryResponse>
Gets a list of visualizations on a query.
Parameters
- req: ListVisualizationsForQueryRequest
- Optionaloptions: CallOptions
Returns Promise<ListVisualizationsForQueryResponse>
- Defined in client.ts:187

listVisualizationsForQueryIter

listVisualizationsForQueryIter(
req: ListVisualizationsForQueryRequest,
options?: CallOptions,
): AsyncGenerator<Visualization>
Parameters
- req: ListVisualizationsForQueryRequest
- Optionaloptions: CallOptions
Returns AsyncGenerator<Visualization>
- Defined in client.ts:227

trashQuery

trashQuery(req: TrashQueryRequest, options?: CallOptions): Promise<Empty>
Moves a query to the trash. Trashed queries immediately disappear from searches and list views, and cannot be used for alerts. You can restore a trashed query through the UI. A trashed query is permanently deleted after 30 days.
Parameters
- req: TrashQueryRequest
- Optionaloptions: CallOptions
Returns Promise<Empty>
- Defined in client.ts:245

updateQuery

updateQuery(req: UpdateQueryRequest, options?: CallOptions): Promise<Query>
Updates a query.
Parameters
- req: UpdateQueryRequest
- Optionaloptions: CallOptions
Returns Promise<Query>
- Defined in client.ts:274