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 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987
// This file is @generated by prost-build.
/// HTTP request.
///
/// The task will be pushed to the worker as an HTTP request. If the worker
/// or the redirected worker acknowledges the task by returning a successful HTTP
/// response code (\[`200` - `299`\]), the task will be removed from the queue. If
/// any other HTTP response code is returned or no response is received, the
/// task will be retried according to the following:
///
/// * User-specified throttling: [retry
/// configuration][google.cloud.tasks.v2.Queue.retry_config],
/// [rate limits][google.cloud.tasks.v2.Queue.rate_limits], and the [queue's
/// state][google.cloud.tasks.v2.Queue.state].
///
/// * System throttling: To prevent the worker from overloading, Cloud Tasks may
/// temporarily reduce the queue's effective rate. User-specified settings
/// will not be changed.
///
/// System throttling happens because:
///
/// * Cloud Tasks backs off on all errors. Normally the backoff specified in
/// [rate limits][google.cloud.tasks.v2.Queue.rate_limits] will be used. But
/// if the worker returns `429` (Too Many Requests), `503` (Service
/// Unavailable), or the rate of errors is high, Cloud Tasks will use a
/// higher backoff rate. The retry specified in the `Retry-After` HTTP
/// response header is considered.
///
/// * To prevent traffic spikes and to smooth sudden increases in traffic,
/// dispatches ramp up slowly when the queue is newly created or idle and
/// if large numbers of tasks suddenly become available to dispatch (due to
/// spikes in create task rates, the queue being unpaused, or many tasks
/// that are scheduled at the same time).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct HttpRequest {
/// Required. The full url path that the request will be sent to.
///
/// This string must begin with either "<http://"> or "<https://".> Some examples
/// are: `<http://acme.com`> and `<https://acme.com/sales:8080`.> Cloud Tasks will
/// encode some characters for safety and compatibility. The maximum allowed
/// URL length is 2083 characters after encoding.
///
/// The `Location` header response from a redirect response \[`300` - `399`\]
/// may be followed. The redirect is not counted as a separate attempt.
#[prost(string, tag = "1")]
pub url: ::prost::alloc::string::String,
/// The HTTP method to use for the request. The default is POST.
#[prost(enumeration = "HttpMethod", tag = "2")]
pub http_method: i32,
/// HTTP request headers.
///
/// This map contains the header field names and values.
/// Headers can be set when the
/// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
///
/// These headers represent a subset of the headers that will accompany the
/// task's HTTP request. Some HTTP request headers will be ignored or replaced.
///
/// A partial list of headers that will be ignored or replaced is:
///
/// * Host: This will be computed by Cloud Tasks and derived from
/// [HttpRequest.url][google.cloud.tasks.v2.HttpRequest.url].
/// * Content-Length: This will be computed by Cloud Tasks.
/// * User-Agent: This will be set to `"Google-Cloud-Tasks"`.
/// * `X-Google-*`: Google use only.
/// * `X-AppEngine-*`: Google use only.
///
/// `Content-Type` won't be set by Cloud Tasks. You can explicitly set
/// `Content-Type` to a media type when the
/// [task is created][google.cloud.tasks.v2beta3.CloudTasks.CreateTask].
/// For example, `Content-Type` can be set to `"application/octet-stream"` or
/// `"application/json"`.
///
/// Headers which can have multiple values (according to RFC2616) can be
/// specified using comma-separated values.
///
/// The size of the headers must be less than 80KB.
#[prost(btree_map = "string, string", tag = "3")]
pub headers: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// HTTP request body.
///
/// A request body is allowed only if the
/// [HTTP method][google.cloud.tasks.v2.HttpRequest.http_method] is POST, PUT,
/// or PATCH. It is an error to set body on a task with an incompatible
/// [HttpMethod][google.cloud.tasks.v2.HttpMethod].
#[prost(bytes = "bytes", tag = "4")]
pub body: ::prost::bytes::Bytes,
/// The mode for generating an `Authorization` header for HTTP requests.
///
/// If specified, all `Authorization` headers in the
/// [HttpRequest.headers][google.cloud.tasks.v2.HttpRequest.headers] field will
/// be overridden.
#[prost(oneof = "http_request::AuthorizationHeader", tags = "5, 6")]
pub authorization_header: ::core::option::Option<http_request::AuthorizationHeader>,
}
/// Nested message and enum types in `HttpRequest`.
pub mod http_request {
/// The mode for generating an `Authorization` header for HTTP requests.
///
/// If specified, all `Authorization` headers in the
/// [HttpRequest.headers][google.cloud.tasks.v2.HttpRequest.headers] field will
/// be overridden.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum AuthorizationHeader {
/// If specified, an
/// [OAuth token](<https://developers.google.com/identity/protocols/OAuth2>)
/// will be generated and attached as an `Authorization` header in the HTTP
/// request.
///
/// This type of authorization should generally only be used when calling
/// Google APIs hosted on *.googleapis.com.
#[prost(message, tag = "5")]
OauthToken(super::OAuthToken),
/// If specified, an
/// [OIDC](<https://developers.google.com/identity/protocols/OpenIDConnect>)
/// token will be generated and attached as an `Authorization` header in the
/// HTTP request.
///
/// This type of authorization can be used for many scenarios, including
/// calling Cloud Run, or endpoints where you intend to validate the token
/// yourself.
#[prost(message, tag = "6")]
OidcToken(super::OidcToken),
}
}
/// App Engine HTTP request.
///
/// The message defines the HTTP request that is sent to an App Engine app when
/// the task is dispatched.
///
/// Using [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest]
/// requires
/// [`appengine.applications.get`](<https://cloud.google.com/appengine/docs/admin-api/access-control>)
/// Google IAM permission for the project
/// and the following scope:
///
/// `<https://www.googleapis.com/auth/cloud-platform`>
///
/// The task will be delivered to the App Engine app which belongs to the same
/// project as the queue. For more information, see
/// [How Requests are
/// Routed](<https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>)
/// and how routing is affected by
/// [dispatch
/// files](<https://cloud.google.com/appengine/docs/python/config/dispatchref>).
/// Traffic is encrypted during transport and never leaves Google datacenters.
/// Because this traffic is carried over a communication mechanism internal to
/// Google, you cannot explicitly set the protocol (for example, HTTP or HTTPS).
/// The request to the handler, however, will appear to have used the HTTP
/// protocol.
///
/// The [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] used to
/// construct the URL that the task is delivered to can be set at the queue-level
/// or task-level:
///
/// * If [app_engine_routing_override is set on the
/// queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this value
/// is used for all tasks in the queue, no matter what the setting is for the
/// [task-level
/// app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
///
///
/// The `url` that the task will be sent to is:
///
/// * `url =` [host][google.cloud.tasks.v2.AppEngineRouting.host] `+`
/// [relative_uri][google.cloud.tasks.v2.AppEngineHttpRequest.relative_uri]
///
/// Tasks can be dispatched to secure app handlers, unsecure app handlers, and
/// URIs restricted with
/// [`login:
/// admin`](<https://cloud.google.com/appengine/docs/standard/python/config/appref>).
/// Because tasks are not run as any user, they cannot be dispatched to URIs
/// restricted with
/// [`login:
/// required`](<https://cloud.google.com/appengine/docs/standard/python/config/appref>)
/// Task dispatches also do not follow redirects.
///
/// The task attempt has succeeded if the app's request handler returns an HTTP
/// response code in the range \[`200` - `299`\]. The task attempt has failed if
/// the app's handler returns a non-2xx response code or Cloud Tasks does
/// not receive response before the
/// [deadline][google.cloud.tasks.v2.Task.dispatch_deadline]. Failed tasks will
/// be retried according to the [retry
/// configuration][google.cloud.tasks.v2.Queue.retry_config]. `503` (Service
/// Unavailable) is considered an App Engine system error instead of an
/// application error and will cause Cloud Tasks' traffic congestion control to
/// temporarily throttle the queue's dispatches. Unlike other types of task
/// targets, a `429` (Too Many Requests) response from an app handler does not
/// cause traffic congestion control to throttle the queue.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AppEngineHttpRequest {
/// The HTTP method to use for the request. The default is POST.
///
/// The app's request handler for the task's target URL must be able to handle
/// HTTP requests with this http_method, otherwise the task attempt fails with
/// error code 405 (Method Not Allowed). See [Writing a push task request
/// handler](<https://cloud.google.com/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler>)
/// and the App Engine documentation for your runtime on [How Requests are
/// Handled](<https://cloud.google.com/appengine/docs/standard/python3/how-requests-are-handled>).
#[prost(enumeration = "HttpMethod", tag = "1")]
pub http_method: i32,
/// Task-level setting for App Engine routing.
///
/// * If [app_engine_routing_override is set on the
/// queue][google.cloud.tasks.v2.Queue.app_engine_routing_override], this
/// value is used for all tasks in the queue, no matter what the setting is
/// for the [task-level
/// app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
#[prost(message, optional, tag = "2")]
pub app_engine_routing: ::core::option::Option<AppEngineRouting>,
/// The relative URI.
///
/// The relative URI must begin with "/" and must be a valid HTTP relative URI.
/// It can contain a path and query string arguments.
/// If the relative URI is empty, then the root path "/" will be used.
/// No spaces are allowed, and the maximum length allowed is 2083 characters.
#[prost(string, tag = "3")]
pub relative_uri: ::prost::alloc::string::String,
/// HTTP request headers.
///
/// This map contains the header field names and values.
/// Headers can be set when the
/// [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
/// Repeated headers are not supported but a header value can contain commas.
///
/// Cloud Tasks sets some headers to default values:
///
/// * `User-Agent`: By default, this header is
/// `"AppEngine-Google; (+<http://code.google.com/appengine>)"`.
/// This header can be modified, but Cloud Tasks will append
/// `"AppEngine-Google; (+<http://code.google.com/appengine>)"` to the
/// modified `User-Agent`.
///
/// If the task has a [body][google.cloud.tasks.v2.AppEngineHttpRequest.body],
/// Cloud Tasks sets the following headers:
///
/// * `Content-Type`: By default, the `Content-Type` header is set to
/// `"application/octet-stream"`. The default can be overridden by explicitly
/// setting `Content-Type` to a particular media type when the
/// [task is created][google.cloud.tasks.v2.CloudTasks.CreateTask].
/// For example, `Content-Type` can be set to `"application/json"`.
/// * `Content-Length`: This is computed by Cloud Tasks. This value is
/// output only. It cannot be changed.
///
/// The headers below cannot be set or overridden:
///
/// * `Host`
/// * `X-Google-*`
/// * `X-AppEngine-*`
///
/// In addition, Cloud Tasks sets some headers when the task is dispatched,
/// such as headers containing information about the task; see
/// [request
/// headers](<https://cloud.google.com/tasks/docs/creating-appengine-handlers#reading_request_headers>).
/// These headers are set only when the task is dispatched, so they are not
/// visible when the task is returned in a Cloud Tasks response.
///
/// Although there is no specific limit for the maximum number of headers or
/// the size, there is a limit on the maximum size of the
/// [Task][google.cloud.tasks.v2.Task]. For more information, see the
/// [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask] documentation.
#[prost(btree_map = "string, string", tag = "4")]
pub headers: ::prost::alloc::collections::BTreeMap<
::prost::alloc::string::String,
::prost::alloc::string::String,
>,
/// HTTP request body.
///
/// A request body is allowed only if the HTTP method is POST or PUT. It is
/// an error to set a body on a task with an incompatible
/// [HttpMethod][google.cloud.tasks.v2.HttpMethod].
#[prost(bytes = "bytes", tag = "5")]
pub body: ::prost::bytes::Bytes,
}
/// App Engine Routing.
///
/// Defines routing characteristics specific to App Engine - service, version,
/// and instance.
///
/// For more information about services, versions, and instances see
/// [An Overview of App
/// Engine](<https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine>),
/// [Microservices Architecture on Google App
/// Engine](<https://cloud.google.com/appengine/docs/python/microservices-on-app-engine>),
/// [App Engine Standard request
/// routing](<https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>),
/// and [App Engine Flex request
/// routing](<https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>).
///
/// Using [AppEngineRouting][google.cloud.tasks.v2.AppEngineRouting] requires
/// [`appengine.applications.get`](<https://cloud.google.com/appengine/docs/admin-api/access-control>)
/// Google IAM permission for the project
/// and the following scope:
///
/// `<https://www.googleapis.com/auth/cloud-platform`>
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AppEngineRouting {
/// App service.
///
/// By default, the task is sent to the service which is the default
/// service when the task is attempted.
///
/// For some queues or tasks which were created using the App Engine
/// Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not
/// parsable into [service][google.cloud.tasks.v2.AppEngineRouting.service],
/// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
/// [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example,
/// some tasks which were created using the App Engine SDK use a custom domain
/// name; custom domains are not parsed by Cloud Tasks. If
/// [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
/// [service][google.cloud.tasks.v2.AppEngineRouting.service],
/// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
/// [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty
/// string.
#[prost(string, tag = "1")]
pub service: ::prost::alloc::string::String,
/// App version.
///
/// By default, the task is sent to the version which is the default
/// version when the task is attempted.
///
/// For some queues or tasks which were created using the App Engine
/// Task Queue API, [host][google.cloud.tasks.v2.AppEngineRouting.host] is not
/// parsable into [service][google.cloud.tasks.v2.AppEngineRouting.service],
/// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
/// [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. For example,
/// some tasks which were created using the App Engine SDK use a custom domain
/// name; custom domains are not parsed by Cloud Tasks. If
/// [host][google.cloud.tasks.v2.AppEngineRouting.host] is not parsable, then
/// [service][google.cloud.tasks.v2.AppEngineRouting.service],
/// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
/// [instance][google.cloud.tasks.v2.AppEngineRouting.instance] are the empty
/// string.
#[prost(string, tag = "2")]
pub version: ::prost::alloc::string::String,
/// App instance.
///
/// By default, the task is sent to an instance which is available when
/// the task is attempted.
///
/// Requests can only be sent to a specific instance if
/// [manual scaling is used in App Engine
/// Standard](<https://cloud.google.com/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes>).
/// App Engine Flex does not support instances. For more information, see
/// [App Engine Standard request
/// routing](<https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>)
/// and [App Engine Flex request
/// routing](<https://cloud.google.com/appengine/docs/flexible/python/how-requests-are-routed>).
#[prost(string, tag = "3")]
pub instance: ::prost::alloc::string::String,
/// Output only. The host that the task is sent to.
///
/// The host is constructed from the domain name of the app associated with
/// the queue's project ID (for example <app-id>.appspot.com), and the
/// [service][google.cloud.tasks.v2.AppEngineRouting.service],
/// [version][google.cloud.tasks.v2.AppEngineRouting.version], and
/// [instance][google.cloud.tasks.v2.AppEngineRouting.instance]. Tasks which
/// were created using the App Engine SDK might have a custom domain name.
///
/// For more information, see
/// [How Requests are
/// Routed](<https://cloud.google.com/appengine/docs/standard/python/how-requests-are-routed>).
#[prost(string, tag = "4")]
pub host: ::prost::alloc::string::String,
}
/// Contains information needed for generating an
/// [OAuth token](<https://developers.google.com/identity/protocols/OAuth2>).
/// This type of authorization should generally only be used when calling Google
/// APIs hosted on *.googleapis.com.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OAuthToken {
/// [Service account email](<https://cloud.google.com/iam/docs/service-accounts>)
/// to be used for generating OAuth token.
/// The service account must be within the same project as the queue. The
/// caller must have iam.serviceAccounts.actAs permission for the service
/// account.
#[prost(string, tag = "1")]
pub service_account_email: ::prost::alloc::string::String,
/// OAuth scope to be used for generating OAuth access token.
/// If not specified, "<https://www.googleapis.com/auth/cloud-platform">
/// will be used.
#[prost(string, tag = "2")]
pub scope: ::prost::alloc::string::String,
}
/// Contains information needed for generating an
/// [OpenID Connect
/// token](<https://developers.google.com/identity/protocols/OpenIDConnect>).
/// This type of authorization can be used for many scenarios, including
/// calling Cloud Run, or endpoints where you intend to validate the token
/// yourself.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct OidcToken {
/// [Service account email](<https://cloud.google.com/iam/docs/service-accounts>)
/// to be used for generating OIDC token.
/// The service account must be within the same project as the queue. The
/// caller must have 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. If not specified, the URI
/// specified in target will be used.
#[prost(string, tag = "2")]
pub audience: ::prost::alloc::string::String,
}
/// The HTTP method used to deliver the task.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum HttpMethod {
/// HTTP method unspecified
Unspecified = 0,
/// HTTP POST
Post = 1,
/// HTTP GET
Get = 2,
/// HTTP HEAD
Head = 3,
/// HTTP PUT
Put = 4,
/// HTTP DELETE
Delete = 5,
/// HTTP PATCH
Patch = 6,
/// HTTP OPTIONS
Options = 7,
}
impl HttpMethod {
/// 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 {
HttpMethod::Unspecified => "HTTP_METHOD_UNSPECIFIED",
HttpMethod::Post => "POST",
HttpMethod::Get => "GET",
HttpMethod::Head => "HEAD",
HttpMethod::Put => "PUT",
HttpMethod::Delete => "DELETE",
HttpMethod::Patch => "PATCH",
HttpMethod::Options => "OPTIONS",
}
}
/// 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_METHOD_UNSPECIFIED" => Some(Self::Unspecified),
"POST" => Some(Self::Post),
"GET" => Some(Self::Get),
"HEAD" => Some(Self::Head),
"PUT" => Some(Self::Put),
"DELETE" => Some(Self::Delete),
"PATCH" => Some(Self::Patch),
"OPTIONS" => Some(Self::Options),
_ => None,
}
}
}
/// A queue is a container of related tasks. Queues are configured to manage
/// how those tasks are dispatched. Configurable properties include rate limits,
/// retry options, queue types, and others.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Queue {
/// Caller-specified and required in
/// [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue], after which it
/// becomes output only.
///
/// The queue name.
///
/// The queue name must have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
///
/// * `PROJECT_ID` can contain letters (\[A-Za-z\]), numbers (\[0-9\]),
/// hyphens (-), colons (:), or periods (.).
/// For more information, see
/// [Identifying
/// projects](<https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects>)
/// * `LOCATION_ID` is the canonical ID for the queue's location.
/// The list of available locations can be obtained by calling
/// [ListLocations][google.cloud.location.Locations.ListLocations].
/// For more information, see <https://cloud.google.com/about/locations/.>
/// * `QUEUE_ID` can contain letters (\[A-Za-z\]), numbers (\[0-9\]), or
/// hyphens (-). The maximum length is 100 characters.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Overrides for
/// [task-level
/// app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
/// These settings apply only to
/// [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in this
/// queue. [Http tasks][google.cloud.tasks.v2.HttpRequest] are not affected.
///
/// If set, `app_engine_routing_override` is used for all
/// [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest] in the
/// queue, no matter what the setting is for the [task-level
/// app_engine_routing][google.cloud.tasks.v2.AppEngineHttpRequest.app_engine_routing].
#[prost(message, optional, tag = "2")]
pub app_engine_routing_override: ::core::option::Option<AppEngineRouting>,
/// Rate limits for task dispatches.
///
/// [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] and
/// [retry_config][google.cloud.tasks.v2.Queue.retry_config] are related
/// because they both control task attempts. However they control task attempts
/// in different ways:
///
/// * [rate_limits][google.cloud.tasks.v2.Queue.rate_limits] controls the total
/// rate of
/// dispatches from a queue (i.e. all traffic dispatched from the
/// queue, regardless of whether the dispatch is from a first
/// attempt or a retry).
/// * [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls what
/// happens to
/// particular a task after its first attempt fails. That is,
/// [retry_config][google.cloud.tasks.v2.Queue.retry_config] controls task
/// retries (the second attempt, third attempt, etc).
///
/// The queue's actual dispatch rate is the result of:
///
/// * Number of tasks in the queue
/// * User-specified throttling:
/// [rate_limits][google.cloud.tasks.v2.Queue.rate_limits],
/// [retry_config][google.cloud.tasks.v2.Queue.retry_config], and the
/// [queue's state][google.cloud.tasks.v2.Queue.state].
/// * System throttling due to `429` (Too Many Requests) or `503` (Service
/// Unavailable) responses from the worker, high error rates, or to smooth
/// sudden large traffic spikes.
#[prost(message, optional, tag = "3")]
pub rate_limits: ::core::option::Option<RateLimits>,
/// Settings that determine the retry behavior.
///
/// * For tasks created using Cloud Tasks: the queue-level retry settings
/// apply to all tasks in the queue that were created using Cloud Tasks.
/// Retry settings cannot be set on individual tasks.
/// * For tasks created using the App Engine SDK: the queue-level retry
/// settings apply to all tasks in the queue which do not have retry settings
/// explicitly set on the task and were created by the App Engine SDK. See
/// [App Engine
/// documentation](<https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/retrying-tasks>).
#[prost(message, optional, tag = "4")]
pub retry_config: ::core::option::Option<RetryConfig>,
/// Output only. The state of the queue.
///
/// `state` can only be changed by calling
/// [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue],
/// [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue], or uploading
/// [queue.yaml/xml](<https://cloud.google.com/appengine/docs/python/config/queueref>).
/// [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] cannot be used
/// to change `state`.
#[prost(enumeration = "queue::State", tag = "5")]
pub state: i32,
/// Output only. The last time this queue was purged.
///
/// All tasks that were [created][google.cloud.tasks.v2.Task.create_time]
/// before this time were purged.
///
/// A queue can be purged using
/// [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue], the [App Engine
/// Task Queue SDK, or the Cloud
/// Console](<https://cloud.google.com/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue>).
///
/// Purge time will be truncated to the nearest microsecond. Purge
/// time will be unset if the queue has never been purged.
#[prost(message, optional, tag = "6")]
pub purge_time: ::core::option::Option<::prost_types::Timestamp>,
/// Configuration options for writing logs to
/// [Stackdriver Logging](<https://cloud.google.com/logging/docs/>). If this
/// field is unset, then no logs are written.
#[prost(message, optional, tag = "9")]
pub stackdriver_logging_config: ::core::option::Option<StackdriverLoggingConfig>,
}
/// Nested message and enum types in `Queue`.
pub mod queue {
/// State of the queue.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum State {
/// Unspecified state.
Unspecified = 0,
/// The queue is running. Tasks can be dispatched.
///
/// If the queue was created using Cloud Tasks and the queue has
/// had no activity (method calls or task dispatches) for 30 days,
/// the queue may take a few minutes to re-activate. Some method
/// calls may return [NOT_FOUND][google.rpc.Code.NOT_FOUND] and
/// tasks may not be dispatched for a few minutes until the queue
/// has been re-activated.
Running = 1,
/// Tasks are paused by the user. If the queue is paused then Cloud
/// Tasks will stop delivering tasks from it, but more tasks can
/// still be added to it by the user.
Paused = 2,
/// The queue is disabled.
///
/// A queue becomes `DISABLED` when
/// [queue.yaml](<https://cloud.google.com/appengine/docs/python/config/queueref>)
/// or
/// [queue.xml](<https://cloud.google.com/appengine/docs/standard/java/config/queueref>)
/// is uploaded which does not contain the queue. You cannot directly disable
/// a queue.
///
/// When a queue is disabled, tasks can still be added to a queue
/// but the tasks are not dispatched.
///
/// To permanently delete this queue and all of its tasks, call
/// [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
Disabled = 3,
}
impl State {
/// 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 {
State::Unspecified => "STATE_UNSPECIFIED",
State::Running => "RUNNING",
State::Paused => "PAUSED",
State::Disabled => "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 {
"STATE_UNSPECIFIED" => Some(Self::Unspecified),
"RUNNING" => Some(Self::Running),
"PAUSED" => Some(Self::Paused),
"DISABLED" => Some(Self::Disabled),
_ => None,
}
}
}
}
/// Rate limits.
///
/// This message determines the maximum rate that tasks can be dispatched by a
/// queue, regardless of whether the dispatch is a first task attempt or a retry.
///
/// Note: The debugging command,
/// [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask], will run a task even if
/// the queue has reached its [RateLimits][google.cloud.tasks.v2.RateLimits].
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RateLimits {
/// The maximum rate at which tasks are dispatched from this queue.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
/// * The maximum allowed value is 500.
///
///
/// This field has the same meaning as
/// [rate in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#rate>).
#[prost(double, tag = "1")]
pub max_dispatches_per_second: f64,
/// Output only. The max burst size.
///
/// Max burst size limits how fast tasks in queue are processed when
/// many tasks are in the queue and the rate is high. This field
/// allows the queue to have a high rate so processing starts shortly
/// after a task is enqueued, but still limits resource usage when
/// many tasks are enqueued in a short period of time.
///
/// The [token bucket](<https://wikipedia.org/wiki/Token_Bucket>)
/// algorithm is used to control the rate of task dispatches. Each
/// queue has a token bucket that holds tokens, up to the maximum
/// specified by `max_burst_size`. Each time a task is dispatched, a
/// token is removed from the bucket. Tasks will be dispatched until
/// the queue's bucket runs out of tokens. The bucket will be
/// continuously refilled with new tokens based on
/// [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
///
/// Cloud Tasks will pick the value of `max_burst_size` based on the
/// value of
/// [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second].
///
/// For queues that were created or updated using
/// `queue.yaml/xml`, `max_burst_size` is equal to
/// [bucket_size](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#bucket_size>).
/// Since `max_burst_size` is output only, if
/// [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue] is called on a
/// queue created by `queue.yaml/xml`, `max_burst_size` will be reset based on
/// the value of
/// [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second],
/// regardless of whether
/// [max_dispatches_per_second][google.cloud.tasks.v2.RateLimits.max_dispatches_per_second]
/// is updated.
///
#[prost(int32, tag = "2")]
pub max_burst_size: i32,
/// The maximum number of concurrent tasks that Cloud Tasks allows
/// to be dispatched for this queue. After this threshold has been
/// reached, Cloud Tasks stops dispatching tasks until the number of
/// concurrent requests decreases.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
///
/// The maximum allowed value is 5,000.
///
///
/// This field has the same meaning as
/// [max_concurrent_requests in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#max_concurrent_requests>).
#[prost(int32, tag = "3")]
pub max_concurrent_dispatches: i32,
}
/// Retry config.
///
/// These settings determine when a failed task attempt is retried.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct RetryConfig {
/// Number of attempts per task.
///
/// Cloud Tasks will attempt the task `max_attempts` times (that is, if the
/// first attempt fails, then there will be `max_attempts - 1` retries). Must
/// be >= -1.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
/// -1 indicates unlimited attempts.
///
/// This field has the same meaning as
/// [task_retry_limit in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>).
#[prost(int32, tag = "1")]
pub max_attempts: i32,
/// If positive, `max_retry_duration` specifies the time limit for
/// retrying a failed task, measured from when the task was first
/// attempted. Once `max_retry_duration` time has passed *and* the
/// task has been attempted
/// [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times, no
/// further attempts will be made and the task will be deleted.
///
/// If zero, then the task age is unlimited.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
///
/// `max_retry_duration` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [task_age_limit in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>).
#[prost(message, optional, tag = "2")]
pub max_retry_duration: ::core::option::Option<::prost_types::Duration>,
/// A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
/// retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
/// and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
/// after it fails, if the queue's
/// [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
/// should be retried.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
///
/// `min_backoff` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [min_backoff_seconds in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>).
#[prost(message, optional, tag = "3")]
pub min_backoff: ::core::option::Option<::prost_types::Duration>,
/// A task will be [scheduled][google.cloud.tasks.v2.Task.schedule_time] for
/// retry between [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff]
/// and [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] duration
/// after it fails, if the queue's
/// [RetryConfig][google.cloud.tasks.v2.RetryConfig] specifies that the task
/// should be retried.
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
///
/// `max_backoff` will be truncated to the nearest second.
///
/// This field has the same meaning as
/// [max_backoff_seconds in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>).
#[prost(message, optional, tag = "4")]
pub max_backoff: ::core::option::Option<::prost_types::Duration>,
/// The time between retries will double `max_doublings` times.
///
/// A task's retry interval starts at
/// [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff], then doubles
/// `max_doublings` times, then increases linearly, and finally
/// retries at intervals of
/// [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] up to
/// [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times.
///
/// For example, if
/// [min_backoff][google.cloud.tasks.v2.RetryConfig.min_backoff] is 10s,
/// [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff] is 300s, and
/// `max_doublings` is 3, then the a task will first be retried in
/// 10s. The retry interval will double three times, and then
/// increase linearly by 2^3 * 10s. Finally, the task will retry at
/// intervals of [max_backoff][google.cloud.tasks.v2.RetryConfig.max_backoff]
/// until the task has been attempted
/// [max_attempts][google.cloud.tasks.v2.RetryConfig.max_attempts] times. Thus,
/// the requests will retry at 10s, 20s, 40s, 80s, 160s, 240s, 300s, 300s, ....
///
/// If unspecified when the queue is created, Cloud Tasks will pick the
/// default.
///
///
/// This field has the same meaning as
/// [max_doublings in
/// queue.yaml/xml](<https://cloud.google.com/appengine/docs/standard/python/config/queueref#retry_parameters>).
#[prost(int32, tag = "5")]
pub max_doublings: i32,
}
/// Configuration options for writing logs to
/// [Stackdriver Logging](<https://cloud.google.com/logging/docs/>).
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct StackdriverLoggingConfig {
/// Specifies the fraction of operations to write to
/// [Stackdriver Logging](<https://cloud.google.com/logging/docs/>).
/// This field may contain any value between 0.0 and 1.0, inclusive.
/// 0.0 is the default and means that no operations are logged.
#[prost(double, tag = "1")]
pub sampling_ratio: f64,
}
/// A unit of scheduled work.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Task {
/// Optionally caller-specified in
/// [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
///
/// The task name.
///
/// The task name must have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
///
/// * `PROJECT_ID` can contain letters (\[A-Za-z\]), numbers (\[0-9\]),
/// hyphens (-), colons (:), or periods (.).
/// For more information, see
/// [Identifying
/// projects](<https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects>)
/// * `LOCATION_ID` is the canonical ID for the task's location.
/// The list of available locations can be obtained by calling
/// [ListLocations][google.cloud.location.Locations.ListLocations].
/// For more information, see <https://cloud.google.com/about/locations/.>
/// * `QUEUE_ID` can contain letters (\[A-Za-z\]), numbers (\[0-9\]), or
/// hyphens (-). The maximum length is 100 characters.
/// * `TASK_ID` can contain only letters (\[A-Za-z\]), numbers (\[0-9\]),
/// hyphens (-), or underscores (_). The maximum length is 500 characters.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The time when the task is scheduled to be attempted or retried.
///
/// `schedule_time` will be truncated to the nearest microsecond.
#[prost(message, optional, tag = "4")]
pub schedule_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time that the task was created.
///
/// `create_time` will be truncated to the nearest second.
#[prost(message, optional, tag = "5")]
pub create_time: ::core::option::Option<::prost_types::Timestamp>,
/// The deadline for requests sent to the worker. If the worker does not
/// respond by this deadline then the request is cancelled and the attempt
/// is marked as a `DEADLINE_EXCEEDED` failure. Cloud Tasks will retry the
/// task according to the [RetryConfig][google.cloud.tasks.v2.RetryConfig].
///
/// Note that when the request is cancelled, Cloud Tasks will stop listening
/// for the response, but whether the worker stops processing depends on the
/// worker. For example, if the worker is stuck, it may not react to cancelled
/// requests.
///
/// The default and maximum values depend on the type of request:
///
/// * For [HTTP tasks][google.cloud.tasks.v2.HttpRequest], the default is 10
/// minutes. The deadline
/// must be in the interval \[15 seconds, 30 minutes\].
///
/// * For [App Engine tasks][google.cloud.tasks.v2.AppEngineHttpRequest], 0
/// indicates that the
/// request has the default deadline. The default deadline depends on the
/// [scaling
/// type](<https://cloud.google.com/appengine/docs/standard/go/how-instances-are-managed#instance_scaling>)
/// of the service: 10 minutes for standard apps with automatic scaling, 24
/// hours for standard apps with manual and basic scaling, and 60 minutes for
/// flex apps. If the request deadline is set, it must be in the interval [15
/// seconds, 24 hours 15 seconds]. Regardless of the task's
/// `dispatch_deadline`, the app handler will not run for longer than than
/// the service's timeout. We recommend setting the `dispatch_deadline` to
/// at most a few seconds more than the app handler's timeout. For more
/// information see
/// [Timeouts](<https://cloud.google.com/tasks/docs/creating-appengine-handlers#timeouts>).
///
/// `dispatch_deadline` will be truncated to the nearest millisecond. The
/// deadline is an approximate deadline.
#[prost(message, optional, tag = "6")]
pub dispatch_deadline: ::core::option::Option<::prost_types::Duration>,
/// Output only. The number of attempts dispatched.
///
/// This count includes attempts which have been dispatched but haven't
/// received a response.
#[prost(int32, tag = "7")]
pub dispatch_count: i32,
/// Output only. The number of attempts which have received a response.
#[prost(int32, tag = "8")]
pub response_count: i32,
/// Output only. The status of the task's first attempt.
///
/// Only [dispatch_time][google.cloud.tasks.v2.Attempt.dispatch_time] will be
/// set. The other [Attempt][google.cloud.tasks.v2.Attempt] information is not
/// retained by Cloud Tasks.
#[prost(message, optional, tag = "9")]
pub first_attempt: ::core::option::Option<Attempt>,
/// Output only. The status of the task's last attempt.
#[prost(message, optional, tag = "10")]
pub last_attempt: ::core::option::Option<Attempt>,
/// Output only. The view specifies which subset of the
/// [Task][google.cloud.tasks.v2.Task] has been returned.
#[prost(enumeration = "task::View", tag = "11")]
pub view: i32,
/// Required. The message to send to the worker.
#[prost(oneof = "task::MessageType", tags = "2, 3")]
pub message_type: ::core::option::Option<task::MessageType>,
}
/// Nested message and enum types in `Task`.
pub mod task {
/// The view specifies a subset of [Task][google.cloud.tasks.v2.Task] data.
///
/// When a task is returned in a response, not all
/// information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum View {
/// Unspecified. Defaults to BASIC.
Unspecified = 0,
/// The basic view omits fields which can be large or can contain
/// sensitive data.
///
/// This view does not include the
/// [body in
/// AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest.body].
/// Bodies are desirable to return only when needed, because they
/// can be large and because of the sensitivity of the data that you
/// choose to store in it.
Basic = 1,
/// All information is returned.
///
/// Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
/// `cloudtasks.tasks.fullView` [Google IAM](<https://cloud.google.com/iam/>)
/// permission on the [Queue][google.cloud.tasks.v2.Queue] resource.
Full = 2,
}
impl View {
/// 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 {
View::Unspecified => "VIEW_UNSPECIFIED",
View::Basic => "BASIC",
View::Full => "FULL",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"VIEW_UNSPECIFIED" => Some(Self::Unspecified),
"BASIC" => Some(Self::Basic),
"FULL" => Some(Self::Full),
_ => None,
}
}
}
/// Required. The message to send to the worker.
#[derive(Clone, PartialEq, ::prost::Oneof)]
pub enum MessageType {
/// HTTP request that is sent to the App Engine app handler.
///
/// An App Engine task is a task that has
/// [AppEngineHttpRequest][google.cloud.tasks.v2.AppEngineHttpRequest] set.
#[prost(message, tag = "2")]
AppEngineHttpRequest(super::AppEngineHttpRequest),
/// HTTP request that is sent to the worker.
///
/// An HTTP task is a task that has
/// [HttpRequest][google.cloud.tasks.v2.HttpRequest] set.
#[prost(message, tag = "3")]
HttpRequest(super::HttpRequest),
}
}
/// The status of a task attempt.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Attempt {
/// Output only. The time that this attempt was scheduled.
///
/// `schedule_time` will be truncated to the nearest microsecond.
#[prost(message, optional, tag = "1")]
pub schedule_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time that this attempt was dispatched.
///
/// `dispatch_time` will be truncated to the nearest microsecond.
#[prost(message, optional, tag = "2")]
pub dispatch_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The time that this attempt response was received.
///
/// `response_time` will be truncated to the nearest microsecond.
#[prost(message, optional, tag = "3")]
pub response_time: ::core::option::Option<::prost_types::Timestamp>,
/// Output only. The response from the worker for this attempt.
///
/// If `response_time` is unset, then the task has not been attempted or is
/// currently running and the `response_status` field is meaningless.
#[prost(message, optional, tag = "4")]
pub response_status: ::core::option::Option<super::super::super::rpc::Status>,
}
/// Request message for
/// [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListQueuesRequest {
/// Required. The location name.
/// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// `filter` can be used to specify a subset of queues. Any
/// [Queue][google.cloud.tasks.v2.Queue] field can be used as a filter and
/// several operators as supported. For example: `<=, <, >=, >, !=, =, :`. The
/// filter syntax is the same as described in [Stackdriver's Advanced Logs
/// Filters](<https://cloud.google.com/logging/docs/view/advanced_filters>).
///
/// Sample filter "state: PAUSED".
///
/// Note that using filters might cause fewer queues than the
/// requested page_size to be returned.
#[prost(string, tag = "2")]
pub filter: ::prost::alloc::string::String,
/// Requested page size.
///
/// The maximum page size is 9800. If unspecified, the page size will
/// be the maximum. Fewer queues than requested might be returned,
/// even if more queues exist; use the
/// [next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token]
/// in the response to determine if more queues exist.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A token identifying the page of results to return.
///
/// To request the first page results, page_token must be empty. To
/// request the next page of results, page_token must be the value of
/// [next_page_token][google.cloud.tasks.v2.ListQueuesResponse.next_page_token]
/// returned from the previous call to
/// [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] method. It is an
/// error to switch the value of the
/// [filter][google.cloud.tasks.v2.ListQueuesRequest.filter] while iterating
/// through pages.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for
/// [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListQueuesResponse {
/// The list of queues.
#[prost(message, repeated, tag = "1")]
pub queues: ::prost::alloc::vec::Vec<Queue>,
/// A token to retrieve next page of results.
///
/// To return the next page of results, call
/// [ListQueues][google.cloud.tasks.v2.CloudTasks.ListQueues] with this value
/// as the [page_token][google.cloud.tasks.v2.ListQueuesRequest.page_token].
///
/// If the next_page_token is empty, there are no more results.
///
/// The page token is valid for only 2 hours.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for [GetQueue][google.cloud.tasks.v2.CloudTasks.GetQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetQueueRequest {
/// Required. The resource name of the queue. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [CreateQueue][google.cloud.tasks.v2.CloudTasks.CreateQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateQueueRequest {
/// Required. The location name in which the queue will be created.
/// For example: `projects/PROJECT_ID/locations/LOCATION_ID`
///
/// The list of allowed locations can be obtained by calling Cloud
/// Tasks' implementation of
/// [ListLocations][google.cloud.location.Locations.ListLocations].
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The queue to create.
///
/// [Queue's name][google.cloud.tasks.v2.Queue.name] cannot be the same as an
/// existing queue.
#[prost(message, optional, tag = "2")]
pub queue: ::core::option::Option<Queue>,
}
/// Request message for
/// [UpdateQueue][google.cloud.tasks.v2.CloudTasks.UpdateQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateQueueRequest {
/// Required. The queue to create or update.
///
/// The queue's [name][google.cloud.tasks.v2.Queue.name] must be specified.
///
/// Output only fields cannot be modified using UpdateQueue.
/// Any value specified for an output only field will be ignored.
/// The queue's [name][google.cloud.tasks.v2.Queue.name] cannot be changed.
#[prost(message, optional, tag = "1")]
pub queue: ::core::option::Option<Queue>,
/// A mask used to specify which fields of the queue are being updated.
///
/// If empty, then all fields will be updated.
#[prost(message, optional, tag = "2")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// Request message for
/// [DeleteQueue][google.cloud.tasks.v2.CloudTasks.DeleteQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteQueueRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PurgeQueue][google.cloud.tasks.v2.CloudTasks.PurgeQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PurgeQueueRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [PauseQueue][google.cloud.tasks.v2.CloudTasks.PauseQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct PauseQueueRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for
/// [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ResumeQueueRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for listing tasks using
/// [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTasksRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// The response_view specifies which subset of the
/// [Task][google.cloud.tasks.v2.Task] will be returned.
///
/// By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
/// not all information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
/// `cloudtasks.tasks.fullView` [Google IAM](<https://cloud.google.com/iam/>)
/// permission on the [Task][google.cloud.tasks.v2.Task] resource.
#[prost(enumeration = "task::View", tag = "2")]
pub response_view: i32,
/// Maximum page size.
///
/// Fewer tasks than requested might be returned, even if more tasks exist; use
/// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token]
/// in the response to determine if more tasks exist.
///
/// The maximum page size is 1000. If unspecified, the page size will be the
/// maximum.
#[prost(int32, tag = "3")]
pub page_size: i32,
/// A token identifying the page of results to return.
///
/// To request the first page results, page_token must be empty. To
/// request the next page of results, page_token must be the value of
/// [next_page_token][google.cloud.tasks.v2.ListTasksResponse.next_page_token]
/// returned from the previous call to
/// [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] method.
///
/// The page token is valid for only 2 hours.
#[prost(string, tag = "4")]
pub page_token: ::prost::alloc::string::String,
}
/// Response message for listing tasks using
/// [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct ListTasksResponse {
/// The list of tasks.
#[prost(message, repeated, tag = "1")]
pub tasks: ::prost::alloc::vec::Vec<Task>,
/// A token to retrieve next page of results.
///
/// To return the next page of results, call
/// [ListTasks][google.cloud.tasks.v2.CloudTasks.ListTasks] with this value as
/// the [page_token][google.cloud.tasks.v2.ListTasksRequest.page_token].
///
/// If the next_page_token is empty, there are no more results.
#[prost(string, tag = "2")]
pub next_page_token: ::prost::alloc::string::String,
}
/// Request message for getting a task using
/// [GetTask][google.cloud.tasks.v2.CloudTasks.GetTask].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct GetTaskRequest {
/// Required. The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The response_view specifies which subset of the
/// [Task][google.cloud.tasks.v2.Task] will be returned.
///
/// By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
/// not all information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
/// `cloudtasks.tasks.fullView` [Google IAM](<https://cloud.google.com/iam/>)
/// permission on the [Task][google.cloud.tasks.v2.Task] resource.
#[prost(enumeration = "task::View", tag = "2")]
pub response_view: i32,
}
/// Request message for
/// [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateTaskRequest {
/// Required. The queue name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`
///
/// The queue must already exist.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The task to add.
///
/// Task names have the following format:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.
/// The user can optionally specify a task
/// [name][google.cloud.tasks.v2.Task.name]. If a name is not specified then
/// the system will generate a random unique task id, which will be set in the
/// task returned in the [response][google.cloud.tasks.v2.Task.name].
///
/// If [schedule_time][google.cloud.tasks.v2.Task.schedule_time] is not set or
/// is in the past then Cloud Tasks will set it to the current time.
///
/// Task De-duplication:
///
/// Explicitly specifying a task ID enables task de-duplication. If
/// a task's ID is identical to that of an existing task or a task
/// that was deleted or executed recently then the call will fail
/// with [ALREADY_EXISTS][google.rpc.Code.ALREADY_EXISTS].
/// If the task's queue was created using Cloud Tasks, then another task with
/// the same name can't be created for ~1hour after the original task was
/// deleted or executed. If the task's queue was created using queue.yaml or
/// queue.xml, then another task with the same name can't be created
/// for ~9days after the original task was deleted or executed.
///
/// Because there is an extra lookup cost to identify duplicate task
/// names, these [CreateTask][google.cloud.tasks.v2.CloudTasks.CreateTask]
/// calls have significantly increased latency. Using hashed strings for the
/// task id or for the prefix of the task id is recommended. Choosing task ids
/// that are sequential or have sequential prefixes, for example using a
/// timestamp, causes an increase in latency and error rates in all
/// task commands. The infrastructure relies on an approximately
/// uniform distribution of task ids to store and serve tasks
/// efficiently.
#[prost(message, optional, tag = "2")]
pub task: ::core::option::Option<Task>,
/// The response_view specifies which subset of the
/// [Task][google.cloud.tasks.v2.Task] will be returned.
///
/// By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
/// not all information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
/// `cloudtasks.tasks.fullView` [Google IAM](<https://cloud.google.com/iam/>)
/// permission on the [Task][google.cloud.tasks.v2.Task] resource.
#[prost(enumeration = "task::View", tag = "3")]
pub response_view: i32,
}
/// Request message for deleting a task using
/// [DeleteTask][google.cloud.tasks.v2.CloudTasks.DeleteTask].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DeleteTaskRequest {
/// Required. The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
}
/// Request message for forcing a task to run now using
/// [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask].
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct RunTaskRequest {
/// Required. The task name. For example:
/// `projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The response_view specifies which subset of the
/// [Task][google.cloud.tasks.v2.Task] will be returned.
///
/// By default response_view is [BASIC][google.cloud.tasks.v2.Task.View.BASIC];
/// not all information is retrieved by default because some data, such as
/// payloads, might be desirable to return only when needed because
/// of its large size or because of the sensitivity of data that it
/// contains.
///
/// Authorization for [FULL][google.cloud.tasks.v2.Task.View.FULL] requires
/// `cloudtasks.tasks.fullView` [Google IAM](<https://cloud.google.com/iam/>)
/// permission on the [Task][google.cloud.tasks.v2.Task] resource.
#[prost(enumeration = "task::View", tag = "2")]
pub response_view: i32,
}
/// Generated client implementations.
pub mod cloud_tasks_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Cloud Tasks allows developers to manage the execution of background
/// work in their applications.
#[derive(Debug, Clone)]
pub struct CloudTasksClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> CloudTasksClient<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,
) -> CloudTasksClient<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,
{
CloudTasksClient::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
}
/// Lists queues.
///
/// Queues are returned in lexicographical order.
pub async fn list_queues(
&mut self,
request: impl tonic::IntoRequest<super::ListQueuesRequest>,
) -> std::result::Result<
tonic::Response<super::ListQueuesResponse>,
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.tasks.v2.CloudTasks/ListQueues",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "ListQueues"),
);
self.inner.unary(req, path, codec).await
}
/// Gets a queue.
pub async fn get_queue(
&mut self,
request: impl tonic::IntoRequest<super::GetQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/GetQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "GetQueue"));
self.inner.unary(req, path, codec).await
}
/// Creates a queue.
///
/// Queues created with this method allow tasks to live for a maximum of 31
/// days. After a task is 31 days old, the task will be deleted regardless of
/// whether it was dispatched or not.
///
/// WARNING: Using this method may have unintended side effects if you are
/// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
/// Read
/// [Overview of Queue Management and
/// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
/// this method.
pub async fn create_queue(
&mut self,
request: impl tonic::IntoRequest<super::CreateQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/CreateQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "CreateQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Updates a queue.
///
/// This method creates the queue if it does not exist and updates
/// the queue if it does exist.
///
/// Queues created with this method allow tasks to live for a maximum of 31
/// days. After a task is 31 days old, the task will be deleted regardless of
/// whether it was dispatched or not.
///
/// WARNING: Using this method may have unintended side effects if you are
/// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
/// Read
/// [Overview of Queue Management and
/// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
/// this method.
pub async fn update_queue(
&mut self,
request: impl tonic::IntoRequest<super::UpdateQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/UpdateQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "UpdateQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a queue.
///
/// This command will delete the queue even if it has tasks in it.
///
/// Note: If you delete a queue, a queue with the same name can't be created
/// for 7 days.
///
/// WARNING: Using this method may have unintended side effects if you are
/// using an App Engine `queue.yaml` or `queue.xml` file to manage your queues.
/// Read
/// [Overview of Queue Management and
/// queue.yaml](https://cloud.google.com/tasks/docs/queue-yaml) before using
/// this method.
pub async fn delete_queue(
&mut self,
request: impl tonic::IntoRequest<super::DeleteQueueRequest>,
) -> 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.tasks.v2.CloudTasks/DeleteQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "DeleteQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Purges a queue by deleting all of its tasks.
///
/// All tasks created before this method is called are permanently deleted.
///
/// Purge operations can take up to one minute to take effect. Tasks
/// might be dispatched before the purge takes effect. A purge is irreversible.
pub async fn purge_queue(
&mut self,
request: impl tonic::IntoRequest<super::PurgeQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/PurgeQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "PurgeQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Pauses the queue.
///
/// If a queue is paused then the system will stop dispatching tasks
/// until the queue is resumed via
/// [ResumeQueue][google.cloud.tasks.v2.CloudTasks.ResumeQueue]. Tasks can
/// still be added when the queue is paused. A queue is paused if its
/// [state][google.cloud.tasks.v2.Queue.state] is
/// [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
pub async fn pause_queue(
&mut self,
request: impl tonic::IntoRequest<super::PauseQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/PauseQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "PauseQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Resume a queue.
///
/// This method resumes a queue after it has been
/// [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED] or
/// [DISABLED][google.cloud.tasks.v2.Queue.State.DISABLED]. The state of a
/// queue is stored in the queue's [state][google.cloud.tasks.v2.Queue.state];
/// after calling this method it will be set to
/// [RUNNING][google.cloud.tasks.v2.Queue.State.RUNNING].
///
/// WARNING: Resuming many high-QPS queues at the same time can
/// lead to target overloading. If you are resuming high-QPS
/// queues, follow the 500/50/5 pattern described in
/// [Managing Cloud Tasks Scaling
/// Risks](https://cloud.google.com/tasks/docs/manage-cloud-task-scaling).
pub async fn resume_queue(
&mut self,
request: impl tonic::IntoRequest<super::ResumeQueueRequest>,
) -> std::result::Result<tonic::Response<super::Queue>, 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.tasks.v2.CloudTasks/ResumeQueue",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "ResumeQueue"),
);
self.inner.unary(req, path, codec).await
}
/// Gets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
/// Returns an empty policy if the resource exists and does not have a policy
/// set.
///
/// Authorization requires the following
/// [Google IAM](https://cloud.google.com/iam) permission on the specified
/// resource parent:
///
/// * `cloudtasks.queues.getIamPolicy`
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.tasks.v2.CloudTasks/GetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "GetIamPolicy"),
);
self.inner.unary(req, path, codec).await
}
/// Sets the access control policy for a [Queue][google.cloud.tasks.v2.Queue].
/// Replaces any existing policy.
///
/// Note: The Cloud Console does not check queue-level IAM permissions yet.
/// Project-level permissions are required to use the Cloud Console.
///
/// Authorization requires the following
/// [Google IAM](https://cloud.google.com/iam) permission on the specified
/// resource parent:
///
/// * `cloudtasks.queues.setIamPolicy`
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.tasks.v2.CloudTasks/SetIamPolicy",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "SetIamPolicy"),
);
self.inner.unary(req, path, codec).await
}
/// Returns permissions that a caller has on a
/// [Queue][google.cloud.tasks.v2.Queue]. If the resource does not exist, this
/// will return an empty set of permissions, not a
/// [NOT_FOUND][google.rpc.Code.NOT_FOUND] error.
///
/// Note: This operation is designed to be used for building permission-aware
/// UIs and command-line tools, not for authorization checking. This operation
/// may "fail open" without warning.
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.tasks.v2.CloudTasks/TestIamPermissions",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.cloud.tasks.v2.CloudTasks",
"TestIamPermissions",
),
);
self.inner.unary(req, path, codec).await
}
/// Lists the tasks in a queue.
///
/// By default, only the [BASIC][google.cloud.tasks.v2.Task.View.BASIC] view is
/// retrieved due to performance considerations;
/// [response_view][google.cloud.tasks.v2.ListTasksRequest.response_view]
/// controls the subset of information which is returned.
///
/// The tasks may be returned in any order. The ordering may change at any
/// time.
pub async fn list_tasks(
&mut self,
request: impl tonic::IntoRequest<super::ListTasksRequest>,
) -> std::result::Result<
tonic::Response<super::ListTasksResponse>,
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.tasks.v2.CloudTasks/ListTasks",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "ListTasks"),
);
self.inner.unary(req, path, codec).await
}
/// Gets a task.
pub async fn get_task(
&mut self,
request: impl tonic::IntoRequest<super::GetTaskRequest>,
) -> std::result::Result<tonic::Response<super::Task>, 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.tasks.v2.CloudTasks/GetTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "GetTask"));
self.inner.unary(req, path, codec).await
}
/// Creates a task and adds it to a queue.
///
/// Tasks cannot be updated after creation; there is no UpdateTask command.
///
/// * The maximum task size is 100KB.
pub async fn create_task(
&mut self,
request: impl tonic::IntoRequest<super::CreateTaskRequest>,
) -> std::result::Result<tonic::Response<super::Task>, 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.tasks.v2.CloudTasks/CreateTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "CreateTask"),
);
self.inner.unary(req, path, codec).await
}
/// Deletes a task.
///
/// A task can be deleted if it is scheduled or dispatched. A task
/// cannot be deleted if it has executed successfully or permanently
/// failed.
pub async fn delete_task(
&mut self,
request: impl tonic::IntoRequest<super::DeleteTaskRequest>,
) -> 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.tasks.v2.CloudTasks/DeleteTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "DeleteTask"),
);
self.inner.unary(req, path, codec).await
}
/// Forces a task to run now.
///
/// When this method is called, Cloud Tasks will dispatch the task, even if
/// the task is already running, the queue has reached its
/// [RateLimits][google.cloud.tasks.v2.RateLimits] or is
/// [PAUSED][google.cloud.tasks.v2.Queue.State.PAUSED].
///
/// This command is meant to be used for manual debugging. For
/// example, [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] can be used to
/// retry a failed task after a fix has been made or to manually force a task
/// to be dispatched now.
///
/// The dispatched task is returned. That is, the task that is returned
/// contains the [status][Task.status] after the task is dispatched but
/// before the task is received by its target.
///
/// If Cloud Tasks receives a successful response from the task's
/// target, then the task will be deleted; otherwise the task's
/// [schedule_time][google.cloud.tasks.v2.Task.schedule_time] will be reset to
/// the time that [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] was
/// called plus the retry delay specified in the queue's
/// [RetryConfig][google.cloud.tasks.v2.RetryConfig].
///
/// [RunTask][google.cloud.tasks.v2.CloudTasks.RunTask] returns
/// [NOT_FOUND][google.rpc.Code.NOT_FOUND] when it is called on a
/// task that has already succeeded or permanently failed.
pub async fn run_task(
&mut self,
request: impl tonic::IntoRequest<super::RunTaskRequest>,
) -> std::result::Result<tonic::Response<super::Task>, 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.tasks.v2.CloudTasks/RunTask",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(GrpcMethod::new("google.cloud.tasks.v2.CloudTasks", "RunTask"));
self.inner.unary(req, path, codec).await
}
}
}