Skip to content

Function: getAllLabels() ​

ts
function getAllLabels(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: string[];
}>;

Defined in: src/cloud/api/labels.ts:6

Returns a paginated list of labels.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ maxResults?: number; startAt?: number; }-
parameters.maxResults?numberThe maximum number of items to return per page.
parameters.startAt?numberThe index of the first item to return in a page of results (page offset).
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: string[]; }>