Function: getBuildByKey()

function getBuildByKey(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  associations?: object[];
  buildNumber: number;
  description?: string;
  displayName: string;
  label?: string;
  lastUpdated: Date;
  pipelineId: string;
  references?: object[];
  schemaVersion?: string & object | "1.0";
  state:   | "failed"
     | "unknown"
     | "pending"
     | string & object
     | "successful"
     | "in_progress"
     | "cancelled";
  testInfo?: {
   [key: string]: unknown;
     numberFailed: number;
     numberPassed: number;
     numberSkipped?: number;
     totalNumber: number;
  };
  updateSequenceNumber: number;
  url: string;
}>;

Defined in: src/agile/api/builds.ts:80

Retrieve the currently stored build data for the given pipelineId and buildNumber combination.

The result will be what is currently stored, ignoring any pending updates or deletes.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ buildNumber: number; pipelineId: string; }	-
parameters.buildNumber	number	The buildNumber of the build.
parameters.pipelineId?	string	The pipelineId of the build.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; associations?: object[]; buildNumber: number; description?: string; displayName: string; label?: string; lastUpdated: Date; pipelineId: string; references?: object[]; schemaVersion?: string & object | "1.0"; state: | "failed" | "unknown" | "pending" | string & object | "successful" | "in_progress" | "cancelled"; testInfo?: { [key: string]: unknown; numberFailed: number; numberPassed: number; numberSkipped?: number; totalNumber: number; }; updateSequenceNumber: number; url: string; }>