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
// This file is @generated by prost-build.
/// The device resource.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Device {
/// The user-defined device identifier. The device ID must be unique
/// within a device registry.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The resource path name. For example,
/// `projects/p1/locations/us-central1/registries/registry0/devices/dev0` or
/// `projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.
/// When `name` is populated as a response from the service, it always ends
/// in the device numeric ID.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
/// \[Output only\] A server-defined unique numeric ID for the device. This is a
/// more compact way to identify devices, and it is globally unique.
#[prost(uint64, tag = "3")]
pub num_id: u64,
/// The credentials used to authenticate this device. To allow credential
/// rotation without interruption, multiple device credentials can be bound to
/// this device. No more than 3 credentials can be bound to a single device at
/// a time. When new credentials are added to a device, they are verified
/// against the registry credentials. For details, see the description of the
/// `DeviceRegistry.credentials` field.
#[prost(message, repeated, tag = "12")]
pub credentials: ::prost::alloc::vec::Vec<DeviceCredential>,
/// \[Output only\] The last time an MQTT `PINGREQ` was received. This field
/// applies only to devices connecting through MQTT. MQTT clients usually only
/// send `PINGREQ` messages if the connection is idle, and no other messages
/// have been sent. Timestamps are periodically collected and written to
/// storage; they may be stale by a few minutes.
#[prost(message, optional, tag = "7")]
pub last_heartbeat_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The last time a telemetry event was received. Timestamps are
/// periodically collected and written to storage; they may be stale by a few
/// minutes.
#[prost(message, optional, tag = "8")]
pub last_event_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The last time a state event was received. Timestamps are
/// periodically collected and written to storage; they may be stale by a few
/// minutes.
#[prost(message, optional, tag = "20")]
pub last_state_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The last time a cloud-to-device config version acknowledgment
/// was received from the device. This field is only for configurations
/// sent through MQTT.
#[prost(message, optional, tag = "14")]
pub last_config_ack_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The last time a cloud-to-device config version was sent to
/// the device.
#[prost(message, optional, tag = "18")]
pub last_config_send_time: ::core::option::Option<::prost_types::Timestamp>,
/// If a device is blocked, connections or requests from this device will fail.
/// Can be used to temporarily prevent the device from connecting if, for
/// example, the sensor is generating bad data and needs maintenance.
#[prost(bool, tag = "19")]
pub blocked: bool,
/// \[Output only\] The time the most recent error occurred, such as a failure to
/// publish to Cloud Pub/Sub. This field is the timestamp of
/// 'last_error_status'.
#[prost(message, optional, tag = "10")]
pub last_error_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The error message of the most recent error, such as a failure
/// to publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this
/// field. If no errors have occurred, this field has an empty message
/// and the status code 0 == OK. Otherwise, this field is expected to have a
/// status code other than OK.
#[prost(message, optional, tag = "11")]
pub last_error_status: ::core::option::Option<super::super::super::rpc::Status>,
/// The most recent device configuration, which is eventually sent from
/// Cloud IoT Core to the device. If not present on creation, the
/// configuration will be initialized with an empty payload and version value
/// of `1`. To update this field after creation, use the
/// `DeviceManager.ModifyCloudToDeviceConfig` method.
#[prost(message, optional, tag = "13")]
pub config: ::core::option::Option<DeviceConfig>,
/// \[Output only\] The state most recently received from the device. If no state
/// has been reported, this field is not present.
#[prost(message, optional, tag = "16")]
pub state: ::core::option::Option<DeviceState>,
/// **Beta Feature**
///
/// The logging verbosity for device activity. If unspecified,
/// DeviceRegistry.log_level will be used.
#[prost(enumeration = "LogLevel", tag = "21")]
pub log_level: i32,
/// The metadata key-value pairs assigned to the device. This metadata is not
/// interpreted or indexed by Cloud IoT Core. It can be used to add contextual
/// information for the device.
///
/// Keys must conform to the regular expression [a-zA-Z][a-zA-Z0-9-_.+~%]+ and
/// be less than 128 bytes in length.
///
/// Values are free-form strings. Each value must be less than or equal to 32
/// KB in size.
///
/// The total size of all keys and values must be less than 256 KB, and the
/// maximum number of key-value pairs is 500.
#[prost(btree_map = "string, string", tag = "17")]
pub metadata: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// Gateway-related configuration and state.
#[prost(message, optional, tag = "24")]
pub gateway_config: ::core::option::Option<GatewayConfig>,
}
/// Gateway-related configuration and state.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GatewayConfig {
/// Indicates whether the device is a gateway.
#[prost(enumeration = "GatewayType", tag = "1")]
pub gateway_type: i32,
/// Indicates how to authorize and/or authenticate devices to access the
/// gateway.
#[prost(enumeration = "GatewayAuthMethod", tag = "2")]
pub gateway_auth_method: i32,
/// \[Output only\] The ID of the gateway the device accessed most recently.
#[prost(string, tag = "3")]
pub last_accessed_gateway_id: ::prost::alloc::string::String,
/// \[Output only\] The most recent time at which the device accessed the gateway
/// specified in `last_accessed_gateway`.
#[prost(message, optional, tag = "4")]
pub last_accessed_gateway_time: ::core::option::Option<::prost_types::Timestamp>,
}
/// A container for a group of devices.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeviceRegistry {
/// The identifier of this device registry. For example, `myRegistry`.
#[prost(string, tag = "1")]
pub id: ::prost::alloc::string::String,
/// The resource path name. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "2")]
pub name: ::prost::alloc::string::String,
/// The configuration for notification of telemetry events received from the
/// device. All telemetry events that were successfully published by the
/// device and acknowledged by Cloud IoT Core are guaranteed to be
/// delivered to Cloud Pub/Sub. If multiple configurations match a message,
/// only the first matching configuration is used. If you try to publish a
/// device telemetry event using MQTT without specifying a Cloud Pub/Sub topic
/// for the device's registry, the connection closes automatically. If you try
/// to do so using an HTTP connection, an error is returned. Up to 10
/// configurations may be provided.
#[prost(message, repeated, tag = "10")]
pub event_notification_configs: ::prost::alloc::vec::Vec<EventNotificationConfig>,
/// The configuration for notification of new states received from the device.
/// State updates are guaranteed to be stored in the state history, but
/// notifications to Cloud Pub/Sub are not guaranteed. For example, if
/// permissions are misconfigured or the specified topic doesn't exist, no
/// notification will be published but the state will still be stored in Cloud
/// IoT Core.
#[prost(message, optional, tag = "7")]
pub state_notification_config: ::core::option::Option<StateNotificationConfig>,
/// The MQTT configuration for this device registry.
#[prost(message, optional, tag = "4")]
pub mqtt_config: ::core::option::Option<MqttConfig>,
/// The DeviceService (HTTP) configuration for this device registry.
#[prost(message, optional, tag = "9")]
pub http_config: ::core::option::Option<HttpConfig>,
/// **Beta Feature**
///
/// The default logging verbosity for activity from devices in this registry.
/// The verbosity level can be overridden by Device.log_level.
#[prost(enumeration = "LogLevel", tag = "11")]
pub log_level: i32,
/// The credentials used to verify the device credentials. No more than 10
/// credentials can be bound to a single registry at a time. The verification
/// process occurs at the time of device creation or update. If this field is
/// empty, no verification is performed. Otherwise, the credentials of a newly
/// created device or added credentials of an updated device should be signed
/// with one of these registry credentials.
///
/// Note, however, that existing devices will never be affected by
/// modifications to this list of credentials: after a device has been
/// successfully created in a registry, it should be able to connect even if
/// its registry credentials are revoked, deleted, or modified.
#[prost(message, repeated, tag = "8")]
pub credentials: ::prost::alloc::vec::Vec<RegistryCredential>,
}
/// The configuration of MQTT for a device registry.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct MqttConfig {
/// If enabled, allows connections using the MQTT protocol. Otherwise, MQTT
/// connections to this registry will fail.
#[prost(enumeration = "MqttState", tag = "1")]
pub mqtt_enabled_state: i32,
}
/// The configuration of the HTTP bridge for a device registry.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct HttpConfig {
/// If enabled, allows devices to use DeviceService via the HTTP protocol.
/// Otherwise, any requests to DeviceService will fail for this registry.
#[prost(enumeration = "HttpState", tag = "1")]
pub http_enabled_state: i32,
}
/// The configuration for forwarding telemetry events.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EventNotificationConfig {
/// If the subfolder name matches this string exactly, this configuration will
/// be used. The string must not include the leading '/' character. If empty,
/// all strings are matched. This field is used only for telemetry events;
/// subfolders are not supported for state changes.
#[prost(string, tag = "2")]
pub subfolder_matches: ::prost::alloc::string::String,
/// A Cloud Pub/Sub topic name. For example,
/// `projects/myProject/topics/deviceEvents`.
#[prost(string, tag = "1")]
pub pubsub_topic_name: ::prost::alloc::string::String,
}
/// The configuration for notification of new states received from the device.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct StateNotificationConfig {
/// A Cloud Pub/Sub topic name. For example,
/// `projects/myProject/topics/deviceEvents`.
#[prost(string, tag = "1")]
pub pubsub_topic_name: ::prost::alloc::string::String,
}
/// A server-stored registry credential used to validate device credentials.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RegistryCredential {
/// The credential data. Reserved for expansion in the future.
#[prost(oneof = "registry_credential::Credential", tags = "1")]
pub credential: ::core::option::Option<registry_credential::Credential>,
}
/// Nested message and enum types in `RegistryCredential`.
pub mod registry_credential {
/// The credential data. Reserved for expansion in the future.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Credential {
/// A public key certificate used to verify the device credentials.
#[prost(message, tag = "1")]
PublicKeyCertificate(super::PublicKeyCertificate),
}
}
/// Details of an X.509 certificate. For informational purposes only.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct X509CertificateDetails {
/// The entity that signed the certificate.
#[prost(string, tag = "1")]
pub issuer: ::prost::alloc::string::String,
/// The entity the certificate and public key belong to.
#[prost(string, tag = "2")]
pub subject: ::prost::alloc::string::String,
/// The time the certificate becomes valid.
#[prost(message, optional, tag = "3")]
pub start_time: ::core::option::Option<::prost_types::Timestamp>,
/// The time the certificate becomes invalid.
#[prost(message, optional, tag = "4")]
pub expiry_time: ::core::option::Option<::prost_types::Timestamp>,
/// The algorithm used to sign the certificate.
#[prost(string, tag = "5")]
pub signature_algorithm: ::prost::alloc::string::String,
/// The type of public key in the certificate.
#[prost(string, tag = "6")]
pub public_key_type: ::prost::alloc::string::String,
}
/// A public key certificate format and data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublicKeyCertificate {
/// The certificate format.
#[prost(enumeration = "PublicKeyCertificateFormat", tag = "1")]
pub format: i32,
/// The certificate data.
#[prost(string, tag = "2")]
pub certificate: ::prost::alloc::string::String,
/// \[Output only\] The certificate details. Used only for X.509 certificates.
#[prost(message, optional, tag = "3")]
pub x509_details: ::core::option::Option<X509CertificateDetails>,
}
/// A server-stored device credential used for authentication.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeviceCredential {
/// \[Optional\] The time at which this credential becomes invalid. This
/// credential will be ignored for new client authentication requests after
/// this timestamp; however, it will not be automatically deleted.
#[prost(message, optional, tag = "6")]
pub expiration_time: ::core::option::Option<::prost_types::Timestamp>,
/// The credential data. Reserved for expansion in the future.
#[prost(oneof = "device_credential::Credential", tags = "2")]
pub credential: ::core::option::Option<device_credential::Credential>,
}
/// Nested message and enum types in `DeviceCredential`.
pub mod device_credential {
/// The credential data. Reserved for expansion in the future.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Credential {
/// A public key used to verify the signature of JSON Web Tokens (JWTs).
/// When adding a new device credential, either via device creation or via
/// modifications, this public key credential may be required to be signed by
/// one of the registry level certificates. More specifically, if the
/// registry contains at least one certificate, any new device credential
/// must be signed by one of the registry certificates. As a result,
/// when the registry contains certificates, only X.509 certificates are
/// accepted as device credentials. However, if the registry does
/// not contain a certificate, self-signed certificates and public keys will
/// be accepted. New device credentials must be different from every
/// registry-level certificate.
#[prost(message, tag = "2")]
PublicKey(super::PublicKeyCredential),
}
}
/// A public key format and data.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PublicKeyCredential {
/// The format of the key.
#[prost(enumeration = "PublicKeyFormat", tag = "1")]
pub format: i32,
/// The key data.
#[prost(string, tag = "2")]
pub key: ::prost::alloc::string::String,
}
/// The device configuration. Eventually delivered to devices.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeviceConfig {
/// \[Output only\] The version of this update. The version number is assigned by
/// the server, and is always greater than 0 after device creation. The
/// version must be 0 on the `CreateDevice` request if a `config` is
/// specified; the response of `CreateDevice` will always have a value of 1.
#[prost(int64, tag = "1")]
pub version: i64,
/// \[Output only\] The time at which this configuration version was updated in
/// Cloud IoT Core. This timestamp is set by the server.
#[prost(message, optional, tag = "2")]
pub cloud_update_time: ::core::option::Option<::prost_types::Timestamp>,
/// \[Output only\] The time at which Cloud IoT Core received the
/// acknowledgment from the device, indicating that the device has received
/// this configuration version. If this field is not present, the device has
/// not yet acknowledged that it received this version. Note that when
/// the config was sent to the device, many config versions may have been
/// available in Cloud IoT Core while the device was disconnected, and on
/// connection, only the latest version is sent to the device. Some
/// versions may never be sent to the device, and therefore are never
/// acknowledged. This timestamp is set by Cloud IoT Core.
#[prost(message, optional, tag = "3")]
pub device_ack_time: ::core::option::Option<::prost_types::Timestamp>,
/// The device configuration data.
#[prost(bytes = "bytes", tag = "4")]
pub binary_data: ::prost::bytes::Bytes,
}
/// The device state, as reported by the device.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeviceState {
/// \[Output only\] The time at which this state version was updated in Cloud
/// IoT Core.
#[prost(message, optional, tag = "1")]
pub update_time: ::core::option::Option<::prost_types::Timestamp>,
/// The device state data.
#[prost(bytes = "bytes", tag = "2")]
pub binary_data: ::prost::bytes::Bytes,
}
/// Indicates whether an MQTT connection is enabled or disabled. See the field
/// description for details.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum MqttState {
/// No MQTT state specified. If not specified, MQTT will be enabled by default.
Unspecified = 0,
/// Enables a MQTT connection.
MqttEnabled = 1,
/// Disables a MQTT connection.
MqttDisabled = 2,
}
impl MqttState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
MqttState::Unspecified => "MQTT_STATE_UNSPECIFIED",
MqttState::MqttEnabled => "MQTT_ENABLED",
MqttState::MqttDisabled => "MQTT_DISABLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"MQTT_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"MQTT_ENABLED" => Some(Self::MqttEnabled),
"MQTT_DISABLED" => Some(Self::MqttDisabled),
_ => None,
}
}
}
/// Indicates whether DeviceService (HTTP) is enabled or disabled for the
/// registry. See the field description for details.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum HttpState {
/// No HTTP state specified. If not specified, DeviceService will be
/// enabled by default.
Unspecified = 0,
/// Enables DeviceService (HTTP) service for the registry.
HttpEnabled = 1,
/// Disables DeviceService (HTTP) service for the registry.
HttpDisabled = 2,
}
impl HttpState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
HttpState::Unspecified => "HTTP_STATE_UNSPECIFIED",
HttpState::HttpEnabled => "HTTP_ENABLED",
HttpState::HttpDisabled => "HTTP_DISABLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"HTTP_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"HTTP_ENABLED" => Some(Self::HttpEnabled),
"HTTP_DISABLED" => Some(Self::HttpDisabled),
_ => None,
}
}
}
/// **Beta Feature**
///
/// The logging verbosity for device activity. Specifies which events should be
/// written to logs. For example, if the LogLevel is ERROR, only events that
/// terminate in errors will be logged. LogLevel is inclusive; enabling INFO
/// logging will also enable ERROR logging.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum LogLevel {
/// No logging specified. If not specified, logging will be disabled.
Unspecified = 0,
/// Disables logging.
None = 10,
/// Error events will be logged.
Error = 20,
/// Informational events will be logged, such as connections and
/// disconnections.
Info = 30,
/// All events will be logged.
Debug = 40,
}
impl LogLevel {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
LogLevel::Unspecified => "LOG_LEVEL_UNSPECIFIED",
LogLevel::None => "NONE",
LogLevel::Error => "ERROR",
LogLevel::Info => "INFO",
LogLevel::Debug => "DEBUG",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LOG_LEVEL_UNSPECIFIED" => Some(Self::Unspecified),
"NONE" => Some(Self::None),
"ERROR" => Some(Self::Error),
"INFO" => Some(Self::Info),
"DEBUG" => Some(Self::Debug),
_ => None,
}
}
}
/// Gateway type.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum GatewayType {
/// If unspecified, the device is considered a non-gateway device.
Unspecified = 0,
/// The device is a gateway.
Gateway = 1,
/// The device is not a gateway.
NonGateway = 2,
}
impl GatewayType {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
GatewayType::Unspecified => "GATEWAY_TYPE_UNSPECIFIED",
GatewayType::Gateway => "GATEWAY",
GatewayType::NonGateway => "NON_GATEWAY",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"GATEWAY_TYPE_UNSPECIFIED" => Some(Self::Unspecified),
"GATEWAY" => Some(Self::Gateway),
"NON_GATEWAY" => Some(Self::NonGateway),
_ => None,
}
}
}
/// The gateway authorization/authentication method. This setting determines how
/// Cloud IoT Core authorizes/authenticate devices to access the gateway.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum GatewayAuthMethod {
/// No authentication/authorization method specified. No devices are allowed to
/// access the gateway.
Unspecified = 0,
/// The device is authenticated through the gateway association only. Device
/// credentials are ignored even if provided.
AssociationOnly = 1,
/// The device is authenticated through its own credentials. Gateway
/// association is not checked.
DeviceAuthTokenOnly = 2,
/// The device is authenticated through both device credentials and gateway
/// association. The device must be bound to the gateway and must provide its
/// own credentials.
AssociationAndDeviceAuthToken = 3,
}
impl GatewayAuthMethod {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
GatewayAuthMethod::Unspecified => "GATEWAY_AUTH_METHOD_UNSPECIFIED",
GatewayAuthMethod::AssociationOnly => "ASSOCIATION_ONLY",
GatewayAuthMethod::DeviceAuthTokenOnly => "DEVICE_AUTH_TOKEN_ONLY",
GatewayAuthMethod::AssociationAndDeviceAuthToken => {
"ASSOCIATION_AND_DEVICE_AUTH_TOKEN"
}
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"GATEWAY_AUTH_METHOD_UNSPECIFIED" => Some(Self::Unspecified),
"ASSOCIATION_ONLY" => Some(Self::AssociationOnly),
"DEVICE_AUTH_TOKEN_ONLY" => Some(Self::DeviceAuthTokenOnly),
"ASSOCIATION_AND_DEVICE_AUTH_TOKEN" => {
Some(Self::AssociationAndDeviceAuthToken)
}
_ => None,
}
}
}
/// The supported formats for the public key.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PublicKeyCertificateFormat {
/// The format has not been specified. This is an invalid default value and
/// must not be used.
UnspecifiedPublicKeyCertificateFormat = 0,
/// An X.509v3 certificate ([RFC5280](<https://www.ietf.org/rfc/rfc5280.txt>)),
/// encoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and
/// `-----END CERTIFICATE-----`.
X509CertificatePem = 1,
}
impl PublicKeyCertificateFormat {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PublicKeyCertificateFormat::UnspecifiedPublicKeyCertificateFormat => {
"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT"
}
PublicKeyCertificateFormat::X509CertificatePem => "X509_CERTIFICATE_PEM",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT" => {
Some(Self::UnspecifiedPublicKeyCertificateFormat)
}
"X509_CERTIFICATE_PEM" => Some(Self::X509CertificatePem),
_ => None,
}
}
}
/// The supported formats for the public key.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum PublicKeyFormat {
/// The format has not been specified. This is an invalid default value and
/// must not be used.
UnspecifiedPublicKeyFormat = 0,
/// An RSA public key encoded in base64, and wrapped by
/// `-----BEGIN PUBLIC KEY-----` and `-----END PUBLIC KEY-----`. This can be
/// used to verify `RS256` signatures in JWT tokens ([RFC7518](
/// <https://www.ietf.org/rfc/rfc7518.txt>)).
RsaPem = 3,
/// As RSA_PEM, but wrapped in an X.509v3 certificate ([RFC5280](
/// <https://www.ietf.org/rfc/rfc5280.txt>)), encoded in base64, and wrapped by
/// `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
RsaX509Pem = 1,
/// Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in
/// base64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END
/// PUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`
/// algorithm ([RFC7518](<https://www.ietf.org/rfc/rfc7518.txt>)). This curve is
/// defined in [OpenSSL](<https://www.openssl.org/>) as the `prime256v1` curve.
Es256Pem = 2,
/// As ES256_PEM, but wrapped in an X.509v3 certificate ([RFC5280](
/// <https://www.ietf.org/rfc/rfc5280.txt>)), encoded in base64, and wrapped by
/// `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.
Es256X509Pem = 4,
}
impl PublicKeyFormat {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
PublicKeyFormat::UnspecifiedPublicKeyFormat => {
"UNSPECIFIED_PUBLIC_KEY_FORMAT"
}
PublicKeyFormat::RsaPem => "RSA_PEM",
PublicKeyFormat::RsaX509Pem => "RSA_X509_PEM",
PublicKeyFormat::Es256Pem => "ES256_PEM",
PublicKeyFormat::Es256X509Pem => "ES256_X509_PEM",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNSPECIFIED_PUBLIC_KEY_FORMAT" => Some(Self::UnspecifiedPublicKeyFormat),
"RSA_PEM" => Some(Self::RsaPem),
"RSA_X509_PEM" => Some(Self::RsaX509Pem),
"ES256_PEM" => Some(Self::Es256Pem),
"ES256_X509_PEM" => Some(Self::Es256X509Pem),
_ => None,
}
}
}
/// Request for `CreateDeviceRegistry`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDeviceRegistryRequest {
/// Required. The project and cloud region where this device registry must be created.
/// For example, `projects/example-project/locations/us-central1`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The device registry. The field `name` must be empty. The server will
/// generate that field from the device registry `id` provided and the
/// `parent` field.
#[prost(message, optional, tag = "2")]
pub device_registry: ::core::option::Option<DeviceRegistry>,
}
/// Request for `GetDeviceRegistry`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDeviceRegistryRequest {
/// Required. The name of the device registry. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request for `DeleteDeviceRegistry`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDeviceRegistryRequest {
/// Required. The name of the device registry. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request for `UpdateDeviceRegistry`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDeviceRegistryRequest {
/// Required. The new values for the device registry. The `id` field must be empty, and
/// the `name` field must indicate the path of the resource. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(message, optional, tag = "1")]
pub device_registry: ::core::option::Option<DeviceRegistry>,
/// Required. Only updates the `device_registry` fields indicated by this mask.
/// The field mask must not be empty, and it must not contain fields that
/// are immutable or only set by the server.
/// Mutable top-level fields: `event_notification_config`, `http_config`,
/// `mqtt_config`, and `state_notification_config`.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for `ListDeviceRegistries`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceRegistriesRequest {
/// Required. The project and cloud region path. For example,
/// `projects/example-project/locations/us-central1`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The maximum number of registries to return in the response. If this value
/// is zero, the service will select a default size. A call may return fewer
/// objects than requested. A non-empty `next_page_token` in the response
/// indicates that more data is available.
#[prost(int32, tag = "2")]
pub page_size: i32,
/// The value returned by the last `ListDeviceRegistriesResponse`; indicates
/// that this is a continuation of a prior `ListDeviceRegistries` call and
/// the system should return the next page of data.
#[prost(string, tag = "3")]
pub page_token: ::prost::alloc::string::String,
}
/// Response for `ListDeviceRegistries`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceRegistriesResponse {
/// The registries that matched the query.
#[prost(message, repeated, tag = "1")]
pub device_registries: ::prost::alloc::vec::Vec<DeviceRegistry>,
/// If not empty, indicates that there may be more registries that match the
/// request; this value should be passed in a new
/// `ListDeviceRegistriesRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for `CreateDevice`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateDeviceRequest {
/// Required. The name of the device registry where this device should be created.
/// For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The device registration details. The field `name` must be empty. The server
/// generates `name` from the device registry `id` and the
/// `parent` field.
#[prost(message, optional, tag = "2")]
pub device: ::core::option::Option<Device>,
}
/// Request for `GetDevice`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetDeviceRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The fields of the `Device` resource to be returned in the response. If the
/// field mask is unset or empty, all fields are returned. Fields have to be
/// provided in snake_case format, for example: `last_heartbeat_time`.
#[prost(message, optional, tag = "2")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for `UpdateDevice`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateDeviceRequest {
/// Required. The new values for the device. The `id` and `num_id` fields must
/// be empty, and the field `name` must specify the name path. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0`or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(message, optional, tag = "2")]
pub device: ::core::option::Option<Device>,
/// Required. Only updates the `device` fields indicated by this mask.
/// The field mask must not be empty, and it must not contain fields that
/// are immutable or only set by the server.
/// Mutable top-level fields: `credentials`, `blocked`, and `metadata`
#[prost(message, optional, tag = "3")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request for `DeleteDevice`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteDeviceRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request for `ListDevices`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDevicesRequest {
/// Required. The device registry path. Required. For example,
/// `projects/my-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// A list of device numeric IDs. If empty, this field is ignored. Maximum
/// IDs: 10,000.
#[prost(uint64, repeated, tag = "2")]
pub device_num_ids: ::prost::alloc::vec::Vec<u64>,
/// A list of device string IDs. For example, `\['device0', 'device12'\]`.
/// If empty, this field is ignored. Maximum IDs: 10,000
#[prost(string, repeated, tag = "3")]
pub device_ids: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The fields of the `Device` resource to be returned in the response. The
/// fields `id` and `num_id` are always returned, along with any
/// other fields specified in snake_case format, for example:
/// `last_heartbeat_time`.
#[prost(message, optional, tag = "4")]
pub field_mask: ::core::option::Option<::prost_types::FieldMask>,
/// Options related to gateways.
#[prost(message, optional, tag = "6")]
pub gateway_list_options: ::core::option::Option<GatewayListOptions>,
/// The maximum number of devices to return in the response. If this value
/// is zero, the service will select a default size. A call may return fewer
/// objects than requested. A non-empty `next_page_token` in the response
/// indicates that more data is available.
#[prost(int32, tag = "100")]
pub page_size: i32,
/// The value returned by the last `ListDevicesResponse`; indicates
/// that this is a continuation of a prior `ListDevices` call and
/// the system should return the next page of data.
#[prost(string, tag = "101")]
pub page_token: ::prost::alloc::string::String,
}
/// Options for limiting the list based on gateway type and associations.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GatewayListOptions {
/// If not set, all devices and gateways are returned. If set, the list is
/// filtered based on gateway type and associations.
#[prost(oneof = "gateway_list_options::Filter", tags = "1, 2, 3")]
pub filter: ::core::option::Option<gateway_list_options::Filter>,
}
/// Nested message and enum types in `GatewayListOptions`.
pub mod gateway_list_options {
/// If not set, all devices and gateways are returned. If set, the list is
/// filtered based on gateway type and associations.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum Filter {
/// If `GATEWAY` is specified, only gateways are returned. If `NON_GATEWAY`
/// is specified, only non-gateway devices are returned. If
/// `GATEWAY_TYPE_UNSPECIFIED` is specified, all devices are returned.
#[prost(enumeration = "super::GatewayType", tag = "1")]
GatewayType(i32),
/// If set, only devices associated with the specified gateway are returned.
/// The gateway ID can be numeric (`num_id`) or the user-defined string
/// (`id`). For example, if `123` is specified, only devices bound to the
/// gateway with `num_id` 123 are returned.
#[prost(string, tag = "2")]
AssociationsGatewayId(::prost::alloc::string::String),
/// If set, returns only the gateways with which the specified device is
/// associated. The device ID can be numeric (`num_id`) or the user-defined
/// string (`id`). For example, if `456` is specified, returns only the
/// gateways to which the device with `num_id` 456 is bound.
#[prost(string, tag = "3")]
AssociationsDeviceId(::prost::alloc::string::String),
}
}
/// Response for `ListDevices`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDevicesResponse {
/// The devices that match the request.
#[prost(message, repeated, tag = "1")]
pub devices: ::prost::alloc::vec::Vec<Device>,
/// If not empty, indicates that there may be more devices that match the
/// request; this value should be passed in a new `ListDevicesRequest`.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request for `ModifyCloudToDeviceConfig`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ModifyCloudToDeviceConfigRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The version number to update. If this value is zero, it will not check the
/// version number of the server and will always update the current version;
/// otherwise, this update will fail if the version number found on the server
/// does not match this version number. This is used to support multiple
/// simultaneous updates without losing data.
#[prost(int64, tag = "2")]
pub version_to_update: i64,
/// Required. The configuration data for the device.
#[prost(bytes = "bytes", tag = "3")]
pub binary_data: ::prost::bytes::Bytes,
}
/// Request for `ListDeviceConfigVersions`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceConfigVersionsRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The number of versions to list. Versions are listed in decreasing order of
/// the version number. The maximum number of versions retained is 10. If this
/// value is zero, it will return all the versions available.
#[prost(int32, tag = "2")]
pub num_versions: i32,
}
/// Response for `ListDeviceConfigVersions`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceConfigVersionsResponse {
/// The device configuration for the last few versions. Versions are listed
/// in decreasing order, starting from the most recent one.
#[prost(message, repeated, tag = "1")]
pub device_configs: ::prost::alloc::vec::Vec<DeviceConfig>,
}
/// Request for `ListDeviceStates`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceStatesRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The number of states to list. States are listed in descending order of
/// update time. The maximum number of states retained is 10. If this
/// value is zero, it will return all the states available.
#[prost(int32, tag = "2")]
pub num_states: i32,
}
/// Response for `ListDeviceStates`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListDeviceStatesResponse {
/// The last few device states. States are listed in descending order of server
/// update time, starting from the most recent one.
#[prost(message, repeated, tag = "1")]
pub device_states: ::prost::alloc::vec::Vec<DeviceState>,
}
/// Request for `SendCommandToDevice`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct SendCommandToDeviceRequest {
/// Required. The name of the device. For example,
/// `projects/p0/locations/us-central1/registries/registry0/devices/device0` or
/// `projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The command data to send to the device.
#[prost(bytes = "bytes", tag = "2")]
pub binary_data: ::prost::bytes::Bytes,
/// Optional subfolder for the command. If empty, the command will be delivered
/// to the /devices/{device-id}/commands topic, otherwise it will be delivered
/// to the /devices/{device-id}/commands/{subfolder} topic. Multi-level
/// subfolders are allowed. This field must not have more than 256 characters,
/// and must not contain any MQTT wildcards ("+" or "#") or null characters.
#[prost(string, tag = "3")]
pub subfolder: ::prost::alloc::string::String,
}
/// Response for `SendCommandToDevice`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct SendCommandToDeviceResponse {}
/// Request for `BindDeviceToGateway`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BindDeviceToGatewayRequest {
/// Required. The name of the registry. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The value of `gateway_id` can be either the device numeric ID or the
/// user-defined device identifier.
#[prost(string, tag = "2")]
pub gateway_id: ::prost::alloc::string::String,
/// Required. The device to associate with the specified gateway. The value of
/// `device_id` can be either the device numeric ID or the user-defined device
/// identifier.
#[prost(string, tag = "3")]
pub device_id: ::prost::alloc::string::String,
}
/// Response for `BindDeviceToGateway`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct BindDeviceToGatewayResponse {}
/// Request for `UnbindDeviceFromGateway`.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UnbindDeviceFromGatewayRequest {
/// Required. The name of the registry. For example,
/// `projects/example-project/locations/us-central1/registries/my-registry`.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The value of `gateway_id` can be either the device numeric ID or the
/// user-defined device identifier.
#[prost(string, tag = "2")]
pub gateway_id: ::prost::alloc::string::String,
/// Required. The device to disassociate from the specified gateway. The value of
/// `device_id` can be either the device numeric ID or the user-defined device
/// identifier.
#[prost(string, tag = "3")]
pub device_id: ::prost::alloc::string::String,
}
/// Response for `UnbindDeviceFromGateway`.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct UnbindDeviceFromGatewayResponse {}
/// Generated client implementations.
pub mod device_manager_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Internet of Things (IoT) service. Securely connect and manage IoT devices.
#[derive(Debug, Clone)]
pub struct DeviceManagerClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> DeviceManagerClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> DeviceManagerClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
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> + std::marker::Send + std::marker::Sync,
{
DeviceManagerClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// Creates a device registry that contains devices.
pub async fn create_device_registry(
&mut self,
request: impl tonic::IntoRequest<super::CreateDeviceRegistryRequest>,
) -> std::result::Result<tonic::Response<super::DeviceRegistry>, 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.cloud.iot.v1.DeviceManager/CreateDeviceRegistry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"CreateDeviceRegistry",
),
);
self.inner.unary(req, path, codec).await
}
/// Gets a device registry configuration.
pub async fn get_device_registry(
&mut self,
request: impl tonic::IntoRequest<super::GetDeviceRegistryRequest>,
) -> std::result::Result<tonic::Response<super::DeviceRegistry>, 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.cloud.iot.v1.DeviceManager/GetDeviceRegistry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"GetDeviceRegistry",
),
);
self.inner.unary(req, path, codec).await
}
/// Updates a device registry configuration.
pub async fn update_device_registry(
&mut self,
request: impl tonic::IntoRequest<super::UpdateDeviceRegistryRequest>,
) -> std::result::Result<tonic::Response<super::DeviceRegistry>, 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.cloud.iot.v1.DeviceManager/UpdateDeviceRegistry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"UpdateDeviceRegistry",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a device registry configuration.
pub async fn delete_device_registry(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDeviceRegistryRequest>,
) -> std::result::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.cloud.iot.v1.DeviceManager/DeleteDeviceRegistry",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"DeleteDeviceRegistry",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists device registries.
pub async fn list_device_registries(
&mut self,
request: impl tonic::IntoRequest<super::ListDeviceRegistriesRequest>,
) -> std::result::Result<
tonic::Response<super::ListDeviceRegistriesResponse>,
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.cloud.iot.v1.DeviceManager/ListDeviceRegistries",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"ListDeviceRegistries",
),
);
self.inner.unary(req, path, codec).await
}
/// Creates a device in a device registry.
pub async fn create_device(
&mut self,
request: impl tonic::IntoRequest<super::CreateDeviceRequest>,
) -> std::result::Result<tonic::Response<super::Device>, 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.cloud.iot.v1.DeviceManager/CreateDevice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "CreateDevice"),
);
self.inner.unary(req, path, codec).await
}
/// Gets details about a device.
pub async fn get_device(
&mut self,
request: impl tonic::IntoRequest<super::GetDeviceRequest>,
) -> std::result::Result<tonic::Response<super::Device>, 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.cloud.iot.v1.DeviceManager/GetDevice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "GetDevice"),
);
self.inner.unary(req, path, codec).await
}
/// Updates a device.
pub async fn update_device(
&mut self,
request: impl tonic::IntoRequest<super::UpdateDeviceRequest>,
) -> std::result::Result<tonic::Response<super::Device>, 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.cloud.iot.v1.DeviceManager/UpdateDevice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "UpdateDevice"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a device.
pub async fn delete_device(
&mut self,
request: impl tonic::IntoRequest<super::DeleteDeviceRequest>,
) -> std::result::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.cloud.iot.v1.DeviceManager/DeleteDevice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "DeleteDevice"),
);
self.inner.unary(req, path, codec).await
}
/// List devices in a device registry.
pub async fn list_devices(
&mut self,
request: impl tonic::IntoRequest<super::ListDevicesRequest>,
) -> std::result::Result<
tonic::Response<super::ListDevicesResponse>,
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.cloud.iot.v1.DeviceManager/ListDevices",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "ListDevices"),
);
self.inner.unary(req, path, codec).await
}
/// Modifies the configuration for the device, which is eventually sent from
/// the Cloud IoT Core servers. Returns the modified configuration version and
/// its metadata.
pub async fn modify_cloud_to_device_config(
&mut self,
request: impl tonic::IntoRequest<super::ModifyCloudToDeviceConfigRequest>,
) -> std::result::Result<tonic::Response<super::DeviceConfig>, 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.cloud.iot.v1.DeviceManager/ModifyCloudToDeviceConfig",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"ModifyCloudToDeviceConfig",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the last few versions of the device configuration in descending
/// order (i.e.: newest first).
pub async fn list_device_config_versions(
&mut self,
request: impl tonic::IntoRequest<super::ListDeviceConfigVersionsRequest>,
) -> std::result::Result<
tonic::Response<super::ListDeviceConfigVersionsResponse>,
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.cloud.iot.v1.DeviceManager/ListDeviceConfigVersions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"ListDeviceConfigVersions",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the last few versions of the device state in descending order (i.e.:
/// newest first).
pub async fn list_device_states(
&mut self,
request: impl tonic::IntoRequest<super::ListDeviceStatesRequest>,
) -> std::result::Result<
tonic::Response<super::ListDeviceStatesResponse>,
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.cloud.iot.v1.DeviceManager/ListDeviceStates",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"ListDeviceStates",
),
);
self.inner.unary(req, path, codec).await
}
/// Sets the access control policy on the specified resource. Replaces any
/// existing policy.
pub async fn set_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::SetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
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.cloud.iot.v1.DeviceManager/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "SetIamPolicy"),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for a resource.
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
pub async fn get_iam_policy(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::GetIamPolicyRequest,
>,
) -> std::result::Result<
tonic::Response<super::super::super::super::iam::v1::Policy>,
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.cloud.iot.v1.DeviceManager/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.iot.v1.DeviceManager", "GetIamPolicy"),
);
self.inner.unary(req, path, codec).await
}
/// Returns permissions that a caller has on the specified resource.
/// If the resource does not exist, this will return an empty set of
/// permissions, not a NOT_FOUND error.
pub async fn test_iam_permissions(
&mut self,
request: impl tonic::IntoRequest<
super::super::super::super::iam::v1::TestIamPermissionsRequest,
>,
) -> std::result::Result<
tonic::Response<
super::super::super::super::iam::v1::TestIamPermissionsResponse,
>,
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.cloud.iot.v1.DeviceManager/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
/// Sends a command to the specified device. In order for a device to be able
/// to receive commands, it must:
/// 1) be connected to Cloud IoT Core using the MQTT protocol, and
/// 2) be subscribed to the group of MQTT topics specified by
/// /devices/{device-id}/commands/#. This subscription will receive commands
/// at the top-level topic /devices/{device-id}/commands as well as commands
/// for subfolders, like /devices/{device-id}/commands/subfolder.
/// Note that subscribing to specific subfolders is not supported.
/// If the command could not be delivered to the device, this method will
/// return an error; in particular, if the device is not subscribed, this
/// method will return FAILED_PRECONDITION. Otherwise, this method will
/// return OK. If the subscription is QoS 1, at least once delivery will be
/// guaranteed; for QoS 0, no acknowledgment will be expected from the device.
pub async fn send_command_to_device(
&mut self,
request: impl tonic::IntoRequest<super::SendCommandToDeviceRequest>,
) -> std::result::Result<
tonic::Response<super::SendCommandToDeviceResponse>,
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.cloud.iot.v1.DeviceManager/SendCommandToDevice",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"SendCommandToDevice",
),
);
self.inner.unary(req, path, codec).await
}
/// Associates the device with the gateway.
pub async fn bind_device_to_gateway(
&mut self,
request: impl tonic::IntoRequest<super::BindDeviceToGatewayRequest>,
) -> std::result::Result<
tonic::Response<super::BindDeviceToGatewayResponse>,
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.cloud.iot.v1.DeviceManager/BindDeviceToGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"BindDeviceToGateway",
),
);
self.inner.unary(req, path, codec).await
}
/// Deletes the association between the device and the gateway.
pub async fn unbind_device_from_gateway(
&mut self,
request: impl tonic::IntoRequest<super::UnbindDeviceFromGatewayRequest>,
) -> std::result::Result<
tonic::Response<super::UnbindDeviceFromGatewayResponse>,
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.cloud.iot.v1.DeviceManager/UnbindDeviceFromGateway",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.iot.v1.DeviceManager",
"UnbindDeviceFromGateway",
),
);
self.inner.unary(req, path, codec).await
}
}
}