Function: getAllLabels()

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

Parameter	Type	Description
client	Client	-
parameters?	{ maxResults?: number; query?: string; scope?: string; startAt?: number; }	-
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.query?	string	Case-insensitive prefix used to filter labels before pagination.
parameters.scope?	string	RECENT_PROJECTS or ALL_BROWSEABLE_PROJECTS. Omitted scope retains the unbounded search. Blank or unrecognised values use ALL_BROWSEABLE_PROJECTS.
parameters.startAt?	number	The 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[]; }>