@acceleratxr/core_sdk / StatusService
Class: StatusService#
Hierarchy#
-
↳ StatusService
Index#
Constructors#
Properties#
Methods#
Constructors#
constructor#
+ new StatusService(apiClient: ApiClient, config: Configuration): StatusService
Overrides ServiceBase.constructor
Defined in src/services/StatusService.ts:11
Parameters:#
Name |
Type |
|---|---|
|
|
|
Returns: StatusService
Properties#
apiClient#
• Protected apiClient: ApiClient
Inherited from ServiceBase.apiClient
Defined in src/ServiceBase.ts:14
The API Client used when making requests to the API backend server.
config#
• Protected config: Configuration
Inherited from ServiceBase.config
Defined in src/ServiceBase.ts:19
The SDK configuration to use.
uuid#
▪ Static uuid: string = “1d22874b-28ec-4381-b525-ff487e084778”
Defined in src/services/StatusService.ts:17
Methods#
checkServiceStatus#
▸ checkServiceStatus(name: string): Promise<boolean>
Defined in src/services/StatusService.ts:61
Returns the count of healthy AcceleratXR services running in the cluster. The returned value is true if the service is online and healthy, otherwise false.
Parameters:#
Name |
Type |
Description |
|---|---|---|
|
string |
The name of the service whose status will be retrieved. |
Returns: Promise<boolean>
countAllStatus#
▸ countAllStatus(): Promise<string>
Defined in src/services/StatusService.ts:24
Returns the count of healthy AcceleratXR services running in the cluster. The returned
value is a formatted string of the form <healthy>/<total> corresponding to the number
of healthy services and the total number of services deployed.
Returns: Promise<string>
getAllStatus#
▸ getAllStatus(): Promise<ServiceStatusList>
Defined in src/services/StatusService.ts:41
Returns the health status of all AcceleratXR services running in the cluster.
Returns: Promise<ServiceStatusList>
getServiceStatus#
▸ getServiceStatus(name: string): Promise<ServiceStatus>
Defined in src/services/StatusService.ts:81
Returns the health status of all AcceleratXR services running in the cluster.
Parameters:#
Name |
Type |
Description |
|---|---|---|
|
string |
The name of the service whose status will be retrieved. |
Returns: Promise<ServiceStatus>