Skip to content

Commit 461d6cf

Browse files
Mike ProsserMike Prosser
authored andcommitted
update to latest proto files
1 parent 5ade5a6 commit 461d6cf

12 files changed

+163
-147
lines changed

protos/ni/panels/v1/panel_service.proto

Lines changed: 33 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ option ruby_package = "NI::Panels::V1";
1818
service PanelService {
1919
// Start a panel using the provided configuration (or connect to if it has already been started)
2020
// Status Codes for errors:
21-
// - INVALID_ARGUMENT:
22-
// - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
21+
// - INVALID_ARGUMENT:
22+
// - The panel identifier contains invalid characters.
2323
// - The panel configuration has an invalid argument.
24-
// - NOT_FOUND:
24+
// - NOT_FOUND:
2525
// - The panel configuration includes a file that was not found.
2626
rpc StartPanel(StartPanelRequest) returns (StartPanelResponse);
2727

2828
// Stop a panel
2929
// Status Codes for errors:
3030
// - INVALID_ARGUMENT:
31-
// - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
31+
// - The panel identifier contains invalid characters.
3232
rpc StopPanel(StopPanelRequest) returns (StopPanelResponse);
3333

3434
// Enumerate the panels available in the system, including information about the state of the panels and what values they have.
@@ -37,43 +37,43 @@ service PanelService {
3737

3838
// Get a value for a control on the panel
3939
// Status Codes for errors:
40-
// - INVALID_ARGUMENT:
41-
// - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
42-
// - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
43-
// - NOT_FOUND:
40+
// - INVALID_ARGUMENT:
41+
// - The panel identifier contains invalid characters.
42+
// - The value identifier contains invalid characters.
43+
// - NOT_FOUND:
4444
// - The value with the specified identifier was not found.
4545
rpc GetValue(GetValueRequest) returns (GetValueResponse);
4646

4747
// Try to get a value for a control on the panel
4848
// Status Codes for errors:
49-
// - INVALID_ARGUMENT:
50-
// - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
51-
// - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
49+
// - INVALID_ARGUMENT:
50+
// - The panel identifier contains invalid characters.
51+
// - The value identifier contains invalid characters.
5252
rpc TryGetValue(TryGetValueRequest) returns (TryGetValueResponse);
5353

5454
// Set a value for a control on the panel
5555
// Status Codes for errors:
56-
// - INVALID_ARGUMENT:
57-
// - The panel identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
58-
// - The value identifier contains invalid characters. Only alphanumeric characters and underscores are allowed.
56+
// - INVALID_ARGUMENT:
57+
// - The panel identifier contains invalid characters.
58+
// - The value identifier contains invalid characters.
5959
rpc SetValue(SetValueRequest) returns (SetValueResponse);
6060
}
6161

6262
message StartPanelRequest {
63-
// Unique ID of the panel
63+
// Unique ID of the panel. Only alphanumeric characters and underscores are allowed.
6464
string panel_id = 1;
6565

66-
// Configuration for the panel, packed as Any
66+
// Configuration for the panel, packed as a google.protobuf.Any
6767
google.protobuf.Any panel_configuration = 2;
6868
}
6969

7070
message StartPanelResponse {
71-
// Location of the panel
72-
string panel_uri = 1;
71+
// Location of the panel
72+
string panel_url = 1;
7373
}
7474

7575
message StopPanelRequest {
76-
// Unique ID of the panel
76+
// Unique ID of the panel. Only alphanumeric characters and underscores are allowed.
7777
string panel_id = 1;
7878

7979
// Reset all storage associated with panel
@@ -91,7 +91,7 @@ message PanelInformation {
9191
string panel_id = 1;
9292

9393
// Location of the panel
94-
string panel_uri = 2;
94+
string panel_url = 2;
9595

9696
// IDs of all of the values associated with the panel
9797
repeated string value_ids = 3;
@@ -103,39 +103,42 @@ message EnumeratePanelsResponse {
103103
}
104104

105105
message GetValueRequest {
106-
// Unique ID of the panel
106+
// Unique ID of the panel. Only alphanumeric characters and underscores are allowed.
107107
string panel_id = 1;
108108

109-
// Unique ID of value
109+
// Unique ID of value. Only alphanumeric characters and underscores are allowed.
110110
string value_id = 2;
111111
}
112112

113113
message GetValueResponse {
114-
// The value
114+
// The value, packed as a google.protobuf.Any.
115+
// Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
115116
google.protobuf.Any value = 1;
116117
}
117118

118119
message TryGetValueRequest {
119-
// Unique ID of the panel
120+
// Unique ID of the panel. Only alphanumeric characters and underscores are allowed.
120121
string panel_id = 1;
121122

122-
// Unique ID of value
123+
// Unique ID of value. Only alphanumeric characters and underscores are allowed.
123124
string value_id = 2;
124125
}
125126

126127
message TryGetValueResponse {
127-
// The value, if it was found
128-
optional google.protobuf.Any value = 1;
128+
// The value (if it was found), packed as a google.protobuf.Any.
129+
// Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
130+
google.protobuf.Any value = 1;
129131
}
130132

131133
message SetValueRequest {
132-
// Unique ID of the panel
134+
// Unique ID of the panel. Only alphanumeric characters and underscores are allowed.
133135
string panel_id = 1;
134136

135-
// Unique ID of the value
137+
// Unique ID of the value. Only alphanumeric characters and underscores are allowed.
136138
string value_id = 2;
137139

138-
// The value
140+
// The value, packed as a google.protobuf.Any.
141+
// Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
139142
google.protobuf.Any value = 3;
140143

141144
// Notify other clients of this new value

protos/ni/panels/v1/streamlit_panel_configuration.proto

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ option php_namespace = "NI\\Panels\\V1";
1313
option ruby_package = "NI::Panels::V1";
1414

1515
// Pack this into PanelService.StartPanelRequest.panel_configuration to start a Streamlit panel.
16-
message StreamlitPanelConfiguration
16+
message StreamlitPanelConfiguration
1717
{
18-
// Absolute path of the streamlit script file on disk, or network path to the file. This must end in ".py".
19-
string panel_script_path = 1;
18+
// Location of the streamlit script file on disk, or network path to the file. This must end in ".py".
19+
string panel_script_url = 1;
2020

21-
// Path to the python interpreter to use for running the streamlit script.
22-
string python_path = 2;
21+
// Location of the python interpreter to use for running the streamlit script.
22+
string python_interpreter_url = 2;
2323
}

src/ni/panels/v1/panel_service_pb2.py

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/ni/panels/v1/panel_service_pb2.pyi

Lines changed: 28 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ class StartPanelRequest(google.protobuf.message.Message):
2020
PANEL_ID_FIELD_NUMBER: builtins.int
2121
PANEL_CONFIGURATION_FIELD_NUMBER: builtins.int
2222
panel_id: builtins.str
23-
"""Unique ID of the panel"""
23+
"""Unique ID of the panel. Only alphanumeric characters and underscores are allowed."""
2424
@property
2525
def panel_configuration(self) -> google.protobuf.any_pb2.Any:
26-
"""Configuration for the panel, packed as Any"""
26+
"""Configuration for the panel, packed as a google.protobuf.Any"""
2727

2828
def __init__(
2929
self,
@@ -40,15 +40,15 @@ global___StartPanelRequest = StartPanelRequest
4040
class StartPanelResponse(google.protobuf.message.Message):
4141
DESCRIPTOR: google.protobuf.descriptor.Descriptor
4242

43-
PANEL_URI_FIELD_NUMBER: builtins.int
44-
panel_uri: builtins.str
43+
PANEL_URL_FIELD_NUMBER: builtins.int
44+
panel_url: builtins.str
4545
"""Location of the panel"""
4646
def __init__(
4747
self,
4848
*,
49-
panel_uri: builtins.str = ...,
49+
panel_url: builtins.str = ...,
5050
) -> None: ...
51-
def ClearField(self, field_name: typing.Literal["panel_uri", b"panel_uri"]) -> None: ...
51+
def ClearField(self, field_name: typing.Literal["panel_url", b"panel_url"]) -> None: ...
5252

5353
global___StartPanelResponse = StartPanelResponse
5454

@@ -59,7 +59,7 @@ class StopPanelRequest(google.protobuf.message.Message):
5959
PANEL_ID_FIELD_NUMBER: builtins.int
6060
RESET_FIELD_NUMBER: builtins.int
6161
panel_id: builtins.str
62-
"""Unique ID of the panel"""
62+
"""Unique ID of the panel. Only alphanumeric characters and underscores are allowed."""
6363
reset: builtins.bool
6464
"""Reset all storage associated with panel"""
6565
def __init__(
@@ -97,11 +97,11 @@ class PanelInformation(google.protobuf.message.Message):
9797
DESCRIPTOR: google.protobuf.descriptor.Descriptor
9898

9999
PANEL_ID_FIELD_NUMBER: builtins.int
100-
PANEL_URI_FIELD_NUMBER: builtins.int
100+
PANEL_URL_FIELD_NUMBER: builtins.int
101101
VALUE_IDS_FIELD_NUMBER: builtins.int
102102
panel_id: builtins.str
103103
"""Unique ID of the panel"""
104-
panel_uri: builtins.str
104+
panel_url: builtins.str
105105
"""Location of the panel"""
106106
@property
107107
def value_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
@@ -111,10 +111,10 @@ class PanelInformation(google.protobuf.message.Message):
111111
self,
112112
*,
113113
panel_id: builtins.str = ...,
114-
panel_uri: builtins.str = ...,
114+
panel_url: builtins.str = ...,
115115
value_ids: collections.abc.Iterable[builtins.str] | None = ...,
116116
) -> None: ...
117-
def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "panel_uri", b"panel_uri", "value_ids", b"value_ids"]) -> None: ...
117+
def ClearField(self, field_name: typing.Literal["panel_id", b"panel_id", "panel_url", b"panel_url", "value_ids", b"value_ids"]) -> None: ...
118118

119119
global___PanelInformation = PanelInformation
120120

@@ -143,9 +143,9 @@ class GetValueRequest(google.protobuf.message.Message):
143143
PANEL_ID_FIELD_NUMBER: builtins.int
144144
VALUE_ID_FIELD_NUMBER: builtins.int
145145
panel_id: builtins.str
146-
"""Unique ID of the panel"""
146+
"""Unique ID of the panel. Only alphanumeric characters and underscores are allowed."""
147147
value_id: builtins.str
148-
"""Unique ID of value"""
148+
"""Unique ID of value. Only alphanumeric characters and underscores are allowed."""
149149
def __init__(
150150
self,
151151
*,
@@ -163,7 +163,9 @@ class GetValueResponse(google.protobuf.message.Message):
163163
VALUE_FIELD_NUMBER: builtins.int
164164
@property
165165
def value(self) -> google.protobuf.any_pb2.Any:
166-
"""The value"""
166+
"""The value, packed as a google.protobuf.Any.
167+
Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
168+
"""
167169

168170
def __init__(
169171
self,
@@ -182,9 +184,9 @@ class TryGetValueRequest(google.protobuf.message.Message):
182184
PANEL_ID_FIELD_NUMBER: builtins.int
183185
VALUE_ID_FIELD_NUMBER: builtins.int
184186
panel_id: builtins.str
185-
"""Unique ID of the panel"""
187+
"""Unique ID of the panel. Only alphanumeric characters and underscores are allowed."""
186188
value_id: builtins.str
187-
"""Unique ID of value"""
189+
"""Unique ID of value. Only alphanumeric characters and underscores are allowed."""
188190
def __init__(
189191
self,
190192
*,
@@ -202,16 +204,17 @@ class TryGetValueResponse(google.protobuf.message.Message):
202204
VALUE_FIELD_NUMBER: builtins.int
203205
@property
204206
def value(self) -> google.protobuf.any_pb2.Any:
205-
"""The value, if it was found"""
207+
"""The value (if it was found), packed as a google.protobuf.Any.
208+
Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
209+
"""
206210

207211
def __init__(
208212
self,
209213
*,
210214
value: google.protobuf.any_pb2.Any | None = ...,
211215
) -> None: ...
212-
def HasField(self, field_name: typing.Literal["_value", b"_value", "value", b"value"]) -> builtins.bool: ...
213-
def ClearField(self, field_name: typing.Literal["_value", b"_value", "value", b"value"]) -> None: ...
214-
def WhichOneof(self, oneof_group: typing.Literal["_value", b"_value"]) -> typing.Literal["value"] | None: ...
216+
def HasField(self, field_name: typing.Literal["value", b"value"]) -> builtins.bool: ...
217+
def ClearField(self, field_name: typing.Literal["value", b"value"]) -> None: ...
215218

216219
global___TryGetValueResponse = TryGetValueResponse
217220

@@ -224,14 +227,16 @@ class SetValueRequest(google.protobuf.message.Message):
224227
VALUE_FIELD_NUMBER: builtins.int
225228
NOTIFY_FIELD_NUMBER: builtins.int
226229
panel_id: builtins.str
227-
"""Unique ID of the panel"""
230+
"""Unique ID of the panel. Only alphanumeric characters and underscores are allowed."""
228231
value_id: builtins.str
229-
"""Unique ID of the value"""
232+
"""Unique ID of the value. Only alphanumeric characters and underscores are allowed."""
230233
notify: builtins.bool
231234
"""Notify other clients of this new value"""
232235
@property
233236
def value(self) -> google.protobuf.any_pb2.Any:
234-
"""The value"""
237+
"""The value, packed as a google.protobuf.Any.
238+
Only types from google/protobuf/wrappers.proto and the ni.protobuf.types package are allowed.
239+
"""
235240

236241
def __init__(
237242
self,

0 commit comments

Comments
 (0)