-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
service.proto
739 lines (655 loc) · 29.9 KB
/
service.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.video.livestream.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/resource.proto";
import "google/cloud/video/livestream/v1/resources.proto";
import "google/longrunning/operations.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
import "google/protobuf/timestamp.proto";
option csharp_namespace = "Google.Cloud.Video.LiveStream.V1";
option go_package = "cloud.google.com/go/video/livestream/apiv1/livestreampb;livestreampb";
option java_multiple_files = true;
option java_outer_classname = "ServiceProto";
option java_package = "com.google.cloud.video.livestream.v1";
option php_namespace = "Google\\Cloud\\Video\\LiveStream\\V1";
option ruby_package = "Google::Cloud::Video::LiveStream::V1";
option (google.api.resource_definition) = {
type: "secretmanager.googleapis.com/SecretVersion"
pattern: "projects/{project}/secrets/{secret}/versions/{version}"
};
// Using Live Stream API, you can generate live streams in the various
// renditions and streaming formats. The streaming format include HTTP Live
// Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send
// a source stream in the various ways, including Real-Time Messaging
// Protocol (RTMP) and Secure Reliable Transport (SRT).
service LivestreamService {
option (google.api.default_host) = "livestream.googleapis.com";
option (google.api.oauth_scopes) =
"https://www.googleapis.com/auth/cloud-platform";
// Creates a channel with the provided unique ID in the specified
// region.
rpc CreateChannel(CreateChannelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/channels"
body: "channel"
};
option (google.api.method_signature) = "parent,channel,channel_id";
option (google.longrunning.operation_info) = {
response_type: "Channel"
metadata_type: "OperationMetadata"
};
}
// Returns a list of all channels in the specified region.
rpc ListChannels(ListChannelsRequest) returns (ListChannelsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/channels"
};
option (google.api.method_signature) = "parent";
}
// Returns the specified channel.
rpc GetChannel(GetChannelRequest) returns (Channel) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/channels/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes the specified channel.
rpc DeleteChannel(DeleteChannelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/channels/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Updates the specified channel.
rpc UpdateChannel(UpdateChannelRequest)
returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{channel.name=projects/*/locations/*/channels/*}"
body: "channel"
};
option (google.api.method_signature) = "channel,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Channel"
metadata_type: "OperationMetadata"
};
}
// Starts the specified channel. Part of the video pipeline will be created
// only when the StartChannel request is received by the server.
rpc StartChannel(StartChannelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/channels/*}:start"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "ChannelOperationResponse"
metadata_type: "OperationMetadata"
};
}
// Stops the specified channel. Part of the video pipeline will be released
// when the StopChannel request is received by the server.
rpc StopChannel(StopChannelRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/channels/*}:stop"
body: "*"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "ChannelOperationResponse"
metadata_type: "OperationMetadata"
};
}
// Creates an input with the provided unique ID in the specified region.
rpc CreateInput(CreateInputRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/inputs"
body: "input"
};
option (google.api.method_signature) = "parent,input,input_id";
option (google.longrunning.operation_info) = {
response_type: "Input"
metadata_type: "OperationMetadata"
};
}
// Returns a list of all inputs in the specified region.
rpc ListInputs(ListInputsRequest) returns (ListInputsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/inputs"
};
option (google.api.method_signature) = "parent";
}
// Returns the specified input.
rpc GetInput(GetInputRequest) returns (Input) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/inputs/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes the specified input.
rpc DeleteInput(DeleteInputRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/inputs/*}"
};
option (google.api.method_signature) = "name";
option (google.longrunning.operation_info) = {
response_type: "google.protobuf.Empty"
metadata_type: "OperationMetadata"
};
}
// Updates the specified input.
rpc UpdateInput(UpdateInputRequest) returns (google.longrunning.Operation) {
option (google.api.http) = {
patch: "/v1/{input.name=projects/*/locations/*/inputs/*}"
body: "input"
};
option (google.api.method_signature) = "input,update_mask";
option (google.longrunning.operation_info) = {
response_type: "Input"
metadata_type: "OperationMetadata"
};
}
// Creates an event with the provided unique ID in the specified channel.
rpc CreateEvent(CreateEventRequest) returns (Event) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/channels/*}/events"
body: "event"
};
option (google.api.method_signature) = "parent,event,event_id";
}
// Returns a list of all events in the specified channel.
rpc ListEvents(ListEventsRequest) returns (ListEventsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/channels/*}/events"
};
option (google.api.method_signature) = "parent";
}
// Returns the specified event.
rpc GetEvent(GetEventRequest) returns (Event) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/channels/*/events/*}"
};
option (google.api.method_signature) = "name";
}
// Deletes the specified event.
rpc DeleteEvent(DeleteEventRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/channels/*/events/*}"
};
option (google.api.method_signature) = "name";
}
}
// Request message for "LivestreamService.CreateChannel".
message CreateChannelRequest {
// Required. The parent location for the resource, in the form of:
// `projects/{project}/locations/{location}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Channel"
}
];
// Required. The channel resource to be created.
Channel channel = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID of the channel resource to be created.
// This value must be 1-63 characters, begin and end with `[a-z0-9]`,
// could contain dashes (-) in between.
string channel_id = 3 [(google.api.field_behavior) = REQUIRED];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 4;
}
// Request message for "LivestreamService.ListChannels".
message ListChannelsRequest {
// Required. The parent location for the resource, in the form of:
// `projects/{project}/locations/{location}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Channel"
}
];
// The maximum number of items to return. If unspecified, server
// will pick an appropriate default. Server may return fewer items than
// requested. A caller should only rely on response's
// [next_page_token][google.cloud.video.livestream.v1.ListChannelsResponse.next_page_token]
// to determine if there are more items left to be queried.
int32 page_size = 2;
// The next_page_token value returned from a previous List request, if any.
string page_token = 3;
// The filter to apply to list results.
string filter = 4;
// Specifies the ordering of results following syntax at
// https://cloud.google.com/apis/design/design_patterns#sorting_order.
string order_by = 5;
}
// Response message for "LivestreamService.ListChannels".
message ListChannelsResponse {
// A list of channels.
repeated Channel channels = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request message for "LivestreamService.GetChannel".
message GetChannelRequest {
// Required. The name of the channel resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Channel"
}
];
}
// Request message for "LivestreamService.DeleteChannel".
message DeleteChannelRequest {
// Required. The name of the channel resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Channel"
}
];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes after the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 2;
// If the `force` field is set to the default value of `false`, you must
// delete all of a channel's events before you can delete the channel itself.
// If the field is set to `true`, requests to delete a channel also delete
// associated channel events.
bool force = 3;
}
// Request message for "LivestreamService.UpdateChannel".
message UpdateChannelRequest {
// Field mask is used to specify the fields to be overwritten in the Channel
// resource by the update. You can only update the following fields:
//
// * [`inputAttachments`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputattachment)
// * [`inputConfig`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#inputconfig)
// * [`output`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#output)
// * [`elementaryStreams`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#elementarystream)
// * [`muxStreams`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#muxstream)
// * [`manifests`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#manifest)
// * [`spriteSheets`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#spritesheet)
// * [`logConfig`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#logconfig)
// * [`timecodeConfig`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#timecodeconfig)
// * [`encryptions`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.channels#encryption)
//
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it is in the mask.
//
// If the mask is not present, then each field from the list above is updated
// if the field appears in the request payload. To unset a field, add the
// field to the update mask and remove it from the request payload.
google.protobuf.FieldMask update_mask = 1;
// Required. The channel resource to be updated.
Channel channel = 2 [(google.api.field_behavior) = REQUIRED];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 3;
}
// Request message for "LivestreamService.StartChannel".
message StartChannelRequest {
// Required. The name of the channel resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Channel"
}
];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 2;
}
// Request message for "LivestreamService.StopChannel".
message StopChannelRequest {
// Required. The name of the channel resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Channel"
}
];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 2;
}
// Request message for "LivestreamService.CreateInput".
message CreateInputRequest {
// Required. The parent location for the resource, in the form of:
// `projects/{project}/locations/{location}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Input"
}
];
// Required. The input resource to be created.
Input input = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID of the input resource to be created.
// This value must be 1-63 characters, begin and end with `[a-z0-9]`,
// could contain dashes (-) in between.
string input_id = 3 [(google.api.field_behavior) = REQUIRED];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 4;
}
// Request message for "LivestreamService.ListInputs".
message ListInputsRequest {
// Required. The parent location for the resource, in the form of:
// `projects/{project}/locations/{location}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Input"
}
];
// The maximum number of items to return. If unspecified, server
// will pick an appropriate default. Server may return fewer items than
// requested. A caller should only rely on response's
// [next_page_token][google.cloud.video.livestream.v1.ListInputsResponse.next_page_token]
// to determine if there are more items left to be queried.
int32 page_size = 2;
// The next_page_token value returned from a previous List request, if any.
string page_token = 3;
// The filter to apply to list results.
string filter = 4;
// Specifies the ordering of results following syntax at [Sorting
// Order](https://cloud.google.com/apis/design/design_patterns#sorting_order).
string order_by = 5;
}
// Response message for "LivestreamService.ListInputs".
message ListInputsResponse {
// A list of inputs.
repeated Input inputs = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request message for "LivestreamService.GetInput".
message GetInputRequest {
// Required. The name of the input resource, in the form of:
// `projects/{project}/locations/{location}/inputs/{inputId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Input"
}
];
}
// Request message for "LivestreamService.DeleteInput".
message DeleteInputRequest {
// Required. The name of the input resource, in the form of:
// `projects/{project}/locations/{location}/inputs/{inputId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Input"
}
];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 2;
}
// Request message for "LivestreamService.UpdateInput".
message UpdateInputRequest {
// Field mask is used to specify the fields to be overwritten in the Input
// resource by the update. You can only update the following fields:
//
// * [`preprocessingConfig`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#PreprocessingConfig)
// * [`securityRules`](https://cloud.google.com/livestream/docs/reference/rest/v1/projects.locations.inputs#SecurityRule)
//
// The fields specified in the update_mask are relative to the resource, not
// the full request. A field will be overwritten if it is in the mask.
//
// If the mask is not present, then each field from the list above is updated
// if the field appears in the request payload. To unset a field, add the
// field to the update mask and remove it from the request payload.
google.protobuf.FieldMask update_mask = 1;
// Required. The input resource to be updated.
Input input = 2 [(google.api.field_behavior) = REQUIRED];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 3;
}
// Request message for "LivestreamService.CreateEvent".
message CreateEventRequest {
// Required. The parent channel for the resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Event"
}
];
// Required. The event resource to be created.
Event event = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID of the event resource to be created.
// This value must be 1-63 characters, begin and end with `[a-z0-9]`,
// could contain dashes (-) in between.
string event_id = 3 [(google.api.field_behavior) = REQUIRED];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 4;
}
// Request message for "LivestreamService.ListEvents".
message ListEventsRequest {
// Required. The parent channel for the resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}`.
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "livestream.googleapis.com/Event"
}
];
// The maximum number of items to return. If unspecified, server
// will pick an appropriate default. Server may return fewer items than
// requested. A caller should only rely on response's
// [next_page_token][google.cloud.video.livestream.v1.ListEventsResponse.next_page_token]
// to determine if there are more items left to be queried.
int32 page_size = 2;
// The next_page_token value returned from a previous List request, if any.
string page_token = 3;
// The filter to apply to list results.
string filter = 4;
// Specifies the ordering of results following syntax at
// https://cloud.google.com/apis/design/design_patterns#sorting_order.
string order_by = 5;
}
// Response message for "LivestreamService.ListEvents".
message ListEventsResponse {
// A list of events.
repeated Event events = 1;
// Token to retrieve the next page of results, or empty if there are no more
// results in the list.
string next_page_token = 2;
// Locations that could not be reached.
repeated string unreachable = 3;
}
// Request message for "LivestreamService.GetEvent".
message GetEventRequest {
// Required. The name of the event resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Event"
}
];
}
// Request message for "LivestreamService.DeleteEvent".
message DeleteEventRequest {
// Required. The name of the event resource, in the form of:
// `projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}`.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "livestream.googleapis.com/Event"
}
];
// A request ID to identify requests. Specify a unique request ID
// so that if you must retry your request, the server will know to ignore
// the request if it has already been completed. The server will guarantee
// that for at least 60 minutes since the first request.
//
// For example, consider a situation where you make an initial request and the
// request times out. If you make the request again with the same request ID,
// the server can check if original operation with the same request ID was
// received, and if so, will ignore the second request. This prevents clients
// from accidentally creating duplicate commitments.
//
// The request ID must be a valid UUID with the exception that zero UUID is
// not supported `(00000000-0000-0000-0000-000000000000)`.
string request_id = 2;
}
// Response message for Start/Stop Channel long-running operations.
message ChannelOperationResponse {}
// Represents the metadata of the long-running operation.
message OperationMetadata {
// Output only. The time the operation was created.
google.protobuf.Timestamp create_time = 1
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. The time the operation finished running.
google.protobuf.Timestamp end_time = 2
[(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Server-defined resource path for the target of the operation.
string target = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Name of the verb executed by the operation.
string verb = 4 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. Identifies whether the user has requested cancellation
// of the operation. Operations that have successfully been cancelled
// have [Operation.error][] value with a
// [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to
// `Code.CANCELLED`.
bool requested_cancellation = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
// Output only. API version used to start the operation.
string api_version = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
}