@shi-corp/sdk-data-gateway/bin/sdk/api/core/health/index.d.ts

SDK client used to interface with the SHI Data Gateway service.

import { type BaseRequestBuilder, type RequestConfiguration, type RequestInformation, type RequestsMetadata } from '@microsoft/kiota-abstractions';
/**
 * Builds and executes requests for operations under /Api/Core/Health
 */
export interface HealthRequestBuilder extends BaseRequestBuilder<HealthRequestBuilder> {
    /**
     * Check the health of the various components of the data gateway and report back. Useful for automated health probing.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @throws {HealthReport} error when the service returns a 500 status code
     */
    get(requestConfiguration?: RequestConfiguration<object> | undefined): Promise<void>;
    /**
     * Check the health of the various components of the data gateway and report back. Useful for automated health probing.
     * @param requestConfiguration Configuration for the request such as headers, query parameters, and middleware options.
     * @returns {RequestInformation}
     */
    toGetRequestInformation(requestConfiguration?: RequestConfiguration<object> | undefined): RequestInformation;
}
/**
 * Uri template for the request builder.
 */
export declare const HealthRequestBuilderUriTemplate = "{+baseurl}/Api/Core/Health";
/**
 * Metadata for all the requests in the request builder.
 */
export declare const HealthRequestBuilderRequestsMetadata: RequestsMetadata;