@metal-stack/api 0.0.58 → 0.0.60

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/js/metalstack/admin/v2/audit_pb.d.ts +8 -8
  2. package/js/metalstack/admin/v2/audit_pb.js +1 -1
  3. package/js/metalstack/admin/v2/audit_pb.ts +8 -8
  4. package/js/metalstack/admin/v2/component_pb.d.ts +14 -14
  5. package/js/metalstack/admin/v2/component_pb.js +1 -1
  6. package/js/metalstack/admin/v2/component_pb.ts +14 -14
  7. package/js/metalstack/admin/v2/filesystem_pb.d.ts +15 -15
  8. package/js/metalstack/admin/v2/filesystem_pb.js +1 -1
  9. package/js/metalstack/admin/v2/filesystem_pb.ts +15 -15
  10. package/js/metalstack/admin/v2/image_pb.d.ts +20 -20
  11. package/js/metalstack/admin/v2/image_pb.js +1 -1
  12. package/js/metalstack/admin/v2/image_pb.ts +20 -20
  13. package/js/metalstack/admin/v2/ip_pb.d.ts +6 -6
  14. package/js/metalstack/admin/v2/ip_pb.js +1 -1
  15. package/js/metalstack/admin/v2/ip_pb.ts +6 -6
  16. package/js/metalstack/admin/v2/machine_pb.d.ts +10 -10
  17. package/js/metalstack/admin/v2/machine_pb.js +1 -1
  18. package/js/metalstack/admin/v2/machine_pb.ts +10 -10
  19. package/js/metalstack/admin/v2/network_pb.d.ts +30 -30
  20. package/js/metalstack/admin/v2/network_pb.js +2 -2
  21. package/js/metalstack/admin/v2/network_pb.ts +31 -31
  22. package/js/metalstack/admin/v2/partition_pb.d.ts +10 -11
  23. package/js/metalstack/admin/v2/partition_pb.js +2 -2
  24. package/js/metalstack/admin/v2/partition_pb.ts +11 -12
  25. package/js/metalstack/admin/v2/project_pb.d.ts +7 -7
  26. package/js/metalstack/admin/v2/project_pb.js +1 -1
  27. package/js/metalstack/admin/v2/project_pb.ts +7 -7
  28. package/js/metalstack/admin/v2/size_imageconstraint_pb.d.ts +21 -21
  29. package/js/metalstack/admin/v2/size_imageconstraint_pb.js +1 -1
  30. package/js/metalstack/admin/v2/size_imageconstraint_pb.ts +21 -21
  31. package/js/metalstack/admin/v2/size_pb.d.ts +13 -13
  32. package/js/metalstack/admin/v2/size_pb.js +1 -1
  33. package/js/metalstack/admin/v2/size_pb.ts +13 -13
  34. package/js/metalstack/admin/v2/size_reservation_pb.d.ts +17 -17
  35. package/js/metalstack/admin/v2/size_reservation_pb.js +1 -1
  36. package/js/metalstack/admin/v2/size_reservation_pb.ts +17 -17
  37. package/js/metalstack/admin/v2/switch_pb.d.ts +51 -51
  38. package/js/metalstack/admin/v2/switch_pb.js +1 -1
  39. package/js/metalstack/admin/v2/switch_pb.ts +51 -51
  40. package/js/metalstack/admin/v2/task_pb.d.ts +58 -58
  41. package/js/metalstack/admin/v2/task_pb.js +10 -10
  42. package/js/metalstack/admin/v2/task_pb.ts +58 -58
  43. package/js/metalstack/admin/v2/tenant_pb.d.ts +15 -15
  44. package/js/metalstack/admin/v2/tenant_pb.js +2 -2
  45. package/js/metalstack/admin/v2/tenant_pb.ts +16 -16
  46. package/js/metalstack/admin/v2/token_pb.d.ts +13 -13
  47. package/js/metalstack/admin/v2/token_pb.js +1 -1
  48. package/js/metalstack/admin/v2/token_pb.ts +13 -13
  49. package/js/metalstack/admin/v2/vpn_pb.d.ts +20 -20
  50. package/js/metalstack/admin/v2/vpn_pb.js +1 -1
  51. package/js/metalstack/admin/v2/vpn_pb.ts +20 -20
  52. package/js/metalstack/api/v2/audit_pb.d.ts +14 -14
  53. package/js/metalstack/api/v2/audit_pb.js +3 -3
  54. package/js/metalstack/api/v2/audit_pb.ts +14 -14
  55. package/js/metalstack/api/v2/filesystem_pb.d.ts +4 -4
  56. package/js/metalstack/api/v2/filesystem_pb.js +1 -1
  57. package/js/metalstack/api/v2/filesystem_pb.ts +4 -4
  58. package/js/metalstack/api/v2/health_pb.d.ts +20 -20
  59. package/js/metalstack/api/v2/health_pb.js +9 -9
  60. package/js/metalstack/api/v2/health_pb.ts +20 -20
  61. package/js/metalstack/api/v2/image_pb.d.ts +10 -4
  62. package/js/metalstack/api/v2/image_pb.js +2 -2
  63. package/js/metalstack/api/v2/image_pb.ts +12 -5
  64. package/js/metalstack/api/v2/ip_pb.d.ts +6 -6
  65. package/js/metalstack/api/v2/ip_pb.js +1 -1
  66. package/js/metalstack/api/v2/ip_pb.ts +6 -6
  67. package/js/metalstack/api/v2/machine_pb.d.ts +18 -18
  68. package/js/metalstack/api/v2/machine_pb.js +2 -2
  69. package/js/metalstack/api/v2/machine_pb.ts +19 -19
  70. package/js/metalstack/api/v2/method_pb.d.ts +16 -16
  71. package/js/metalstack/api/v2/method_pb.js +3 -3
  72. package/js/metalstack/api/v2/method_pb.ts +17 -17
  73. package/js/metalstack/api/v2/network_pb.d.ts +7 -7
  74. package/js/metalstack/api/v2/network_pb.js +1 -1
  75. package/js/metalstack/api/v2/network_pb.ts +7 -7
  76. package/js/metalstack/api/v2/partition_pb.d.ts +3 -3
  77. package/js/metalstack/api/v2/partition_pb.js +2 -2
  78. package/js/metalstack/api/v2/partition_pb.ts +4 -4
  79. package/js/metalstack/api/v2/predefined_rules_pb.d.ts +18 -0
  80. package/js/metalstack/api/v2/predefined_rules_pb.js +21 -3
  81. package/js/metalstack/api/v2/predefined_rules_pb.ts +27 -3
  82. package/js/metalstack/api/v2/project_pb.d.ts +8 -8
  83. package/js/metalstack/api/v2/project_pb.js +2 -2
  84. package/js/metalstack/api/v2/project_pb.ts +9 -9
  85. package/js/metalstack/api/v2/size_imageconstraint_pb.d.ts +2 -2
  86. package/js/metalstack/api/v2/size_imageconstraint_pb.js +1 -1
  87. package/js/metalstack/api/v2/size_imageconstraint_pb.ts +2 -2
  88. package/js/metalstack/api/v2/size_pb.d.ts +6 -6
  89. package/js/metalstack/api/v2/size_pb.js +2 -2
  90. package/js/metalstack/api/v2/size_pb.ts +7 -7
  91. package/js/metalstack/api/v2/size_reservation_pb.d.ts +3 -3
  92. package/js/metalstack/api/v2/size_reservation_pb.js +1 -1
  93. package/js/metalstack/api/v2/size_reservation_pb.ts +3 -3
  94. package/js/metalstack/api/v2/tenant_pb.d.ts +8 -8
  95. package/js/metalstack/api/v2/tenant_pb.js +2 -2
  96. package/js/metalstack/api/v2/tenant_pb.ts +9 -9
  97. package/js/metalstack/api/v2/token_pb.d.ts +15 -15
  98. package/js/metalstack/api/v2/token_pb.js +2 -2
  99. package/js/metalstack/api/v2/token_pb.ts +16 -16
  100. package/js/metalstack/api/v2/user_pb.d.ts +11 -11
  101. package/js/metalstack/api/v2/user_pb.js +2 -2
  102. package/js/metalstack/api/v2/user_pb.ts +12 -12
  103. package/js/metalstack/api/v2/version_pb.d.ts +6 -6
  104. package/js/metalstack/api/v2/version_pb.js +1 -1
  105. package/js/metalstack/api/v2/version_pb.ts +6 -6
  106. package/js/metalstack/api/v2/vpn_pb.d.ts +4 -4
  107. package/js/metalstack/api/v2/vpn_pb.ts +4 -4
  108. package/js/metalstack/infra/v2/bmc_pb.d.ts +19 -19
  109. package/js/metalstack/infra/v2/bmc_pb.js +1 -1
  110. package/js/metalstack/infra/v2/bmc_pb.ts +19 -19
  111. package/js/metalstack/infra/v2/boot_pb.d.ts +7 -7
  112. package/js/metalstack/infra/v2/boot_pb.js +1 -1
  113. package/js/metalstack/infra/v2/boot_pb.ts +7 -7
  114. package/js/metalstack/infra/v2/component_pb.d.ts +7 -10
  115. package/js/metalstack/infra/v2/component_pb.js +1 -1
  116. package/js/metalstack/infra/v2/component_pb.ts +7 -10
  117. package/js/metalstack/infra/v2/event_pb.d.ts +22 -22
  118. package/js/metalstack/infra/v2/event_pb.js +13 -13
  119. package/js/metalstack/infra/v2/event_pb.ts +22 -22
  120. package/js/metalstack/infra/v2/switch_pb.d.ts +22 -22
  121. package/js/metalstack/infra/v2/switch_pb.js +1 -1
  122. package/js/metalstack/infra/v2/switch_pb.ts +22 -22
  123. package/package.json +1 -1
