MCPcopy Create free account
hub / github.com/algolia/algoliasearch-client-javascript / getRun

Function getRun

packages/ingestion/src/ingestionClient.ts:1857–1872  ·  view source on GitHub ↗

* Retrieve a single task run by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @param getRun - The getRun object. * @param getRun.runID - Unique identifier of a task run. * @param requestOptions - The requestOptions to s

({ runID }: GetRunProps, requestOptions?: RequestOptions)

Source from the content-addressed store, hash-verified

1855 * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.
1856 */
1857 getRun({ runID }: GetRunProps, requestOptions?: RequestOptions): Promise<Run> {
1858 validateRequired('runID', 'getRun', runID);
1859
1860 const requestPath = '/1/runs/{runID}'.replace('{runID}', encodeURIComponent(runID));
1861 const headers: Headers = {};
1862 const queryParameters: QueryParameters = {};
1863
1864 const request: Request = {
1865 method: 'GET',
1866 path: requestPath,
1867 queryParameters,
1868 headers,
1869 };
1870
1871 return transporter.request(request, requestOptions);
1872 },
1873 /**
1874 * Retrieve a single task run by its ID.
1875 *

Callers

nothing calls this directly

Calls 1

validateRequiredFunction · 0.90

Tested by

no test coverage detected