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
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
/// A schema resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Schema {
/// Required. Name of the schema.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The type of the schema definition.
#[prost(enumeration = "schema::Type", tag = "2")]
pub r#type: i32,
/// The definition of the schema. This should contain a string representing
/// the full definition of the schema that is a valid schema definition of
/// the type specified in `type`.
#[prost(string, tag = "3")]
pub definition: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Schema`.
pub mod schema {
/// Possible schema definition types.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Type {
/// Default value. This value is unused.
Unspecified = 0,
/// A Protocol Buffer schema definition.
ProtocolBuffer = 1,
/// An Avro schema definition.
Avro = 2,
}
}
/// Request for the CreateSchema method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSchemaRequest {
/// Required. The name of the project in which to create the schema.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The schema object to create.
///
/// This schema's `name` parameter is ignored. The schema object returned
/// by CreateSchema will have a `name` made using the given `parent` and
/// `schema_id`.
#[prost(message, optional, tag = "2")]
pub schema: ::core::option::Option<Schema>,
/// The ID to use for the schema, which will become the final component of
/// the schema's resource name.
///
/// See <https://cloud.google.com/pubsub/docs/admin#resource_names> for resource
/// name constraints.
#[prost(string, tag = "3")]
pub schema_id: ::prost::alloc::string::String,
}
/// Request for the GetSchema method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSchemaRequest {
/// Required. The name of the schema to get.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The set of fields to return in the response. If not set, returns a Schema
/// with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all
/// fields.
#[prost(enumeration = "SchemaView", tag = "2")]
pub view: i32,
}
/// Request for the `ListSchemas` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemasRequest {
/// Required. The name of the project in which to list schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The set of Schema fields to return in the response. If not set, returns
/// Schemas with `name` and `type`, but not `definition`. Set to `FULL` to
/// retrieve all fields.
#[prost(enumeration = "SchemaView", tag = "2")]
pub view: i32,
/// Maximum number of schemas to return.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// The value returned by the last `ListSchemasResponse`; indicates that
/// this is a continuation of a prior `ListSchemas` call, and that the
/// system should return the next page of data.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSchemas` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSchemasResponse {
/// The resulting schemas.
#[prost(message, repeated, tag = "1")]
pub schemas: ::prost::alloc::vec::Vec<Schema>,
/// If not empty, indicates that there may be more schemas that match the
/// request; this value should be passed in a new `ListSchemasRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `DeleteSchema` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSchemaRequest {
/// Required. Name of the schema to delete.
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request for the `ValidateSchema` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateSchemaRequest {
/// Required. The name of the project in which to validate schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The schema object to validate.
#[prost(message, optional, tag = "2")]
pub schema: ::core::option::Option<Schema>,
}
/// Response for the `ValidateSchema` method.
/// Empty for now.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateSchemaResponse {}
/// Request for the `ValidateMessage` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateMessageRequest {
/// Required. The name of the project in which to validate schemas.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Message to validate against the provided `schema_spec`.
#[prost(bytes = "bytes", tag = "4")]
pub message: ::prost::bytes::Bytes,
/// The encoding expected for messages
#[prost(enumeration = "Encoding", tag = "5")]
pub encoding: i32,
#[prost(oneof = "validate_message_request::SchemaSpec", tags = "2, 3")]
pub schema_spec: ::core::option::Option<validate_message_request::SchemaSpec>,
}
/// Nested message and enum types in `ValidateMessageRequest`.
pub mod validate_message_request {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum SchemaSpec {
/// Name of the schema against which to validate.
///
/// Format is `projects/{project}/schemas/{schema}`.
#[prost(string, tag = "2")]
Name(::prost::alloc::string::String),
/// Ad-hoc schema against which to validate
#[prost(message, tag = "3")]
Schema(super::Schema),
}
}
/// Response for the `ValidateMessage` method.
/// Empty for now.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ValidateMessageResponse {}
/// View of Schema object fields to be returned by GetSchema and ListSchemas.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum SchemaView {
/// The default / unset value.
/// The API will default to the BASIC view.
Unspecified = 0,
/// Include the name and type of the schema, but not the definition.
Basic = 1,
/// Include all Schema object fields.
Full = 2,
}
/// Possible encoding types for messages.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum Encoding {
/// Unspecified
Unspecified = 0,
/// JSON encoding
Json = 1,
/// Binary encoding, as defined by the schema type. For some schema types,
/// binary encoding may not be available.
Binary = 2,
}
#[doc = r" Generated client implementations."]
pub mod schema_service_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
#[doc = " Service for doing schema-related operations."]
#[derive(Debug, Clone)]
pub struct SchemaServiceClient<T> {
inner: tonic::client::Grpc<T>,
}
impl SchemaServiceClient<tonic::transport::Channel> {
#[doc = r" Attempt to create a new client by connecting to a given endpoint."]
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: std::convert::TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> SchemaServiceClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::ResponseBody: Body + Send + 'static,
T::Error: Into<StdError>,
<T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> SchemaServiceClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<http::Request<tonic::body::BoxBody>>>::Error:
Into<StdError> + Send + Sync,
{
SchemaServiceClient::new(InterceptedService::new(inner, interceptor))
}
#[doc = r" Compress requests with `gzip`."]
#[doc = r""]
#[doc = r" This requires the server to support it otherwise it might respond with an"]
#[doc = r" error."]
pub fn send_gzip(mut self) -> Self {
self.inner = self.inner.send_gzip();
self
}
#[doc = r" Enable decompressing responses with `gzip`."]
pub fn accept_gzip(mut self) -> Self {
self.inner = self.inner.accept_gzip();
self
}
#[doc = " Creates a schema."]
pub async fn create_schema(
&mut self,
request: impl tonic::IntoRequest<super::CreateSchemaRequest>,
) -> Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/CreateSchema",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Gets a schema."]
pub async fn get_schema(
&mut self,
request: impl tonic::IntoRequest<super::GetSchemaRequest>,
) -> Result<tonic::Response<super::Schema>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.SchemaService/GetSchema");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists schemas in a project."]
pub async fn list_schemas(
&mut self,
request: impl tonic::IntoRequest<super::ListSchemasRequest>,
) -> Result<tonic::Response<super::ListSchemasResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.SchemaService/ListSchemas");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Deletes a schema."]
pub async fn delete_schema(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSchemaRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/DeleteSchema",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Validates a schema."]
pub async fn validate_schema(
&mut self,
request: impl tonic::IntoRequest<super::ValidateSchemaRequest>,
) -> Result<tonic::Response<super::ValidateSchemaResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ValidateSchema",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Validates a message against a schema."]
pub async fn validate_message(
&mut self,
request: impl tonic::IntoRequest<super::ValidateMessageRequest>,
) -> Result<tonic::Response<super::ValidateMessageResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.SchemaService/ValidateMessage",
);
self.inner.unary(request.into_request(), path, codec).await
}
}
}
/// A policy constraining the storage of messages published to the topic.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct MessageStoragePolicy {
/// A list of IDs of GCP regions where messages that are published to the topic
/// may be persisted in storage. Messages published by publishers running in
/// non-allowed GCP regions (or running outside of GCP altogether) will be
/// routed for storage in one of the allowed regions. An empty list means that
/// no regions are allowed, and is not a valid configuration.
#[prost(string, repeated, tag = "1")]
pub allowed_persistence_regions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Settings for validating messages published against a schema.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SchemaSettings {
/// Required. The name of the schema that messages published should be
/// validated against. Format is `projects/{project}/schemas/{schema}`. The
/// value of this field will be `_deleted-schema_` if the schema has been
/// deleted.
#[prost(string, tag = "1")]
pub schema: ::prost::alloc::string::String,
/// The encoding of messages validated against `schema`.
#[prost(enumeration = "Encoding", tag = "2")]
pub encoding: i32,
}
/// A topic resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Topic {
/// Required. The name of the topic. It must have the format
/// `"projects/{project}/topics/{topic}"`. `{topic}` must start with a letter,
/// and contain only letters (`\[A-Za-z\]`), numbers (`\[0-9\]`), dashes (`-`),
/// underscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent
/// signs (`%`). It must be between 3 and 255 characters in length, and it
/// must not start with `"goog"`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// See [Creating and managing labels]
/// (<https://cloud.google.com/pubsub/docs/labels>).
#[prost(map = "string, string", tag = "2")]
pub labels:
::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
/// Policy constraining the set of Google Cloud Platform regions where messages
/// published to the topic may be stored. If not present, then no constraints
/// are in effect.
#[prost(message, optional, tag = "3")]
pub message_storage_policy: ::core::option::Option<MessageStoragePolicy>,
/// The resource name of the Cloud KMS CryptoKey to be used to protect access
/// to messages published on this topic.
///
/// The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
#[prost(string, tag = "5")]
pub kms_key_name: ::prost::alloc::string::String,
/// Settings for validating messages published against a schema.
#[prost(message, optional, tag = "6")]
pub schema_settings: ::core::option::Option<SchemaSettings>,
/// Reserved for future use. This field is set only in responses from the
/// server; it is ignored if it is set in any requests.
#[prost(bool, tag = "7")]
pub satisfies_pzs: bool,
/// Indicates the minimum duration to retain a message after it is published to
/// the topic. If this field is set, messages published to the topic in the
/// last `message_retention_duration` are always available to subscribers. For
/// instance, it allows any attached subscription to [seek to a
/// timestamp](<https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time>)
/// that is up to `message_retention_duration` in the past. If this field is
/// not set, message retention is controlled by settings on individual
/// subscriptions. Cannot be more than 7 days or less than 10 minutes.
#[prost(message, optional, tag = "8")]
pub message_retention_duration: ::core::option::Option<::prost_types::Duration>,
}
/// A message that is published by publishers and consumed by subscribers. The
/// message must contain either a non-empty data field or at least one attribute.
/// Note that client libraries represent this object differently
/// depending on the language. See the corresponding [client library
/// documentation](<https://cloud.google.com/pubsub/docs/reference/libraries>) for
/// more information. See [quotas and limits]
/// (<https://cloud.google.com/pubsub/quotas>) for more information about message
/// limits.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PubsubMessage {
/// The message data field. If this field is empty, the message must contain
/// at least one attribute.
#[prost(bytes = "bytes", tag = "1")]
pub data: ::prost::bytes::Bytes,
/// Attributes for this message. If this field is empty, the message must
/// contain non-empty data. This can be used to filter messages on the
/// subscription.
#[prost(btree_map = "string, string", tag = "2")]
pub attributes: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// ID of this message, assigned by the server when the message is published.
/// Guaranteed to be unique within the topic. This value may be read by a
/// subscriber that receives a `PubsubMessage` via a `Pull` call or a push
/// delivery. It must not be populated by the publisher in a `Publish` call.
#[prost(string, tag = "3")]
pub message_id: ::prost::alloc::string::String,
/// The time at which the message was published, populated by the server when
/// it receives the `Publish` call. It must not be populated by the
/// publisher in a `Publish` call.
#[prost(message, optional, tag = "4")]
pub publish_time: ::core::option::Option<::prost_types::Timestamp>,
/// If non-empty, identifies related messages for which publish order should be
/// respected. If a `Subscription` has `enable_message_ordering` set to `true`,
/// messages published with the same non-empty `ordering_key` value will be
/// delivered to subscribers in the order in which they are received by the
/// Pub/Sub system. All `PubsubMessage`s published in a given `PublishRequest`
/// must specify the same `ordering_key` value.
#[prost(string, tag = "5")]
pub ordering_key: ::prost::alloc::string::String,
}
/// Request for the GetTopic method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTopicRequest {
/// Required. The name of the topic to get.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
}
/// Request for the UpdateTopic method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateTopicRequest {
/// Required. The updated topic object.
#[prost(message, optional, tag = "1")]
pub topic: ::core::option::Option<Topic>,
/// Required. Indicates which fields in the provided topic to update. Must be
/// specified and non-empty. Note that if `update_mask` contains
/// "message_storage_policy" but the `message_storage_policy` is not set in
/// the `topic` provided above, then the updated value is determined by the
/// policy configured at the project or organization level.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for the Publish method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublishRequest {
/// Required. The messages in the request will be published on this topic.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Required. The messages to publish.
#[prost(message, repeated, tag = "2")]
pub messages: ::prost::alloc::vec::Vec<PubsubMessage>,
}
/// Response for the `Publish` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublishResponse {
/// The server-assigned ID of each published message, in the same order as
/// the messages in the request. IDs are guaranteed to be unique within
/// the topic.
#[prost(string, repeated, tag = "1")]
pub message_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request for the `ListTopics` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicsRequest {
/// Required. The name of the project in which to list topics.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Maximum number of topics to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListTopicsResponse`; indicates that this is
/// a continuation of a prior `ListTopics` call, and that the system should
/// return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopics` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicsResponse {
/// The resulting topics.
#[prost(message, repeated, tag = "1")]
pub topics: ::prost::alloc::vec::Vec<Topic>,
/// If not empty, indicates that there may be more topics that match the
/// request; this value should be passed in a new `ListTopicsRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `ListTopicSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSubscriptionsRequest {
/// Required. The name of the topic that subscriptions are attached to.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Maximum number of subscription names to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListTopicSubscriptionsResponse`; indicates
/// that this is a continuation of a prior `ListTopicSubscriptions` call, and
/// that the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopicSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSubscriptionsResponse {
/// The names of subscriptions attached to the topic specified in the request.
#[prost(string, repeated, tag = "1")]
pub subscriptions: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// If not empty, indicates that there may be more subscriptions that match
/// the request; this value should be passed in a new
/// `ListTopicSubscriptionsRequest` to get more subscriptions.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `ListTopicSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSnapshotsRequest {
/// Required. The name of the topic that snapshots are attached to.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
/// Maximum number of snapshot names to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListTopicSnapshotsResponse`; indicates
/// that this is a continuation of a prior `ListTopicSnapshots` call, and
/// that the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListTopicSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTopicSnapshotsResponse {
/// The names of the snapshots that match the request.
#[prost(string, repeated, tag = "1")]
pub snapshots: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// If not empty, indicates that there may be more snapshots that match
/// the request; this value should be passed in a new
/// `ListTopicSnapshotsRequest` to get more snapshots.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `DeleteTopic` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTopicRequest {
/// Required. Name of the topic to delete.
/// Format is `projects/{project}/topics/{topic}`.
#[prost(string, tag = "1")]
pub topic: ::prost::alloc::string::String,
}
/// Request for the DetachSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DetachSubscriptionRequest {
/// Required. The subscription to detach.
/// Format is `projects/{project}/subscriptions/{subscription}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Response for the DetachSubscription method.
/// Reserved for future use.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DetachSubscriptionResponse {}
/// A subscription resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Subscription {
/// Required. The name of the subscription. It must have the format
/// `"projects/{project}/subscriptions/{subscription}"`. `{subscription}` must
/// start with a letter, and contain only letters (`\[A-Za-z\]`), numbers
/// (`\[0-9\]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),
/// plus (`+`) or percent signs (`%`). It must be between 3 and 255 characters
/// in length, and it must not start with `"goog"`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The name of the topic from which this subscription is receiving
/// messages. Format is `projects/{project}/topics/{topic}`. The value of this
/// field will be `_deleted-topic_` if the topic has been deleted.
#[prost(string, tag = "2")]
pub topic: ::prost::alloc::string::String,
/// If push delivery is used with this subscription, this field is
/// used to configure it. An empty `pushConfig` signifies that the subscriber
/// will pull and ack messages using API methods.
#[prost(message, optional, tag = "4")]
pub push_config: ::core::option::Option<PushConfig>,
/// The approximate amount of time (on a best-effort basis) Pub/Sub waits for
/// the subscriber to acknowledge receipt before resending the message. In the
/// interval after the message is delivered and before it is acknowledged, it
/// is considered to be <i>outstanding</i>. During that time period, the
/// message will not be redelivered (on a best-effort basis).
///
/// For pull subscriptions, this value is used as the initial value for the ack
/// deadline. To override this value for a given message, call
/// `ModifyAckDeadline` with the corresponding `ack_id` if using
/// non-streaming pull or send the `ack_id` in a
/// `StreamingModifyAckDeadlineRequest` if using streaming pull.
/// The minimum custom deadline you can specify is 10 seconds.
/// The maximum custom deadline you can specify is 600 seconds (10 minutes).
/// If this parameter is 0, a default value of 10 seconds is used.
///
/// For push delivery, this value is also used to set the request timeout for
/// the call to the push endpoint.
///
/// If the subscriber never acknowledges the message, the Pub/Sub
/// system will eventually redeliver the message.
#[prost(int32, tag = "5")]
pub ack_deadline_seconds: i32,
/// Indicates whether to retain acknowledged messages. If true, then
/// messages are not expunged from the subscription's backlog, even if they are
/// acknowledged, until they fall out of the `message_retention_duration`
/// window. This must be true if you would like to [`Seek` to a timestamp]
/// (<https://cloud.google.com/pubsub/docs/replay-overview#seek_to_a_time>) in
/// the past to replay previously-acknowledged messages.
#[prost(bool, tag = "7")]
pub retain_acked_messages: bool,
/// How long to retain unacknowledged messages in the subscription's backlog,
/// from the moment a message is published.
/// If `retain_acked_messages` is true, then this also configures the retention
/// of acknowledged messages, and thus configures how far back in time a `Seek`
/// can be done. Defaults to 7 days. Cannot be more than 7 days or less than 10
/// minutes.
#[prost(message, optional, tag = "8")]
pub message_retention_duration: ::core::option::Option<::prost_types::Duration>,
/// See <a href="<https://cloud.google.com/pubsub/docs/labels">> Creating and
/// managing labels</a>.
#[prost(map = "string, string", tag = "9")]
pub labels:
::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
/// If true, messages published with the same `ordering_key` in `PubsubMessage`
/// will be delivered to the subscribers in the order in which they
/// are received by the Pub/Sub system. Otherwise, they may be delivered in
/// any order.
#[prost(bool, tag = "10")]
pub enable_message_ordering: bool,
/// A policy that specifies the conditions for this subscription's expiration.
/// A subscription is considered active as long as any connected subscriber is
/// successfully consuming messages from the subscription or is issuing
/// operations on the subscription. If `expiration_policy` is not set, a
/// *default policy* with `ttl` of 31 days will be used. The minimum allowed
/// value for `expiration_policy.ttl` is 1 day.
#[prost(message, optional, tag = "11")]
pub expiration_policy: ::core::option::Option<ExpirationPolicy>,
/// An expression written in the Pub/Sub [filter
/// language](<https://cloud.google.com/pubsub/docs/filtering>). If non-empty,
/// then only `PubsubMessage`s whose `attributes` field matches the filter are
/// delivered on this subscription. If empty, then no messages are filtered
/// out.
#[prost(string, tag = "12")]
pub filter: ::prost::alloc::string::String,
/// A policy that specifies the conditions for dead lettering messages in
/// this subscription. If dead_letter_policy is not set, dead lettering
/// is disabled.
///
/// The Cloud Pub/Sub service account associated with this subscriptions's
/// parent project (i.e.,
/// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
/// permission to Acknowledge() messages on this subscription.
#[prost(message, optional, tag = "13")]
pub dead_letter_policy: ::core::option::Option<DeadLetterPolicy>,
/// A policy that specifies how Pub/Sub retries message delivery for this
/// subscription.
///
/// If not set, the default retry policy is applied. This generally implies
/// that messages will be retried as soon as possible for healthy subscribers.
/// RetryPolicy will be triggered on NACKs or acknowledgement deadline
/// exceeded events for a given message.
#[prost(message, optional, tag = "14")]
pub retry_policy: ::core::option::Option<RetryPolicy>,
/// Indicates whether the subscription is detached from its topic. Detached
/// subscriptions don't receive messages from their topic and don't retain any
/// backlog. `Pull` and `StreamingPull` requests will return
/// FAILED_PRECONDITION. If the subscription is a push subscription, pushes to
/// the endpoint will not be made.
#[prost(bool, tag = "15")]
pub detached: bool,
/// Output only. Indicates the minimum duration for which a message is retained
/// after it is published to the subscription's topic. If this field is set,
/// messages published to the subscription's topic in the last
/// `topic_message_retention_duration` are always available to subscribers. See
/// the `message_retention_duration` field in `Topic`. This field is set only
/// in responses from the server; it is ignored if it is set in any requests.
#[prost(message, optional, tag = "17")]
pub topic_message_retention_duration: ::core::option::Option<::prost_types::Duration>,
}
/// A policy that specifies how Cloud Pub/Sub retries message delivery.
///
/// Retry delay will be exponential based on provided minimum and maximum
/// backoffs. <https://en.wikipedia.org/wiki/Exponential_backoff.>
///
/// RetryPolicy will be triggered on NACKs or acknowledgement deadline exceeded
/// events for a given message.
///
/// Retry Policy is implemented on a best effort basis. At times, the delay
/// between consecutive deliveries may not match the configuration. That is,
/// delay can be more or less than configured backoff.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RetryPolicy {
/// The minimum delay between consecutive deliveries of a given message.
/// Value should be between 0 and 600 seconds. Defaults to 10 seconds.
#[prost(message, optional, tag = "1")]
pub minimum_backoff: ::core::option::Option<::prost_types::Duration>,
/// The maximum delay between consecutive deliveries of a given message.
/// Value should be between 0 and 600 seconds. Defaults to 600 seconds.
#[prost(message, optional, tag = "2")]
pub maximum_backoff: ::core::option::Option<::prost_types::Duration>,
}
/// Dead lettering is done on a best effort basis. The same message might be
/// dead lettered multiple times.
///
/// If validation on any of the fields fails at subscription creation/updation,
/// the create/update subscription request will fail.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeadLetterPolicy {
/// The name of the topic to which dead letter messages should be published.
/// Format is `projects/{project}/topics/{topic}`.The Cloud Pub/Sub service
/// account associated with the enclosing subscription's parent project (i.e.,
/// service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com) must have
/// permission to Publish() to this topic.
///
/// The operation will fail if the topic does not exist.
/// Users should ensure that there is a subscription attached to this topic
/// since messages published to a topic with no subscriptions are lost.
#[prost(string, tag = "1")]
pub dead_letter_topic: ::prost::alloc::string::String,
/// The maximum number of delivery attempts for any message. The value must be
/// between 5 and 100.
///
/// The number of delivery attempts is defined as 1 + (the sum of number of
/// NACKs and number of times the acknowledgement deadline has been exceeded
/// for the message).
///
/// A NACK is any call to ModifyAckDeadline with a 0 deadline. Note that
/// client libraries may automatically extend ack_deadlines.
///
/// This field will be honored on a best effort basis.
///
/// If this parameter is 0, a default value of 5 is used.
#[prost(int32, tag = "2")]
pub max_delivery_attempts: i32,
}
/// A policy that specifies the conditions for resource expiration (i.e.,
/// automatic resource deletion).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ExpirationPolicy {
/// Specifies the "time-to-live" duration for an associated resource. The
/// resource expires if it is not active for a period of `ttl`. The definition
/// of "activity" depends on the type of the associated resource. The minimum
/// and maximum allowed values for `ttl` depend on the type of the associated
/// resource, as well. If `ttl` is not set, the associated resource never
/// expires.
#[prost(message, optional, tag = "1")]
pub ttl: ::core::option::Option<::prost_types::Duration>,
}
/// Configuration for a push delivery endpoint.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PushConfig {
/// A URL locating the endpoint to which messages should be pushed.
/// For example, a Webhook endpoint might use `<https://example.com/push`.>
#[prost(string, tag = "1")]
pub push_endpoint: ::prost::alloc::string::String,
/// Endpoint configuration attributes that can be used to control different
/// aspects of the message delivery.
///
/// The only currently supported attribute is `x-goog-version`, which you can
/// use to change the format of the pushed message. This attribute
/// indicates the version of the data expected by the endpoint. This
/// controls the shape of the pushed message (i.e., its fields and metadata).
///
/// If not present during the `CreateSubscription` call, it will default to
/// the version of the Pub/Sub API used to make such call. If not present in a
/// `ModifyPushConfig` call, its value will not be changed. `GetSubscription`
/// calls will always return a valid version, even if the subscription was
/// created without this attribute.
///
/// The only supported values for the `x-goog-version` attribute are:
///
/// * `v1beta1`: uses the push format defined in the v1beta1 Pub/Sub API.
/// * `v1` or `v1beta2`: uses the push format defined in the v1 Pub/Sub API.
///
/// For example:
/// <pre><code>attributes { "x-goog-version": "v1" } </code></pre>
#[prost(map = "string, string", tag = "2")]
pub attributes:
::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
/// An authentication method used by push endpoints to verify the source of
/// push requests. This can be used with push endpoints that are private by
/// default to allow requests only from the Cloud Pub/Sub system, for example.
/// This field is optional and should be set only by users interested in
/// authenticated push.
#[prost(oneof = "push_config::AuthenticationMethod", tags = "3")]
pub authentication_method: ::core::option::Option<push_config::AuthenticationMethod>,
}
/// Nested message and enum types in `PushConfig`.
pub mod push_config {
/// Contains information needed for generating an
/// [OpenID Connect
/// token](<https://developers.google.com/identity/protocols/OpenIDConnect>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OidcToken {
/// [Service account
/// email](<https://cloud.google.com/iam/docs/service-accounts>)
/// to be used for generating the OIDC token. The caller (for
/// CreateSubscription, UpdateSubscription, and ModifyPushConfig RPCs) must
/// have the iam.serviceAccounts.actAs permission for the service account.
#[prost(string, tag = "1")]
pub service_account_email: ::prost::alloc::string::String,
/// Audience to be used when generating OIDC token. The audience claim
/// identifies the recipients that the JWT is intended for. The audience
/// value is a single case-sensitive string. Having multiple values (array)
/// for the audience field is not supported. More info about the OIDC JWT
/// token audience here: <https://tools.ietf.org/html/rfc7519#section-4.1.3>
/// Note: if not specified, the Push endpoint URL will be used.
#[prost(string, tag = "2")]
pub audience: ::prost::alloc::string::String,
}
/// An authentication method used by push endpoints to verify the source of
/// push requests. This can be used with push endpoints that are private by
/// default to allow requests only from the Cloud Pub/Sub system, for example.
/// This field is optional and should be set only by users interested in
/// authenticated push.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum AuthenticationMethod {
/// If specified, Pub/Sub will generate and attach an OIDC JWT token as an
/// `Authorization` header in the HTTP request for every pushed message.
#[prost(message, tag = "3")]
OidcToken(OidcToken),
}
}
/// A message and its corresponding acknowledgment ID.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ReceivedMessage {
/// This ID can be used to acknowledge the received message.
#[prost(string, tag = "1")]
pub ack_id: ::prost::alloc::string::String,
/// The message.
#[prost(message, optional, tag = "2")]
pub message: ::core::option::Option<PubsubMessage>,
/// The approximate number of times that Cloud Pub/Sub has attempted to deliver
/// the associated message to a subscriber.
///
/// More precisely, this is 1 + (number of NACKs) +
/// (number of ack_deadline exceeds) for this message.
///
/// A NACK is any call to ModifyAckDeadline with a 0 deadline. An ack_deadline
/// exceeds event is whenever a message is not acknowledged within
/// ack_deadline. Note that ack_deadline is initially
/// Subscription.ackDeadlineSeconds, but may get extended automatically by
/// the client library.
///
/// Upon the first delivery of a given message, `delivery_attempt` will have a
/// value of 1. The value is calculated at best effort and is approximate.
///
/// If a DeadLetterPolicy is not set on the subscription, this will be 0.
#[prost(int32, tag = "3")]
pub delivery_attempt: i32,
}
/// Request for the GetSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSubscriptionRequest {
/// Required. The name of the subscription to get.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Request for the UpdateSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSubscriptionRequest {
/// Required. The updated subscription object.
#[prost(message, optional, tag = "1")]
pub subscription: ::core::option::Option<Subscription>,
/// Required. Indicates which fields in the provided subscription to update.
/// Must be specified and non-empty.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for the `ListSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSubscriptionsRequest {
/// Required. The name of the project in which to list subscriptions.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Maximum number of subscriptions to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListSubscriptionsResponse`; indicates that
/// this is a continuation of a prior `ListSubscriptions` call, and that the
/// system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSubscriptions` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSubscriptionsResponse {
/// The subscriptions that match the request.
#[prost(message, repeated, tag = "1")]
pub subscriptions: ::prost::alloc::vec::Vec<Subscription>,
/// If not empty, indicates that there may be more subscriptions that match
/// the request; this value should be passed in a new
/// `ListSubscriptionsRequest` to get more subscriptions.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the DeleteSubscription method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSubscriptionRequest {
/// Required. The subscription to delete.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
}
/// Request for the ModifyPushConfig method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyPushConfigRequest {
/// Required. The name of the subscription.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. The push configuration for future deliveries.
///
/// An empty `pushConfig` indicates that the Pub/Sub system should
/// stop pushing messages from the given subscription and allow
/// messages to be pulled and acknowledged - effectively pausing
/// the subscription if `Pull` or `StreamingPull` is not called.
#[prost(message, optional, tag = "2")]
pub push_config: ::core::option::Option<PushConfig>,
}
/// Request for the `Pull` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PullRequest {
/// Required. The subscription from which messages should be pulled.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Optional. If this field set to true, the system will respond immediately
/// even if it there are no messages available to return in the `Pull`
/// response. Otherwise, the system may wait (for a bounded amount of time)
/// until at least one message is available, rather than returning no messages.
/// Warning: setting this field to `true` is discouraged because it adversely
/// impacts the performance of `Pull` operations. We recommend that users do
/// not set this field.
#[deprecated]
#[prost(bool, tag = "2")]
pub return_immediately: bool,
/// Required. The maximum number of messages to return for this request. Must
/// be a positive integer. The Pub/Sub system may return fewer than the number
/// specified.
#[prost(int32, tag = "3")]
pub max_messages: i32,
}
/// Response for the `Pull` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PullResponse {
/// Received Pub/Sub messages. The list will be empty if there are no more
/// messages available in the backlog. For JSON, the response can be entirely
/// empty. The Pub/Sub system may return fewer than the `maxMessages` requested
/// even if there are more messages available in the backlog.
#[prost(message, repeated, tag = "1")]
pub received_messages: ::prost::alloc::vec::Vec<ReceivedMessage>,
}
/// Request for the ModifyAckDeadline method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyAckDeadlineRequest {
/// Required. The name of the subscription.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. List of acknowledgment IDs.
#[prost(string, repeated, tag = "4")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. The new ack deadline with respect to the time this request was
/// sent to the Pub/Sub system. For example, if the value is 10, the new ack
/// deadline will expire 10 seconds after the `ModifyAckDeadline` call was
/// made. Specifying zero might immediately make the message available for
/// delivery to another subscriber client. This typically results in an
/// increase in the rate of message redeliveries (that is, duplicates).
/// The minimum deadline you can specify is 0 seconds.
/// The maximum deadline you can specify is 600 seconds (10 minutes).
#[prost(int32, tag = "3")]
pub ack_deadline_seconds: i32,
}
/// Request for the Acknowledge method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AcknowledgeRequest {
/// Required. The subscription whose message is being acknowledged.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// Required. The acknowledgment ID for the messages being acknowledged that
/// was returned by the Pub/Sub system in the `Pull` response. Must not be
/// empty.
#[prost(string, repeated, tag = "2")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
}
/// Request for the `StreamingPull` streaming RPC method. This request is used to
/// establish the initial stream as well as to stream acknowledgements and ack
/// deadline modifications from the client to the server.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPullRequest {
/// Required. The subscription for which to initialize the new stream. This
/// must be provided in the first request on the stream, and must not be set in
/// subsequent requests from client to server.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
/// List of acknowledgement IDs for acknowledging previously received messages
/// (received on this stream or a different stream). If an ack ID has expired,
/// the corresponding message may be redelivered later. Acknowledging a message
/// more than once will not result in an error. If the acknowledgement ID is
/// malformed, the stream will be aborted with status `INVALID_ARGUMENT`.
#[prost(string, repeated, tag = "2")]
pub ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The list of new ack deadlines for the IDs listed in
/// `modify_deadline_ack_ids`. The size of this list must be the same as the
/// size of `modify_deadline_ack_ids`. If it differs the stream will be aborted
/// with `INVALID_ARGUMENT`. Each element in this list is applied to the
/// element in the same position in `modify_deadline_ack_ids`. The new ack
/// deadline is with respect to the time this request was sent to the Pub/Sub
/// system. Must be >= 0. For example, if the value is 10, the new ack deadline
/// will expire 10 seconds after this request is received. If the value is 0,
/// the message is immediately made available for another streaming or
/// non-streaming pull request. If the value is < 0 (an error), the stream will
/// be aborted with status `INVALID_ARGUMENT`.
#[prost(int32, repeated, tag = "3")]
pub modify_deadline_seconds: ::prost::alloc::vec::Vec<i32>,
/// List of acknowledgement IDs whose deadline will be modified based on the
/// corresponding element in `modify_deadline_seconds`. This field can be used
/// to indicate that more time is needed to process a message by the
/// subscriber, or to make the message available for redelivery if the
/// processing was interrupted.
#[prost(string, repeated, tag = "4")]
pub modify_deadline_ack_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// Required. The ack deadline to use for the stream. This must be provided in
/// the first request on the stream, but it can also be updated on subsequent
/// requests from client to server. The minimum deadline you can specify is 10
/// seconds. The maximum deadline you can specify is 600 seconds (10 minutes).
#[prost(int32, tag = "5")]
pub stream_ack_deadline_seconds: i32,
/// A unique identifier that is used to distinguish client instances from each
/// other. Only needs to be provided on the initial request. When a stream
/// disconnects and reconnects for the same stream, the client_id should be set
/// to the same value so that state associated with the old stream can be
/// transferred to the new stream. The same client_id should not be used for
/// different client instances.
#[prost(string, tag = "6")]
pub client_id: ::prost::alloc::string::String,
/// Flow control settings for the maximum number of outstanding messages. When
/// there are `max_outstanding_messages` or more currently sent to the
/// streaming pull client that have not yet been acked or nacked, the server
/// stops sending more messages. The sending of messages resumes once the
/// number of outstanding messages is less than this value. If the value is
/// <= 0, there is no limit to the number of outstanding messages. This
/// property can only be set on the initial StreamingPullRequest. If it is set
/// on a subsequent request, the stream will be aborted with status
/// `INVALID_ARGUMENT`.
#[prost(int64, tag = "7")]
pub max_outstanding_messages: i64,
/// Flow control settings for the maximum number of outstanding bytes. When
/// there are `max_outstanding_bytes` or more worth of messages currently sent
/// to the streaming pull client that have not yet been acked or nacked, the
/// server will stop sending more messages. The sending of messages resumes
/// once the number of outstanding bytes is less than this value. If the value
/// is <= 0, there is no limit to the number of outstanding bytes. This
/// property can only be set on the initial StreamingPullRequest. If it is set
/// on a subsequent request, the stream will be aborted with status
/// `INVALID_ARGUMENT`.
#[prost(int64, tag = "8")]
pub max_outstanding_bytes: i64,
}
/// Response for the `StreamingPull` method. This response is used to stream
/// messages from the server to the client.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StreamingPullResponse {
/// Received Pub/Sub messages. This will not be empty.
#[prost(message, repeated, tag = "1")]
pub received_messages: ::prost::alloc::vec::Vec<ReceivedMessage>,
/// Properties associated with this subscription.
#[prost(message, optional, tag = "4")]
pub subscription_properties:
::core::option::Option<streaming_pull_response::SubscriptionProperties>,
}
/// Nested message and enum types in `StreamingPullResponse`.
pub mod streaming_pull_response {
/// Subscription properties sent as part of the response.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SubscriptionProperties {
/// True iff message ordering is enabled for this subscription.
#[prost(bool, tag = "2")]
pub message_ordering_enabled: bool,
}
}
/// Request for the `CreateSnapshot` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateSnapshotRequest {
/// Required. User-provided name for this snapshot. If the name is not provided
/// in the request, the server will assign a random name for this snapshot on
/// the same project as the subscription. Note that for REST API requests, you
/// must specify a name. See the <a
/// href="<https://cloud.google.com/pubsub/docs/admin#resource_names">> resource
/// name rules</a>. Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The subscription whose backlog the snapshot retains.
/// Specifically, the created snapshot is guaranteed to retain:
/// (a) The existing backlog on the subscription. More precisely, this is
/// defined as the messages in the subscription's backlog that are
/// unacknowledged upon the successful completion of the
/// `CreateSnapshot` request; as well as:
/// (b) Any messages published to the subscription's topic following the
/// successful completion of the CreateSnapshot request.
/// Format is `projects/{project}/subscriptions/{sub}`.
#[prost(string, tag = "2")]
pub subscription: ::prost::alloc::string::String,
/// See <a href="<https://cloud.google.com/pubsub/docs/labels">> Creating and
/// managing labels</a>.
#[prost(map = "string, string", tag = "3")]
pub labels:
::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
/// Request for the UpdateSnapshot method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateSnapshotRequest {
/// Required. The updated snapshot object.
#[prost(message, optional, tag = "1")]
pub snapshot: ::core::option::Option<Snapshot>,
/// Required. Indicates which fields in the provided snapshot to update.
/// Must be specified and non-empty.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// A snapshot resource. Snapshots are used in
/// \[Seek\](<https://cloud.google.com/pubsub/docs/replay-overview>)
/// operations, which allow you to manage message acknowledgments in bulk. That
/// is, you can set the acknowledgment state of messages in an existing
/// subscription to the state captured by a snapshot.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Snapshot {
/// The name of the snapshot.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The name of the topic from which this snapshot is retaining messages.
#[prost(string, tag = "2")]
pub topic: ::prost::alloc::string::String,
/// The snapshot is guaranteed to exist up until this time.
/// A newly-created snapshot expires no later than 7 days from the time of its
/// creation. Its exact lifetime is determined at creation by the existing
/// backlog in the source subscription. Specifically, the lifetime of the
/// snapshot is `7 days - (age of oldest unacked message in the subscription)`.
/// For example, consider a subscription whose oldest unacked message is 3 days
/// old. If a snapshot is created from this subscription, the snapshot -- which
/// will always capture this 3-day-old backlog as long as the snapshot
/// exists -- will expire in 4 days. The service will refuse to create a
/// snapshot that would expire in less than 1 hour after creation.
#[prost(message, optional, tag = "3")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
/// See [Creating and managing labels]
/// (<https://cloud.google.com/pubsub/docs/labels>).
#[prost(map = "string, string", tag = "4")]
pub labels:
::std::collections::HashMap<::prost::alloc::string::String, ::prost::alloc::string::String>,
}
/// Request for the GetSnapshot method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetSnapshotRequest {
/// Required. The name of the snapshot to get.
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub snapshot: ::prost::alloc::string::String,
}
/// Request for the `ListSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSnapshotsRequest {
/// Required. The name of the project in which to list snapshots.
/// Format is `projects/{project-id}`.
#[prost(string, tag = "1")]
pub project: ::prost::alloc::string::String,
/// Maximum number of snapshots to return.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListSnapshotsResponse`; indicates that this
/// is a continuation of a prior `ListSnapshots` call, and that the system
/// should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for the `ListSnapshots` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListSnapshotsResponse {
/// The resulting snapshots.
#[prost(message, repeated, tag = "1")]
pub snapshots: ::prost::alloc::vec::Vec<Snapshot>,
/// If not empty, indicates that there may be more snapshot that match the
/// request; this value should be passed in a new `ListSnapshotsRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for the `DeleteSnapshot` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteSnapshotRequest {
/// Required. The name of the snapshot to delete.
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "1")]
pub snapshot: ::prost::alloc::string::String,
}
/// Request for the `Seek` method.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SeekRequest {
/// Required. The subscription to affect.
#[prost(string, tag = "1")]
pub subscription: ::prost::alloc::string::String,
#[prost(oneof = "seek_request::Target", tags = "2, 3")]
pub target: ::core::option::Option<seek_request::Target>,
}
/// Nested message and enum types in `SeekRequest`.
pub mod seek_request {
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Target {
/// The time to seek to.
/// Messages retained in the subscription that were published before this
/// time are marked as acknowledged, and messages retained in the
/// subscription that were published after this time are marked as
/// unacknowledged. Note that this operation affects only those messages
/// retained in the subscription (configured by the combination of
/// `message_retention_duration` and `retain_acked_messages`). For example,
/// if `time` corresponds to a point before the message retention
/// window (or to a point before the system's notion of the subscription
/// creation time), only retained messages will be marked as unacknowledged,
/// and already-expunged messages will not be restored.
#[prost(message, tag = "2")]
Time(::prost_types::Timestamp),
/// The snapshot to seek to. The snapshot's topic must be the same as that of
/// the provided subscription.
/// Format is `projects/{project}/snapshots/{snap}`.
#[prost(string, tag = "3")]
Snapshot(::prost::alloc::string::String),
}
}
/// Response for the `Seek` method (this response is empty).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SeekResponse {}
#[doc = r" Generated client implementations."]
pub mod publisher_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
#[doc = " The service that an application uses to manipulate topics, and to send"]
#[doc = " messages to a topic."]
#[derive(Debug, Clone)]
pub struct PublisherClient<T> {
inner: tonic::client::Grpc<T>,
}
impl PublisherClient<tonic::transport::Channel> {
#[doc = r" Attempt to create a new client by connecting to a given endpoint."]
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: std::convert::TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> PublisherClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::ResponseBody: Body + Send + 'static,
T::Error: Into<StdError>,
<T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> PublisherClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<http::Request<tonic::body::BoxBody>>>::Error:
Into<StdError> + Send + Sync,
{
PublisherClient::new(InterceptedService::new(inner, interceptor))
}
#[doc = r" Compress requests with `gzip`."]
#[doc = r""]
#[doc = r" This requires the server to support it otherwise it might respond with an"]
#[doc = r" error."]
pub fn send_gzip(mut self) -> Self {
self.inner = self.inner.send_gzip();
self
}
#[doc = r" Enable decompressing responses with `gzip`."]
pub fn accept_gzip(mut self) -> Self {
self.inner = self.inner.accept_gzip();
self
}
#[doc = " Creates the given topic with the given name. See the [resource name rules]"]
#[doc = " (https://cloud.google.com/pubsub/docs/admin#resource_names)."]
pub async fn create_topic(
&mut self,
request: impl tonic::IntoRequest<super::Topic>,
) -> Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/CreateTopic");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Updates an existing topic. Note that certain properties of a"]
#[doc = " topic are not modifiable."]
pub async fn update_topic(
&mut self,
request: impl tonic::IntoRequest<super::UpdateTopicRequest>,
) -> Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/UpdateTopic");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic"]
#[doc = " does not exist."]
pub async fn publish(
&mut self,
request: impl tonic::IntoRequest<super::PublishRequest>,
) -> Result<tonic::Response<super::PublishResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/Publish");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Gets the configuration of a topic."]
pub async fn get_topic(
&mut self,
request: impl tonic::IntoRequest<super::GetTopicRequest>,
) -> Result<tonic::Response<super::Topic>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/GetTopic");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists matching topics."]
pub async fn list_topics(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicsRequest>,
) -> Result<tonic::Response<super::ListTopicsResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/ListTopics");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists the names of the attached subscriptions on this topic."]
pub async fn list_topic_subscriptions(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicSubscriptionsRequest>,
) -> Result<tonic::Response<super::ListTopicSubscriptionsResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/ListTopicSubscriptions",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists the names of the snapshots on this topic. Snapshots are used in"]
#[doc = " [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,"]
#[doc = " which allow you to manage message acknowledgments in bulk. That is, you can"]
#[doc = " set the acknowledgment state of messages in an existing subscription to the"]
#[doc = " state captured by a snapshot."]
pub async fn list_topic_snapshots(
&mut self,
request: impl tonic::IntoRequest<super::ListTopicSnapshotsRequest>,
) -> Result<tonic::Response<super::ListTopicSnapshotsResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/ListTopicSnapshots",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Deletes the topic with the given name. Returns `NOT_FOUND` if the topic"]
#[doc = " does not exist. After a topic is deleted, a new topic may be created with"]
#[doc = " the same name; this is an entirely new topic with none of the old"]
#[doc = " configuration or subscriptions. Existing subscriptions to this topic are"]
#[doc = " not deleted, but their `topic` field is set to `_deleted-topic_`."]
pub async fn delete_topic(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTopicRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Publisher/DeleteTopic");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Detaches a subscription from this topic. All messages retained in the"]
#[doc = " subscription are dropped. Subsequent `Pull` and `StreamingPull` requests"]
#[doc = " will return FAILED_PRECONDITION. If the subscription is a push"]
#[doc = " subscription, pushes to the endpoint will stop."]
pub async fn detach_subscription(
&mut self,
request: impl tonic::IntoRequest<super::DetachSubscriptionRequest>,
) -> Result<tonic::Response<super::DetachSubscriptionResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Publisher/DetachSubscription",
);
self.inner.unary(request.into_request(), path, codec).await
}
}
}
#[doc = r" Generated client implementations."]
pub mod subscriber_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
#[doc = " The service that an application uses to manipulate subscriptions and to"]
#[doc = " consume messages from a subscription via the `Pull` method or by"]
#[doc = " establishing a bi-directional stream using the `StreamingPull` method."]
#[derive(Debug, Clone)]
pub struct SubscriberClient<T> {
inner: tonic::client::Grpc<T>,
}
impl SubscriberClient<tonic::transport::Channel> {
#[doc = r" Attempt to create a new client by connecting to a given endpoint."]
pub async fn connect<D>(dst: D) -> Result<Self, tonic::transport::Error>
where
D: std::convert::TryInto<tonic::transport::Endpoint>,
D::Error: Into<StdError>,
{
let conn = tonic::transport::Endpoint::new(dst)?.connect().await?;
Ok(Self::new(conn))
}
}
impl<T> SubscriberClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::ResponseBody: Body + Send + 'static,
T::Error: Into<StdError>,
<T::ResponseBody as Body>::Error: Into<StdError> + Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> SubscriberClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<http::Request<tonic::body::BoxBody>>>::Error:
Into<StdError> + Send + Sync,
{
SubscriberClient::new(InterceptedService::new(inner, interceptor))
}
#[doc = r" Compress requests with `gzip`."]
#[doc = r""]
#[doc = r" This requires the server to support it otherwise it might respond with an"]
#[doc = r" error."]
pub fn send_gzip(mut self) -> Self {
self.inner = self.inner.send_gzip();
self
}
#[doc = r" Enable decompressing responses with `gzip`."]
pub fn accept_gzip(mut self) -> Self {
self.inner = self.inner.accept_gzip();
self
}
#[doc = " Creates a subscription to a given topic. See the [resource name rules]"]
#[doc = " (https://cloud.google.com/pubsub/docs/admin#resource_names)."]
#[doc = " If the subscription already exists, returns `ALREADY_EXISTS`."]
#[doc = " If the corresponding topic doesn't exist, returns `NOT_FOUND`."]
#[doc = ""]
#[doc = " If the name is not provided in the request, the server will assign a random"]
#[doc = " name for this subscription on the same project as the topic, conforming"]
#[doc = " to the [resource name format]"]
#[doc = " (https://cloud.google.com/pubsub/docs/admin#resource_names). The generated"]
#[doc = " name is populated in the returned Subscription object. Note that for REST"]
#[doc = " API requests, you must specify a name in the request."]
pub async fn create_subscription(
&mut self,
request: impl tonic::IntoRequest<super::Subscription>,
) -> Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/CreateSubscription",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Gets the configuration details of a subscription."]
pub async fn get_subscription(
&mut self,
request: impl tonic::IntoRequest<super::GetSubscriptionRequest>,
) -> Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/GetSubscription",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Updates an existing subscription. Note that certain properties of a"]
#[doc = " subscription, such as its topic, are not modifiable."]
pub async fn update_subscription(
&mut self,
request: impl tonic::IntoRequest<super::UpdateSubscriptionRequest>,
) -> Result<tonic::Response<super::Subscription>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/UpdateSubscription",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists matching subscriptions."]
pub async fn list_subscriptions(
&mut self,
request: impl tonic::IntoRequest<super::ListSubscriptionsRequest>,
) -> Result<tonic::Response<super::ListSubscriptionsResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/ListSubscriptions",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Deletes an existing subscription. All messages retained in the subscription"]
#[doc = " are immediately dropped. Calls to `Pull` after deletion will return"]
#[doc = " `NOT_FOUND`. After a subscription is deleted, a new one may be created with"]
#[doc = " the same name, but the new one has no association with the old"]
#[doc = " subscription or its topic unless the same topic is specified."]
pub async fn delete_subscription(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSubscriptionRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/DeleteSubscription",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Modifies the ack deadline for a specific message. This method is useful"]
#[doc = " to indicate that more time is needed to process a message by the"]
#[doc = " subscriber, or to make the message available for redelivery if the"]
#[doc = " processing was interrupted. Note that this does not modify the"]
#[doc = " subscription-level `ackDeadlineSeconds` used for subsequent messages."]
pub async fn modify_ack_deadline(
&mut self,
request: impl tonic::IntoRequest<super::ModifyAckDeadlineRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/ModifyAckDeadline",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Acknowledges the messages associated with the `ack_ids` in the"]
#[doc = " `AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages"]
#[doc = " from the subscription."]
#[doc = ""]
#[doc = " Acknowledging a message whose ack deadline has expired may succeed,"]
#[doc = " but such a message may be redelivered later. Acknowledging a message more"]
#[doc = " than once will not result in an error."]
pub async fn acknowledge(
&mut self,
request: impl tonic::IntoRequest<super::AcknowledgeRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/Acknowledge");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Pulls messages from the server. The server may return `UNAVAILABLE` if"]
#[doc = " there are too many concurrent pull requests pending for the given"]
#[doc = " subscription."]
pub async fn pull(
&mut self,
request: impl tonic::IntoRequest<super::PullRequest>,
) -> Result<tonic::Response<super::PullResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/Pull");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Establishes a stream with the server, which sends messages down to the"]
#[doc = " client. The client streams acknowledgements and ack deadline modifications"]
#[doc = " back to the server. The server will close the stream and return the status"]
#[doc = " on any error. The server may close the stream with status `UNAVAILABLE` to"]
#[doc = " reassign server-side resources, in which case, the client should"]
#[doc = " re-establish the stream. Flow control can be achieved by configuring the"]
#[doc = " underlying RPC channel."]
pub async fn streaming_pull(
&mut self,
request: impl tonic::IntoStreamingRequest<Message = super::StreamingPullRequest>,
) -> Result<
tonic::Response<tonic::codec::Streaming<super::StreamingPullResponse>>,
tonic::Status,
> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/StreamingPull");
self.inner
.streaming(request.into_streaming_request(), path, codec)
.await
}
#[doc = " Modifies the `PushConfig` for a specified subscription."]
#[doc = ""]
#[doc = " This may be used to change a push subscription to a pull one (signified by"]
#[doc = " an empty `PushConfig`) or vice versa, or change the endpoint URL and other"]
#[doc = " attributes of a push subscription. Messages will accumulate for delivery"]
#[doc = " continuously through the call regardless of changes to the `PushConfig`."]
pub async fn modify_push_config(
&mut self,
request: impl tonic::IntoRequest<super::ModifyPushConfigRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.pubsub.v1.Subscriber/ModifyPushConfig",
);
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Gets the configuration details of a snapshot. Snapshots are used in"]
#[doc = " <a href=\"https://cloud.google.com/pubsub/docs/replay-overview\">Seek</a>"]
#[doc = " operations, which allow you to manage message acknowledgments in bulk. That"]
#[doc = " is, you can set the acknowledgment state of messages in an existing"]
#[doc = " subscription to the state captured by a snapshot."]
pub async fn get_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::GetSnapshotRequest>,
) -> Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/GetSnapshot");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Lists the existing snapshots. Snapshots are used in [Seek]("]
#[doc = " https://cloud.google.com/pubsub/docs/replay-overview) operations, which"]
#[doc = " allow you to manage message acknowledgments in bulk. That is, you can set"]
#[doc = " the acknowledgment state of messages in an existing subscription to the"]
#[doc = " state captured by a snapshot."]
pub async fn list_snapshots(
&mut self,
request: impl tonic::IntoRequest<super::ListSnapshotsRequest>,
) -> Result<tonic::Response<super::ListSnapshotsResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/ListSnapshots");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Creates a snapshot from the requested subscription. Snapshots are used in"]
#[doc = " [Seek](https://cloud.google.com/pubsub/docs/replay-overview) operations,"]
#[doc = " which allow you to manage message acknowledgments in bulk. That is, you can"]
#[doc = " set the acknowledgment state of messages in an existing subscription to the"]
#[doc = " state captured by a snapshot."]
#[doc = " If the snapshot already exists, returns `ALREADY_EXISTS`."]
#[doc = " If the requested subscription doesn't exist, returns `NOT_FOUND`."]
#[doc = " If the backlog in the subscription is too old -- and the resulting snapshot"]
#[doc = " would expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned."]
#[doc = " See also the `Snapshot.expire_time` field. If the name is not provided in"]
#[doc = " the request, the server will assign a random"]
#[doc = " name for this snapshot on the same project as the subscription, conforming"]
#[doc = " to the [resource name format]"]
#[doc = " (https://cloud.google.com/pubsub/docs/admin#resource_names). The"]
#[doc = " generated name is populated in the returned Snapshot object. Note that for"]
#[doc = " REST API requests, you must specify a name in the request."]
pub async fn create_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::CreateSnapshotRequest>,
) -> Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/CreateSnapshot");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Updates an existing snapshot. Snapshots are used in"]
#[doc = " <a href=\"https://cloud.google.com/pubsub/docs/replay-overview\">Seek</a>"]
#[doc = " operations, which allow"]
#[doc = " you to manage message acknowledgments in bulk. That is, you can set the"]
#[doc = " acknowledgment state of messages in an existing subscription to the state"]
#[doc = " captured by a snapshot."]
pub async fn update_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::UpdateSnapshotRequest>,
) -> Result<tonic::Response<super::Snapshot>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/UpdateSnapshot");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Removes an existing snapshot. Snapshots are used in [Seek]"]
#[doc = " (https://cloud.google.com/pubsub/docs/replay-overview) operations, which"]
#[doc = " allow you to manage message acknowledgments in bulk. That is, you can set"]
#[doc = " the acknowledgment state of messages in an existing subscription to the"]
#[doc = " state captured by a snapshot."]
#[doc = " When the snapshot is deleted, all messages retained in the snapshot"]
#[doc = " are immediately dropped. After a snapshot is deleted, a new one may be"]
#[doc = " created with the same name, but the new one has no association with the old"]
#[doc = " snapshot or its subscription, unless the same subscription is specified."]
pub async fn delete_snapshot(
&mut self,
request: impl tonic::IntoRequest<super::DeleteSnapshotRequest>,
) -> Result<tonic::Response<()>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path =
http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/DeleteSnapshot");
self.inner.unary(request.into_request(), path, codec).await
}
#[doc = " Seeks an existing subscription to a point in time or to a given snapshot,"]
#[doc = " whichever is provided in the request. Snapshots are used in [Seek]"]
#[doc = " (https://cloud.google.com/pubsub/docs/replay-overview) operations, which"]
#[doc = " allow you to manage message acknowledgments in bulk. That is, you can set"]
#[doc = " the acknowledgment state of messages in an existing subscription to the"]
#[doc = " state captured by a snapshot. Note that both the subscription and the"]
#[doc = " snapshot must be on the same topic."]
pub async fn seek(
&mut self,
request: impl tonic::IntoRequest<super::SeekRequest>,
) -> Result<tonic::Response<super::SeekResponse>, tonic::Status> {
self.inner.ready().await.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static("/google.pubsub.v1.Subscriber/Seek");
self.inner.unary(request.into_request(), path, codec).await
}
}
}