Function: getState()

function getState(client, options?): Promise<{
[key: string]: unknown;
  build?: {
   [key: string]: unknown;
     buildNumber?: number;
     version?: string;
  };
  state?:   | string & object
     | "STABLE"
     | "READY_TO_UPGRADE"
     | "MIXED"
     | "READY_TO_RUN_UPGRADE_TASKS"
     | "RUNNING_UPGRADE_TASKS"
     | "UPGRADE_TASKS_FAILED";
}>;

Defined in: src/server/api/cluster.ts:91

Returns the current state of the cluster upgrade.

Parameters

Parameter	Type
client	Client
options?	RequestOptions

Returns

Promise<{ [key: string]: unknown; build?: { [key: string]: unknown; buildNumber?: number; version?: string; }; state?: | string & object | "STABLE" | "READY_TO_UPGRADE" | "MIXED" | "READY_TO_RUN_UPGRADE_TASKS" | "RUNNING_UPGRADE_TASKS" | "UPGRADE_TASKS_FAILED"; }>