openstatus.dev
Openstatus sdk
www.openstatus.dev
thibault.tngl.sh
1// @generated by protoc-gen-es v2.11.0 with parameter "target=ts,import_extension=ts"
2// @generated from file openstatus/health/v1/health.proto (package openstatus.health.v1, syntax proto3)
3/* eslint-disable */
4
5import type {
6 GenEnum,
7 GenFile,
8 GenMessage,
9 GenService,
10} from "@bufbuild/protobuf/codegenv2";
11import {
12 enumDesc,
13 fileDesc,
14 messageDesc,
15 serviceDesc,
16} from "@bufbuild/protobuf/codegenv2";
17import type { Message } from "@bufbuild/protobuf";
18
19/**
20 * Describes the file openstatus/health/v1/health.proto.
21 */
22export const file_openstatus_health_v1_health: GenFile = /*@__PURE__*/
23 fileDesc(
24 "CiFvcGVuc3RhdHVzL2hlYWx0aC92MS9oZWFsdGgucHJvdG8SFG9wZW5zdGF0dXMuaGVhbHRoLnYxIh8KDENoZWNrUmVxdWVzdBIPCgdzZXJ2aWNlGAEgASgJIr8BCg1DaGVja1Jlc3BvbnNlEkEKBnN0YXR1cxgBIAEoDjIxLm9wZW5zdGF0dXMuaGVhbHRoLnYxLkNoZWNrUmVzcG9uc2UuU2VydmluZ1N0YXR1cyJrCg1TZXJ2aW5nU3RhdHVzEh4KGlNFUlZJTkdfU1RBVFVTX1VOU1BFQ0lGSUVEEAASGgoWU0VSVklOR19TVEFUVVNfU0VSVklORxABEh4KGlNFUlZJTkdfU1RBVFVTX05PVF9TRVJWSU5HEAIyYQoNSGVhbHRoU2VydmljZRJQCgVDaGVjaxIiLm9wZW5zdGF0dXMuaGVhbHRoLnYxLkNoZWNrUmVxdWVzdBojLm9wZW5zdGF0dXMuaGVhbHRoLnYxLkNoZWNrUmVzcG9uc2VCUVpPZ2l0aHViLmNvbS9vcGVuc3RhdHVzaHEvb3BlbnN0YXR1cy9wYWNrYWdlcy9wcm90by9vcGVuc3RhdHVzL2hlYWx0aC92MTtoZWFsdGh2MWIGcHJvdG8z",
25 );
26
27/**
28 * CheckRequest is the request message for health checks.
29 *
30 * @generated from message openstatus.health.v1.CheckRequest
31 */
32export type CheckRequest = Message<"openstatus.health.v1.CheckRequest"> & {
33 /**
34 * Optional service name to check. If empty, checks overall service health.
35 *
36 * @generated from field: string service = 1;
37 */
38 service: string;
39};
40
41/**
42 * Describes the message openstatus.health.v1.CheckRequest.
43 * Use `create(CheckRequestSchema)` to create a new message.
44 */
45export const CheckRequestSchema: GenMessage<CheckRequest> = /*@__PURE__*/
46 messageDesc(file_openstatus_health_v1_health, 0);
47
48/**
49 * CheckResponse is the response message for health checks.
50 *
51 * @generated from message openstatus.health.v1.CheckResponse
52 */
53export type CheckResponse = Message<"openstatus.health.v1.CheckResponse"> & {
54 /**
55 * The serving status of the service.
56 *
57 * @generated from field: openstatus.health.v1.CheckResponse.ServingStatus status = 1;
58 */
59 status: CheckResponse_ServingStatus;
60};
61
62/**
63 * Describes the message openstatus.health.v1.CheckResponse.
64 * Use `create(CheckResponseSchema)` to create a new message.
65 */
66export const CheckResponseSchema: GenMessage<CheckResponse> = /*@__PURE__*/
67 messageDesc(file_openstatus_health_v1_health, 1);
68
69/**
70 * ServingStatus represents the health status of the service.
71 *
72 * @generated from enum openstatus.health.v1.CheckResponse.ServingStatus
73 */
74export enum CheckResponse_ServingStatus {
75 /**
76 * SERVING_STATUS_UNSPECIFIED indicates an unknown status.
77 *
78 * @generated from enum value: SERVING_STATUS_UNSPECIFIED = 0;
79 */
80 UNSPECIFIED = 0,
81
82 /**
83 * SERVING_STATUS_SERVING indicates the service is healthy and serving.
84 *
85 * @generated from enum value: SERVING_STATUS_SERVING = 1;
86 */
87 SERVING = 1,
88
89 /**
90 * SERVING_STATUS_NOT_SERVING indicates the service is not healthy.
91 *
92 * @generated from enum value: SERVING_STATUS_NOT_SERVING = 2;
93 */
94 NOT_SERVING = 2,
95}
96
97/**
98 * Describes the enum openstatus.health.v1.CheckResponse.ServingStatus.
99 */
100export const CheckResponse_ServingStatusSchema: GenEnum<
101 CheckResponse_ServingStatus
102> = /*@__PURE__*/
103 enumDesc(file_openstatus_health_v1_health, 1, 0);
104
105/**
106 * HealthService provides health check endpoints for load balancer probes.
107 *
108 * @generated from service openstatus.health.v1.HealthService
109 */
110export const HealthService: GenService<{
111 /**
112 * Check returns the current serving status of the service.
113 *
114 * @generated from rpc openstatus.health.v1.HealthService.Check
115 */
116 check: {
117 methodKind: "unary";
118 input: typeof CheckRequestSchema;
119 output: typeof CheckResponseSchema;
120 };
121}> = /*@__PURE__*/
122 serviceDesc(file_openstatus_health_v1_health, 0);