@@ -6,13 +6,13 @@ import type { Message } from "@bufbuild/protobuf";
6
6
  */
7
7
  export declare const file_metalstack_infra_v2_event: GenFile;
8
8
  /**
9
- * EventServiceSendRequest.
9
+ * EventServiceSendRequest is the request payload for sending provisioning events.
10
10
  *
11
11
  * @generated from message metalstack.infra.v2.EventServiceSendRequest
12
12
  */
13
13
  export type EventServiceSendRequest = Message<"metalstack.infra.v2.EventServiceSendRequest"> & {
14
14
  /**
15
- * Events grouped by machine IDs.
15
+ * Events grouped by machine IDs
16
16
  *
17
17
  * @generated from field: map<string, metalstack.infra.v2.MachineProvisioningEvent> events = 1;
18
18
  */
@@ -26,19 +26,19 @@ export type EventServiceSendRequest = Message<"metalstack.infra.v2.EventServiceS
26
26
  */
27
27
  export declare const EventServiceSendRequestSchema: GenMessage<EventServiceSendRequest>;
28
28
  /**
29
- * EventServiceSendResponse.
29
+ * EventServiceSendResponse is the response payload for sending provisioning events.
30
30
  *
31
31
  * @generated from message metalstack.infra.v2.EventServiceSendResponse
32
32
  */
33
33
  export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventServiceSendResponse"> & {
34
34
  /**
35
- * Events counts the number of events successfully stored in the database.
35
+ * Events counts the number of events successfully stored in the database
36
36
  *
37
37
  * @generated from field: uint64 events = 1;
38
38
  */
39
39
  events: bigint;
40
40
  /**
41
- * Failed contains IDs of all machines whose events could not be stored in the database.
41
+ * Failed contains IDs of all machines whose events could not be stored in the database
42
42
  *
43
43
  * @generated from field: repeated string failed = 2;
44
44
  */
@@ -56,19 +56,19 @@ export declare const EventServiceSendResponseSchema: GenMessage<EventServiceSend
56
56
  */
57
57
  export type MachineProvisioningEvent = Message<"metalstack.infra.v2.MachineProvisioningEvent"> & {
58
58
  /**
59
- * Time the event occurred at.
59
+ * Time the event occurred at
60
60
  *
61
61
  * @generated from field: google.protobuf.Timestamp time = 1;
62
62
  */
63
63
  time?: Timestamp;
64
64
  /**
65
- * Event that occurred.
65
+ * Event that occurred
66
66
  *
67
67
  * @generated from field: metalstack.infra.v2.ProvisioningEventType event = 2;
68
68
  */
69
69
  event: ProvisioningEventType;
70
70
  /**
71
- * Message describing the event in more detail.
71
+ * Message describes the event in more detail
72
72
  *
73
73
  * @generated from field: string message = 3;
74
74
  */
@@ -86,73 +86,73 @@ export declare const MachineProvisioningEventSchema: GenMessage<MachineProvision
86
86
  */
87
87
  export declare enum ProvisioningEventType {
88
88
  /**
89
- * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.
89
+ * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified
90
90
  *
91
91
  * @generated from enum value: PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0;
92
92
  */
93
93
  UNSPECIFIED = 0,
94
94
  /**
95
- * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.
95
+ * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago
96
96
  *
97
97
  * @generated from enum value: PROVISIONING_EVENT_TYPE_ALIVE = 1;
98
98
  */
99
99
  ALIVE = 1,
100
100
  /**
101
- * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle.
101
+ * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle
102
102
  *
103
103
  * @generated from enum value: PROVISIONING_EVENT_TYPE_CRASHED = 2;
104
104
  */
105
105
  CRASHED = 2,
106
106
  /**
107
- * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.
107
+ * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE
108
108
  *
109
109
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3;
110
110
  */
111
111
  PXE_BOOTING = 3,
112
112
  /**
113
- * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.
113
+ * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot
114
114
  *
115
115
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4;
116
116
  */
117
117
  PLANNED_REBOOT = 4,
118
118
  /**
119
- * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.
119
+ * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started
120
120
  *
121
121
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PREPARING = 5;
122
122
  */
123
123
  PREPARING = 5,
124
124
  /**
125
- * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.
125
+ * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API
126
126
  *
127
127
  * @generated from enum value: PROVISIONING_EVENT_TYPE_REGISTERING = 6;
128
128
  */
129
129
  REGISTERING = 6,
130
130
  /**
131
- * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.
131
+ * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation
132
132
  *
133
133
  * @generated from enum value: PROVISIONING_EVENT_TYPE_WAITING = 7;
134
134
  */
135
135
  WAITING = 7,
136
136
  /**
137
- * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.
137
+ * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed
138
138
  *
139
139
  * @generated from enum value: PROVISIONING_EVENT_TYPE_INSTALLING = 8;
140
140
  */
141
141
  INSTALLING = 8,
142
142
  /**
143
- * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS.
143
+ * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS
144
144
  *
145
145
  * @generated from enum value: PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9;
146
146
  */
147
147
  BOOTING_NEW_KERNEL = 9,
148
148
  /**
149
- * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.
149
+ * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness
150
150
  *
151
151
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PHONED_HOME = 10;
152
152
  */
153
153
  PHONED_HOME = 10,
154
154
  /**
155
- * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines.
155
+ * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines
156
156
  *
157
157
  * @generated from enum value: PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11;
158
158
  */
@@ -163,13 +163,13 @@ export declare enum ProvisioningEventType {
163
163
  */
164
164
  export declare const ProvisioningEventTypeSchema: GenEnum<ProvisioningEventType>;
165
165
  /**
166
- * EventService serves event related functions.
166
+ * EventService provides machine provisioning event logging operations.
167
167
  *
168
168
  * @generated from service metalstack.infra.v2.EventService
169
169
  */
170
170
  export declare const EventService: GenService<{
171
171
  /**
172
- * Send a series of machine provisioning events.
172
+ * Sends a series of machine provisioning events.
173
173
  *
174
174
  * @generated from rpc metalstack.infra.v2.EventService.Send
175
175
  */
@@ -32,73 +32,73 @@ export const MachineProvisioningEventSchema = /*@__PURE__*/ messageDesc(file_met
32
32
  export var ProvisioningEventType;
33
33
  (function (ProvisioningEventType) {
34
34
  /**
35
- * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.
35
+ * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified
36
36
  *
37
37
  * @generated from enum value: PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0;
38
38
  */
39
39
  ProvisioningEventType[ProvisioningEventType["UNSPECIFIED"] = 0] = "UNSPECIFIED";
40
40
  /**
41
- * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.
41
+ * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago
42
42
  *
43
43
  * @generated from enum value: PROVISIONING_EVENT_TYPE_ALIVE = 1;
44
44
  */
45
45
  ProvisioningEventType[ProvisioningEventType["ALIVE"] = 1] = "ALIVE";
46
46
  /**
47
- * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle.
47
+ * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle
48
48
  *
49
49
  * @generated from enum value: PROVISIONING_EVENT_TYPE_CRASHED = 2;
50
50
  */
51
51
  ProvisioningEventType[ProvisioningEventType["CRASHED"] = 2] = "CRASHED";
52
52
  /**
53
- * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.
53
+ * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE
54
54
  *
55
55
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3;
56
56
  */
57
57
  ProvisioningEventType[ProvisioningEventType["PXE_BOOTING"] = 3] = "PXE_BOOTING";
58
58
  /**
59
- * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.
59
+ * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot
60
60
  *
61
61
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4;
62
62
  */
63
63
  ProvisioningEventType[ProvisioningEventType["PLANNED_REBOOT"] = 4] = "PLANNED_REBOOT";
64
64
  /**
65
- * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.
65
+ * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started
66
66
  *
67
67
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PREPARING = 5;
68
68
  */
69
69
  ProvisioningEventType[ProvisioningEventType["PREPARING"] = 5] = "PREPARING";
70
70
  /**
71
- * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.
71
+ * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API
72
72
  *
73
73
  * @generated from enum value: PROVISIONING_EVENT_TYPE_REGISTERING = 6;
74
74
  */
75
75
  ProvisioningEventType[ProvisioningEventType["REGISTERING"] = 6] = "REGISTERING";
76
76
  /**
77
- * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.
77
+ * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation
78
78
  *
79
79
  * @generated from enum value: PROVISIONING_EVENT_TYPE_WAITING = 7;
80
80
  */
81
81
  ProvisioningEventType[ProvisioningEventType["WAITING"] = 7] = "WAITING";
82
82
  /**
83
- * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.
83
+ * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed
84
84
  *
85
85
  * @generated from enum value: PROVISIONING_EVENT_TYPE_INSTALLING = 8;
86
86
  */
87
87
  ProvisioningEventType[ProvisioningEventType["INSTALLING"] = 8] = "INSTALLING";
88
88
  /**
89
- * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS.
89
+ * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS
90
90
  *
91
91
  * @generated from enum value: PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9;
92
92
  */
93
93
  ProvisioningEventType[ProvisioningEventType["BOOTING_NEW_KERNEL"] = 9] = "BOOTING_NEW_KERNEL";
94
94
  /**
95
- * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.
95
+ * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness
96
96
  *
97
97
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PHONED_HOME = 10;
98
98
  */
99
99
  ProvisioningEventType[ProvisioningEventType["PHONED_HOME"] = 10] = "PHONED_HOME";
100
100
  /**
101
- * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines.
101
+ * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines
102
102
  *
103
103
  * @generated from enum value: PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11;
104
104
  */
@@ -109,7 +109,7 @@ export var ProvisioningEventType;
109
109
  */
110
110
  export const ProvisioningEventTypeSchema = /*@__PURE__*/ enumDesc(file_metalstack_infra_v2_event, 0);
111
111
  /**
112
- * EventService serves event related functions.
112
+ * EventService provides machine provisioning event logging operations.
113
113
  *
114
114
  * @generated from service metalstack.infra.v2.EventService
115
115
  */
@@ -17,13 +17,13 @@ export const file_metalstack_infra_v2_event: GenFile = /*@__PURE__*/
17
17
  fileDesc("Ch9tZXRhbHN0YWNrL2luZnJhL3YyL2V2ZW50LnByb3RvEhNtZXRhbHN0YWNrLmluZnJhLnYyIsEBChdFdmVudFNlcnZpY2VTZW5kUmVxdWVzdBJICgZldmVudHMYASADKAsyOC5tZXRhbHN0YWNrLmluZnJhLnYyLkV2ZW50U2VydmljZVNlbmRSZXF1ZXN0LkV2ZW50c0VudHJ5GlwKC0V2ZW50c0VudHJ5EgsKA2tleRgBIAEoCRI8CgV2YWx1ZRgCIAEoCzItLm1ldGFsc3RhY2suaW5mcmEudjIuTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50OgI4ASI6ChhFdmVudFNlcnZpY2VTZW5kUmVzcG9uc2USDgoGZXZlbnRzGAEgASgEEg4KBmZhaWxlZBgCIAMoCSKaAQoYTWFjaGluZVByb3Zpc2lvbmluZ0V2ZW50EigKBHRpbWUYASABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEkMKBWV2ZW50GAIgASgOMioubWV0YWxzdGFjay5pbmZyYS52Mi5Qcm92aXNpb25pbmdFdmVudFR5cGVCCLpIBYIBAhABEg8KB21lc3NhZ2UYAyABKAkquAUKFVByb3Zpc2lvbmluZ0V2ZW50VHlwZRInCiNQUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9VTlNQRUNJRklFRBAAEiwKHVBST1ZJU0lPTklOR19FVkVOVF9UWVBFX0FMSVZFEAEaCYKyGQVBbGl2ZRIwCh9QUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9DUkFTSEVEEAIaC4KyGQdDcmFzaGVkEjgKI1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1BYRV9CT09USU5HEAMaD4KyGQtQWEUgQm9vdGluZxI+CiZQUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9QTEFOTkVEX1JFQk9PVBAEGhKCshkOUGxhbm5lZCBSZWJvb3QSNAohUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfUFJFUEFSSU5HEAUaDYKyGQlQcmVwYXJpbmcSOAojUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfUkVHSVNURVJJTkcQBhoPgrIZC1JlZ2lzdGVyaW5nEjAKH1BST1ZJU0lPTklOR19FVkVOVF9UWVBFX1dBSVRJTkcQBxoLgrIZB1dhaXRpbmcSNgoiUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfSU5TVEFMTElORxAIGg6CshkKSW5zdGFsbGluZxJGCipQUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9CT09USU5HX05FV19LRVJORUwQCRoWgrIZEkJvb3RpbmcgTmV3IEtlcm5lbBI4CiNQUk9WSVNJT05JTkdfRVZFTlRfVFlQRV9QSE9ORURfSE9NRRAKGg+CshkLUGhvbmVkIEhvbWUSQAonUFJPVklTSU9OSU5HX0VWRU5UX1RZUEVfTUFDSElORV9SRUNMQUlNEAsaE4KyGQ9NYWNoaW5lIFJlY2xhaW0yfgoMRXZlbnRTZXJ2aWNlEm4KBFNlbmQSLC5tZXRhbHN0YWNrLmluZnJhLnYyLkV2ZW50U2VydmljZVNlbmRSZXF1ZXN0Gi0ubWV0YWxzdGFjay5pbmZyYS52Mi5FdmVudFNlcnZpY2VTZW5kUmVzcG9uc2UiCeDzGALq8xgBAULOAQoXY29tLm1ldGFsc3RhY2suaW5mcmEudjJCCkV2ZW50UHJvdG9QAVo5Z2l0aHViLmNvbS9tZXRhbC1zdGFjay9hcGkvZ28vbWV0YWxzdGFjay9pbmZyYS92MjtpbmZyYXYyogIDTUlYqgITTWV0YWxzdGFjay5JbmZyYS5WMsoCE01ldGFsc3RhY2tcSW5mcmFcVjLiAh9NZXRhbHN0YWNrXEluZnJhXFYyXEdQQk1ldGFkYXRh6gIVTWV0YWxzdGFjazo6SW5mcmE6OlYyYgZwcm90bzM", [file_buf_validate_validate, file_google_protobuf_timestamp, file_metalstack_api_v2_common]);
18
18
 
19
19
  /**
20
- * EventServiceSendRequest.
20
+ * EventServiceSendRequest is the request payload for sending provisioning events.
21
21
  *
22
22
  * @generated from message metalstack.infra.v2.EventServiceSendRequest
23
23
  */
24
24
  export type EventServiceSendRequest = Message<"metalstack.infra.v2.EventServiceSendRequest"> & {
25
25
  /**
26
- * Events grouped by machine IDs.
26
+ * Events grouped by machine IDs
27
27
  *
28
28
  * @generated from field: map<string, metalstack.infra.v2.MachineProvisioningEvent> events = 1;
29
29
  */
@@ -38,20 +38,20 @@ export const EventServiceSendRequestSchema: GenMessage<EventServiceSendRequest>
38
38
  messageDesc(file_metalstack_infra_v2_event, 0);
39
39
 
40
40
  /**
41
- * EventServiceSendResponse.
41
+ * EventServiceSendResponse is the response payload for sending provisioning events.
42
42
  *
43
43
  * @generated from message metalstack.infra.v2.EventServiceSendResponse
44
44
  */
45
45
  export type EventServiceSendResponse = Message<"metalstack.infra.v2.EventServiceSendResponse"> & {
46
46
  /**
47
- * Events counts the number of events successfully stored in the database.
47
+ * Events counts the number of events successfully stored in the database
48
48
  *
49
49
  * @generated from field: uint64 events = 1;
50
50
  */
51
51
  events: bigint;
52
52
 
53
53
  /**
54
- * Failed contains IDs of all machines whose events could not be stored in the database.
54
+ * Failed contains IDs of all machines whose events could not be stored in the database
55
55
  *
56
56
  * @generated from field: repeated string failed = 2;
57
57
  */
@@ -72,21 +72,21 @@ export const EventServiceSendResponseSchema: GenMessage<EventServiceSendResponse
72
72
  */
73
73
  export type MachineProvisioningEvent = Message<"metalstack.infra.v2.MachineProvisioningEvent"> & {
74
74
  /**
75
- * Time the event occurred at.
75
+ * Time the event occurred at
76
76
  *
77
77
  * @generated from field: google.protobuf.Timestamp time = 1;
78
78
  */
79
79
  time?: Timestamp;
80
80
 
81
81
  /**
82
- * Event that occurred.
82
+ * Event that occurred
83
83
  *
84
84
  * @generated from field: metalstack.infra.v2.ProvisioningEventType event = 2;
85
85
  */
86
86
  event: ProvisioningEventType;
87
87
 
88
88
  /**
89
- * Message describing the event in more detail.
89
+ * Message describes the event in more detail
90
90
  *
91
91
  * @generated from field: string message = 3;
92
92
  */
@@ -107,84 +107,84 @@ export const MachineProvisioningEventSchema: GenMessage<MachineProvisioningEvent
107
107
  */
108
108
  export enum ProvisioningEventType {
109
109
  /**
110
- * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified.
110
+ * PROVISIONING_EVENT_TYPE_UNSPECIFIED is unspecified
111
111
  *
112
112
  * @generated from enum value: PROVISIONING_EVENT_TYPE_UNSPECIFIED = 0;
113
113
  */
114
114
  UNSPECIFIED = 0,
115
115
 
116
116
  /**
117
- * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago.
117
+ * PROVISIONING_EVENT_TYPE_ALIVE means the machine has reported itself to the API not long ago
118
118
  *
119
119
  * @generated from enum value: PROVISIONING_EVENT_TYPE_ALIVE = 1;
120
120
  */
121
121
  ALIVE = 1,
122
122
 
123
123
  /**
124
- * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle.
124
+ * PROVISIONING_EVENT_TYPE_CRASHED means an irregularity in the machine's lifecycle
125
125
  *
126
126
  * @generated from enum value: PROVISIONING_EVENT_TYPE_CRASHED = 2;
127
127
  */
128
128
  CRASHED = 2,
129
129
 
130
130
  /**
131
- * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE.
131
+ * PROVISIONING_EVENT_TYPE_PXE_BOOTING is sent when an unprovisioned machine requests a boot image via PXE
132
132
  *
133
133
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PXE_BOOTING = 3;
134
134
  */
135
135
  PXE_BOOTING = 3,
136
136
 
137
137
  /**
138
- * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot.
138
+ * PROVISIONING_EVENT_TYPE_PLANNED_REBOOT means the machine was scheduled for reboot
139
139
  *
140
140
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PLANNED_REBOOT = 4;
141
141
  */
142
142
  PLANNED_REBOOT = 4,
143
143
 
144
144
  /**
145
- * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started.
145
+ * PROVISIONING_EVENT_TYPE_PREPARING means the metal-hammer has started
146
146
  *
147
147
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PREPARING = 5;
148
148
  */
149
149
  PREPARING = 5,
150
150
 
151
151
  /**
152
- * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API.
152
+ * PROVISIONING_EVENT_TYPE_REGISTERING means the metal-hammer is attempting to register the machine at the API
153
153
  *
154
154
  * @generated from enum value: PROVISIONING_EVENT_TYPE_REGISTERING = 6;
155
155
  */
156
156
  REGISTERING = 6,
157
157
 
158
158
  /**
159
- * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation.
159
+ * PROVISIONING_EVENT_TYPE_WAITING means the machine has successfully reached the state where it is waiting for allocation
160
160
  *
161
161
  * @generated from enum value: PROVISIONING_EVENT_TYPE_WAITING = 7;
162
162
  */
163
163
  WAITING = 7,
164
164
 
165
165
  /**
166
- * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed.
166
+ * PROVISIONING_EVENT_TYPE_INSTALLING means the machine was allocated and the requested OS is being installed
167
167
  *
168
168
  * @generated from enum value: PROVISIONING_EVENT_TYPE_INSTALLING = 8;
169
169
  */
170
170
  INSTALLING = 8,
171
171
 
172
172
  /**
173
- * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS.
173
+ * PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL means the machine has successfully been installed and is now booting into the new OS
174
174
  *
175
175
  * @generated from enum value: PROVISIONING_EVENT_TYPE_BOOTING_NEW_KERNEL = 9;
176
176
  */
177
177
  BOOTING_NEW_KERNEL = 9,
178
178
 
179
179
  /**
180
- * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness.
180
+ * PROVISIONING_EVENT_TYPE_PHONED_HOME is sent periodically by an allocated machine to indicate its liveliness
181
181
  *
182
182
  * @generated from enum value: PROVISIONING_EVENT_TYPE_PHONED_HOME = 10;
183
183
  */
184
184
  PHONED_HOME = 10,
185
185
 
186
186
  /**
187
- * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines.
187
+ * PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM means the machine was freed and is about to return into the pool of waiting machines
188
188
  *
189
189
  * @generated from enum value: PROVISIONING_EVENT_TYPE_MACHINE_RECLAIM = 11;
190
190
  */
@@ -198,13 +198,13 @@ export const ProvisioningEventTypeSchema: GenEnum<ProvisioningEventType> = /*@__
198
198
  enumDesc(file_metalstack_infra_v2_event, 0);
199
199
 
200
200
  /**
201
- * EventService serves event related functions.
201
+ * EventService provides machine provisioning event logging operations.
202
202
  *
203
203
  * @generated from service metalstack.infra.v2.EventService
204
204
  */
205
205
  export const EventService: GenService<{
206
206
  /**
207
- * Send a series of machine provisioning events.
207
+ * Sends a series of machine provisioning events.
208
208
  *
209
209
  * @generated from rpc metalstack.infra.v2.EventService.Send
210
210
  */
@@ -7,13 +7,13 @@ import type { Message } from "@bufbuild/protobuf";
7
7
  */
8
8
  export declare const file_metalstack_infra_v2_switch: GenFile;
9
9
  /**
10
- * SwitchServiceGetRequest.
10
+ * SwitchServiceGetRequest is the request payload for getting a switch.
11
11
  *
12
12
  * @generated from message metalstack.infra.v2.SwitchServiceGetRequest
13
13
  */
14
14
  export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchServiceGetRequest"> & {
15
15
  /**
16
- * Id of the switch.
16
+ * Id of the switch
17
17
  *
18
18
  * @generated from field: string id = 1;
19
19
  */
@@ -25,13 +25,13 @@ export type SwitchServiceGetRequest = Message<"metalstack.infra.v2.SwitchService
25
25
  */
26
26
  export declare const SwitchServiceGetRequestSchema: GenMessage<SwitchServiceGetRequest>;
27
27
  /**
28
- * SwitchServiceGetResponse.
28
+ * SwitchServiceGetResponse is the response payload for getting a switch.
29
29
  *
30
30
  * @generated from message metalstack.infra.v2.SwitchServiceGetResponse
31
31
  */
32
32
  export type SwitchServiceGetResponse = Message<"metalstack.infra.v2.SwitchServiceGetResponse"> & {
33
33
  /**
34
- * Switch that was requested.
34
+ * Switch contains the requested switch
35
35
  *
36
36
  * @generated from field: metalstack.api.v2.Switch switch = 1;
37
37
  */
@@ -43,13 +43,13 @@ export type SwitchServiceGetResponse = Message<"metalstack.infra.v2.SwitchServic
43
43
  */
44
44
  export declare const SwitchServiceGetResponseSchema: GenMessage<SwitchServiceGetResponse>;
45
45
  /**
46
- * SwitchServiceRegisterRequest.
46
+ * SwitchServiceRegisterRequest is the request payload for registering a switch.
47
47
  *
48
48
  * @generated from message metalstack.infra.v2.SwitchServiceRegisterRequest
49
49
  */
50
50
  export type SwitchServiceRegisterRequest = Message<"metalstack.infra.v2.SwitchServiceRegisterRequest"> & {
51
51
  /**
52
- * Switch to register.
52
+ * Switch to register
53
53
  *
54
54
  * @generated from field: metalstack.api.v2.Switch switch = 1;
55
55
  */
@@ -61,13 +61,13 @@ export type SwitchServiceRegisterRequest = Message<"metalstack.infra.v2.SwitchSe
61
61
  */
62
62
  export declare const SwitchServiceRegisterRequestSchema: GenMessage<SwitchServiceRegisterRequest>;
63
63
  /**
64
- * SwitchServiceRegisterResponse.
64
+ * SwitchServiceRegisterResponse is the response payload for registering a switch.
65
65
  *
66
66
  * @generated from message metalstack.infra.v2.SwitchServiceRegisterResponse
67
67
  */
68
68
  export type SwitchServiceRegisterResponse = Message<"metalstack.infra.v2.SwitchServiceRegisterResponse"> & {
69
69
  /**
70
- * Switch that was registered.
70
+ * Switch contains the registered switch
71
71
  *
72
72
  * @generated from field: metalstack.api.v2.Switch switch = 1;
73
73
  */
@@ -79,31 +79,31 @@ export type SwitchServiceRegisterResponse = Message<"metalstack.infra.v2.SwitchS
79
79
  */
80
80
  export declare const SwitchServiceRegisterResponseSchema: GenMessage<SwitchServiceRegisterResponse>;
81
81
  /**
82
- * SwitchServiceHeartbeatRequest.
82
+ * SwitchServiceHeartbeatRequest is the request payload for sending a switch heartbeat.
83
83
  *
84
84
  * @generated from message metalstack.infra.v2.SwitchServiceHeartbeatRequest
85
85
  */
86
86
  export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchServiceHeartbeatRequest"> & {
87
87
  /**
88
- * Id of the switch.
88
+ * Id of the switch
89
89
  *
90
90
  * @generated from field: string id = 1;
91
91
  */
92
92
  id: string;
93
93
  /**
94
- * Duration of the sync.
94
+ * Duration of the sync
95
95
  *
96
96
  * @generated from field: google.protobuf.Duration duration = 2;
97
97
  */
98
98
  duration?: Duration;
99
99
  /**
100
- * Error if any occurred during the sync.
100
+ * Error if any occurred during the sync
101
101
  *
102
102
  * @generated from field: optional string error = 3;
103
103
  */
104
104
  error?: string;
105
105
  /**
106
- * PortStates maps port identifiers to the respective port's operational state.
106
+ * PortStates maps port identifiers to the respective port's operational state
107
107
  *
108
108
  * @generated from field: map<string, metalstack.api.v2.SwitchPortStatus> port_states = 4;
109
109
  */
@@ -111,7 +111,7 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS
111
111
  [key: string]: SwitchPortStatus;
112
112
  };
113
113
  /**
114
- * BgpPortStates maps port identifiers to the respective port's BGP state.
114
+ * BgpPortStates maps port identifiers to the respective port's BGP state
115
115
  *
116
116
  * @generated from field: map<string, metalstack.api.v2.SwitchBGPPortState> bgp_port_states = 5;
117
117
  */
@@ -125,25 +125,25 @@ export type SwitchServiceHeartbeatRequest = Message<"metalstack.infra.v2.SwitchS
125
125
  */
126
126
  export declare const SwitchServiceHeartbeatRequestSchema: GenMessage<SwitchServiceHeartbeatRequest>;
127
127
  /**
128
- * SwitchServiceHeartbeatResponse.
128
+ * SwitchServiceHeartbeatResponse is the response payload for sending a switch heartbeat.
129
129
  *
130
130
  * @generated from message metalstack.infra.v2.SwitchServiceHeartbeatResponse
131
131
  */
132
132
  export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.SwitchServiceHeartbeatResponse"> & {
133
133
  /**
134
- * Id of the switch.
134
+ * Id of the switch
135
135
  *
136
136
  * @generated from field: string id = 1;
137
137
  */
138
138
  id: string;
139
139
  /**
140
- * LastSync holds information about the last sync.
140
+ * LastSync holds information about the last sync
141
141
  *
142
142
  * @generated from field: metalstack.api.v2.SwitchSync last_sync = 2;
143
143
  */
144
144
  lastSync?: SwitchSync;
145
145
  /**
146
- * LastSyncError holds information about the last erroneous sync.
146
+ * LastSyncError holds information about the last erroneous sync
147
147
  *
148
148
  * @generated from field: metalstack.api.v2.SwitchSync last_sync_error = 3;
149
149
  */
@@ -155,13 +155,13 @@ export type SwitchServiceHeartbeatResponse = Message<"metalstack.infra.v2.Switch
155
155
  */
156
156
  export declare const SwitchServiceHeartbeatResponseSchema: GenMessage<SwitchServiceHeartbeatResponse>;
157
157
  /**
158
- * SwitchService serves switch related functions.
158
+ * SwitchService provides infrastructure switch management operations.
159
159
  *
160
160
  * @generated from service metalstack.infra.v2.SwitchService
161
161
  */
162
162
  export declare const SwitchService: GenService<{
163
163
  /**
164
- * Get a switch by ID.
164
+ * Returns the switch with the specified ID.
165
165
  *
166
166
  * @generated from rpc metalstack.infra.v2.SwitchService.Get
167
167
  */
@@ -171,7 +171,7 @@ export declare const SwitchService: GenService<{
171
171
  output: typeof SwitchServiceGetResponseSchema;
172
172
  };
173
173
  /**
174
- * Register a switch.
174
+ * Registers a switch.
175
175
  *
176
176
  * @generated from rpc metalstack.infra.v2.SwitchService.Register
177
177
  */
@@ -181,7 +181,7 @@ export declare const SwitchService: GenService<{
181
181
  output: typeof SwitchServiceRegisterResponseSchema;
182
182
  };
183
183
  /**
184
- * Heartbeat a switch.
184
+ * Heartbeat sends a heartbeat from a switch.
185
185
  *
186
186
  * @generated from rpc metalstack.infra.v2.SwitchService.Heartbeat
187
187
  */
@@ -42,7 +42,7 @@ export const SwitchServiceHeartbeatRequestSchema = /*@__PURE__*/ messageDesc(fil
42
42
  */
43
43
  export const SwitchServiceHeartbeatResponseSchema = /*@__PURE__*/ messageDesc(file_metalstack_infra_v2_switch, 5);
44
44
  /**
45
- * SwitchService serves switch related functions.
45
+ * SwitchService provides infrastructure switch management operations.
46
46
  *
47
47
  * @generated from service metalstack.infra.v2.SwitchService
48
48
  */