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 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089
|
# Copyright 2015 Google Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
require 'google/apis/core/base_service'
require 'google/apis/core/json_representation'
require 'google/apis/core/hashable'
require 'google/apis/errors'
module Google
module Apis
module DataflowV1b3
# Dataflow API
#
# Manages Google Cloud Dataflow projects on Google Cloud Platform.
#
# @example
# require 'google/apis/dataflow_v1b3'
#
# Dataflow = Google::Apis::DataflowV1b3 # Alias the module
# service = Dataflow::DataflowService.new
#
# @see https://cloud.google.com/dataflow
class DataflowService < Google::Apis::Core::BaseService
# @return [String]
# API key. Your API key identifies your project and provides you with API access,
# quota, and reports. Required unless you provide an OAuth 2.0 token.
attr_accessor :key
# @return [String]
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
attr_accessor :quota_user
def initialize
super('https://dataflow.googleapis.com/', '')
@batch_path = 'batch'
end
# Deletes a snapshot.
# @param [String] project_id
# The ID of the Cloud Platform project that the snapshot belongs to.
# @param [String] location
# The location that contains this snapshot.
# @param [String] snapshot_id
# The ID of the snapshot.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_snapshots(project_id, location: nil, snapshot_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1b3/projects/{projectId}/snapshots', options)
command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['location'] = location unless location.nil?
command.query['snapshotId'] = snapshot_id unless snapshot_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Send a worker_message to the service.
# @param [String] project_id
# The project to send the WorkerMessages to.
# @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def worker_project_messages(project_id, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/WorkerMessages', options)
command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
command.request_object = send_worker_messages_request_object
command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new TemplateVersion (Important: not new Template) entry in the
# spanner table. Requires project_id and display_name (template).
# @param [String] name
# The location of the template, name includes project_id and display_name.
# Commit using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
# catalogTemplates/`tid1`
# @param [Google::Apis::DataflowV1b3::CommitTemplateVersionRequest] commit_template_version_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def commit_catalog_template_template_version(name, commit_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/{+name}:commit', options)
command.request_representation = Google::Apis::DataflowV1b3::CommitTemplateVersionRequest::Representation
command.request_object = commit_template_version_request_object
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes an existing Template. Do nothing if Template does not exist.
# @param [String] name
# name includes project_id and display_name. Delete by project_id(pid1) and
# display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Empty] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Empty]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1b3/{+name}', options)
command.response_representation = Google::Apis::DataflowV1b3::Empty::Representation
command.response_class = Google::Apis::DataflowV1b3::Empty
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get TemplateVersion using project_id and display_name with an optional
# version_id field. Get latest (has tag "latest") TemplateVersion if version_id
# not set.
# @param [String] name
# Resource name includes project_id and display_name. version_id is optional.
# Get the latest TemplateVersion if version_id not set. Get by project_id(pid1)
# and display_name(tid1): Format: projects/`pid1`/catalogTemplates/`tid1` Get by
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
# pid1`/catalogTemplates/`tid1@vid`
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_catalog_template(name, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/{+name}', options)
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the label of the TemplateVersion. Label can be duplicated in Template,
# so either add or remove the label in the TemplateVersion.
# @param [String] name
# Resource name includes project_id, display_name, and version_id. Updates by
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
# pid1`/catalogTemplates/`tid1@vid`
# @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest] modify_template_version_label_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def label_project_catalog_template(name, modify_template_version_label_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/{+name}:label', options)
command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelRequest::Representation
command.request_object = modify_template_version_label_request_object
command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionLabelResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the tag of the TemplateVersion, and tag is unique in Template. If tag
# exists in another TemplateVersion in the Template, updates the tag to this
# TemplateVersion will remove it from the old TemplateVersion and add it to this
# TemplateVersion. If request is remove_only (remove_only = true), remove the
# tag from this TemplateVersion.
# @param [String] name
# Resource name includes project_id, display_name, and version_id. Updates by
# project_id(pid1), display_name(tid1), and version_id(vid1): Format: projects/`
# pid1`/catalogTemplates/`tid1@vid`
# @param [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest] modify_template_version_tag_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def tag_project_catalog_template(name, modify_template_version_tag_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/{+name}:tag', options)
command.request_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagRequest::Representation
command.request_object = modify_template_version_tag_request_object
command.response_representation = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ModifyTemplateVersionTagResponse
command.params['name'] = name unless name.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a new Template with TemplateVersion. Requires project_id(projects) and
# template display_name(catalogTemplates). The template display_name is set by
# the user.
# @param [String] parent
# The parent project and template that the TemplateVersion will be created under.
# Create using project_id(pid1) and display_name(tid1). Format: projects/`pid1`/
# catalogTemplates/`tid1`
# @param [Google::Apis::DataflowV1b3::CreateTemplateVersionRequest] create_template_version_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::TemplateVersion] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::TemplateVersion]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_template_version(parent, create_template_version_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/{+parent}/templateVersions', options)
command.request_representation = Google::Apis::DataflowV1b3::CreateTemplateVersionRequest::Representation
command.request_object = create_template_version_request_object
command.response_representation = Google::Apis::DataflowV1b3::TemplateVersion::Representation
command.response_class = Google::Apis::DataflowV1b3::TemplateVersion
command.params['parent'] = parent unless parent.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List the jobs of a project across all regions.
# @param [String] project_id
# The project which owns the jobs.
# @param [String] filter
# The kind of filter to use.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [Fixnum] page_size
# If there are many jobs, limit response to at most this many. The actual number
# of jobs returned will be the lesser of max_responses and an unspecified server-
# defined limit.
# @param [String] page_token
# Set this to the 'next_page_token' field of a previous response to request
# additional results in a long list.
# @param [String] view
# Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def aggregated_project_job(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs:aggregated', options)
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['filter'] = filter unless filter.nil?
command.query['location'] = location unless location.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
# locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
# dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
# not recommended, as your job will always start in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [Google::Apis::DataflowV1b3::Job] job_object
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] replace_job_id
# Deprecated. This field is now in the Job message.
# @param [String] view
# The level of information requested in response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_job(project_id, job_object = nil, location: nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs', options)
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
command.request_object = job_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.query['location'] = location unless location.nil?
command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the state of the specified Cloud Dataflow job. To get the state of a job,
# we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
# projects.jobs.get` is not recommended, as you can only get the state of jobs
# that are running in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] job_id
# The job ID.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] view
# The level of information requested in response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_job(project_id, job_id, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['location'] = location unless location.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request the job status. To request the status of a job, we recommend using `
# projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
# google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
# getMetrics` is not recommended, as you can only request the status of jobs
# that are running in `us-central1`.
# @param [String] project_id
# A project id.
# @param [String] job_id
# The job to get metrics for.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] start_time
# Return only metric data that has changed since this time. Default is to return
# all information about all metrics for the job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::JobMetrics]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_job_metrics(project_id, job_id, location: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/metrics', options)
command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
command.response_class = Google::Apis::DataflowV1b3::JobMetrics
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['location'] = location unless location.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List the jobs of a project. To list the jobs of a project in a region, we
# recommend using `projects.locations.jobs.list` with a [regional endpoint] (
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
# the all jobs across all regions, use `projects.jobs.aggregated`. Using `
# projects.jobs.list` is not recommended, as you can only get the list of jobs
# that are running in `us-central1`.
# @param [String] project_id
# The project which owns the jobs.
# @param [String] filter
# The kind of filter to use.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [Fixnum] page_size
# If there are many jobs, limit response to at most this many. The actual number
# of jobs returned will be the lesser of max_responses and an unspecified server-
# defined limit.
# @param [String] page_token
# Set this to the 'next_page_token' field of a previous response to request
# additional results in a long list.
# @param [String] view
# Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_jobs(project_id, filter: nil, location: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs', options)
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['filter'] = filter unless filter.nil?
command.query['location'] = location unless location.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Snapshot the state of a streaming job.
# @param [String] project_id
# The project which owns the job to be snapshotted.
# @param [String] job_id
# The job to be snapshotted.
# @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Snapshot]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def snapshot_project_job(project_id, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}:snapshot', options)
command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
command.request_object = snapshot_job_request_object
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
command.response_class = Google::Apis::DataflowV1b3::Snapshot
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the state of an existing Cloud Dataflow job. To update the state of an
# existing job, we recommend using `projects.locations.jobs.update` with a [
# regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
# endpoints). Using `projects.jobs.update` is not recommended, as you can only
# update the state of jobs that are running in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] job_id
# The job ID.
# @param [Google::Apis::DataflowV1b3::Job] job_object
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_job(project_id, job_id, job_object = nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1b3/projects/{projectId}/jobs/{jobId}', options)
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
command.request_object = job_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get encoded debug configuration for component. Not cacheable.
# @param [String] project_id
# The project id.
# @param [String] job_id
# The job id.
# @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_job_debug_config(project_id, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig', options)
command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
command.request_object = get_debug_config_request_object
command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Send encoded debug capture data for component.
# @param [String] project_id
# The project id.
# @param [String] job_id
# The job id.
# @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def send_project_job_debug_capture(project_id, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture', options)
command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
command.request_object = send_debug_capture_request_object
command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request the job status. To request the status of a job, we recommend using `
# projects.locations.jobs.messages.list` with a [regional endpoint] (https://
# cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
# jobs.messages.list` is not recommended, as you can only request the status of
# jobs that are running in `us-central1`.
# @param [String] project_id
# A project id.
# @param [String] job_id
# The job to get messages about.
# @param [String] end_time
# Return only messages with timestamps < end_time. The default is now (i.e.
# return up to the latest messages available).
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] minimum_importance
# Filter to only get messages with importance >= level
# @param [Fixnum] page_size
# If specified, determines the maximum number of messages to return. If
# unspecified, the service may choose an appropriate default, or may return an
# arbitrarily large number of results.
# @param [String] page_token
# If supplied, this should be the value of next_page_token returned by an
# earlier call. This will cause the next page of results to be returned.
# @param [String] start_time
# If specified, return only messages with timestamps >= start_time. The default
# is the job creation time (i.e. beginning of messages).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_job_messages(project_id, job_id, end_time: nil, location: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/jobs/{jobId}/messages', options)
command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['endTime'] = end_time unless end_time.nil?
command.query['location'] = location unless location.nil?
command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Leases a dataflow WorkItem to run.
# @param [String] project_id
# Identifies the project this worker belongs to.
# @param [String] job_id
# Identifies the workflow job this worker belongs to.
# @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def lease_project_work_item(project_id, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease', options)
command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
command.request_object = lease_work_item_request_object
command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reports the status of dataflow WorkItems leased by a worker.
# @param [String] project_id
# The project which owns the WorkItem's job.
# @param [String] job_id
# The job which the WorkItem is part of.
# @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def report_project_job_work_item_status(project_id, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus', options)
command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
command.request_object = report_work_item_status_request_object
command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Send a worker_message to the service.
# @param [String] project_id
# The project to send the WorkerMessages to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job.
# @param [Google::Apis::DataflowV1b3::SendWorkerMessagesRequest] send_worker_messages_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::SendWorkerMessagesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def worker_project_location_messages(project_id, location, send_worker_messages_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/WorkerMessages', options)
command.request_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesRequest::Representation
command.request_object = send_worker_messages_request_object
command.response_representation = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::SendWorkerMessagesResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Launch a job with a FlexTemplate.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# Required. The [regional endpoint] (https://cloud.google.com/dataflow/docs/
# concepts/regional-endpoints) to which to direct the request. E.g., us-central1,
# us-west1.
# @param [Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest] launch_flex_template_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def launch_flex_template(project_id, location, launch_flex_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/flexTemplates:launch', options)
command.request_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateRequest::Representation
command.request_object = launch_flex_template_request_object
command.response_representation = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::LaunchFlexTemplateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Cloud Dataflow job. To create a job, we recommend using `projects.
# locations.jobs.create` with a [regional endpoint] (https://cloud.google.com/
# dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.create` is
# not recommended, as your job will always start in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [Google::Apis::DataflowV1b3::Job] job_object
# @param [String] replace_job_id
# Deprecated. This field is now in the Job message.
# @param [String] view
# The level of information requested in response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_project_location_job(project_id, location, job_object = nil, replace_job_id: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
command.request_object = job_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['replaceJobId'] = replace_job_id unless replace_job_id.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets the state of the specified Cloud Dataflow job. To get the state of a job,
# we recommend using `projects.locations.jobs.get` with a [regional endpoint] (
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `
# projects.jobs.get` is not recommended, as you can only get the state of jobs
# that are running in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] job_id
# The job ID.
# @param [String] view
# The level of information requested in response.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_job(project_id, location, job_id, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request detailed information about the execution status of the job.
# EXPERIMENTAL. This API is subject to change or removal without notice.
# @param [String] project_id
# A project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job to get execution details for.
# @param [Fixnum] page_size
# If specified, determines the maximum number of stages to return. If
# unspecified, the service may choose an appropriate default, or may return an
# arbitrarily large number of results.
# @param [String] page_token
# If supplied, this should be the value of next_page_token returned by an
# earlier call. This will cause the next page of results to be returned.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::JobExecutionDetails] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::JobExecutionDetails]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_job_execution_details(project_id, location, job_id, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/executionDetails', options)
command.response_representation = Google::Apis::DataflowV1b3::JobExecutionDetails::Representation
command.response_class = Google::Apis::DataflowV1b3::JobExecutionDetails
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request the job status. To request the status of a job, we recommend using `
# projects.locations.jobs.getMetrics` with a [regional endpoint] (https://cloud.
# google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.jobs.
# getMetrics` is not recommended, as you can only request the status of jobs
# that are running in `us-central1`.
# @param [String] project_id
# A project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job to get metrics for.
# @param [String] start_time
# Return only metric data that has changed since this time. Default is to return
# all information about all metrics for the job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::JobMetrics] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::JobMetrics]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_job_metrics(project_id, location, job_id, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics', options)
command.response_representation = Google::Apis::DataflowV1b3::JobMetrics::Representation
command.response_class = Google::Apis::DataflowV1b3::JobMetrics
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List the jobs of a project. To list the jobs of a project in a region, we
# recommend using `projects.locations.jobs.list` with a [regional endpoint] (
# https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). To list
# the all jobs across all regions, use `projects.jobs.aggregated`. Using `
# projects.jobs.list` is not recommended, as you can only get the list of jobs
# that are running in `us-central1`.
# @param [String] project_id
# The project which owns the jobs.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] filter
# The kind of filter to use.
# @param [Fixnum] page_size
# If there are many jobs, limit response to at most this many. The actual number
# of jobs returned will be the lesser of max_responses and an unspecified server-
# defined limit.
# @param [String] page_token
# Set this to the 'next_page_token' field of a previous response to request
# additional results in a long list.
# @param [String] view
# Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListJobsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_jobs(project_id, location, filter: nil, page_size: nil, page_token: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs', options)
command.response_representation = Google::Apis::DataflowV1b3::ListJobsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListJobsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['filter'] = filter unless filter.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Snapshot the state of a streaming job.
# @param [String] project_id
# The project which owns the job to be snapshotted.
# @param [String] location
# The location that contains this job.
# @param [String] job_id
# The job to be snapshotted.
# @param [Google::Apis::DataflowV1b3::SnapshotJobRequest] snapshot_job_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Snapshot]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def snapshot_project_location_job(project_id, location, job_id, snapshot_job_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}:snapshot', options)
command.request_representation = Google::Apis::DataflowV1b3::SnapshotJobRequest::Representation
command.request_object = snapshot_job_request_object
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
command.response_class = Google::Apis::DataflowV1b3::Snapshot
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Updates the state of an existing Cloud Dataflow job. To update the state of an
# existing job, we recommend using `projects.locations.jobs.update` with a [
# regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-
# endpoints). Using `projects.jobs.update` is not recommended, as you can only
# update the state of jobs that are running in `us-central1`.
# @param [String] project_id
# The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains this job.
# @param [String] job_id
# The job ID.
# @param [Google::Apis::DataflowV1b3::Job] job_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def update_project_location_job(project_id, location, job_id, job_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:put, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}', options)
command.request_representation = Google::Apis::DataflowV1b3::Job::Representation
command.request_object = job_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get encoded debug configuration for component. Not cacheable.
# @param [String] project_id
# The project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job id.
# @param [Google::Apis::DataflowV1b3::GetDebugConfigRequest] get_debug_config_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::GetDebugConfigResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::GetDebugConfigResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_job_debug_config(project_id, location, job_id, get_debug_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig', options)
command.request_representation = Google::Apis::DataflowV1b3::GetDebugConfigRequest::Representation
command.request_object = get_debug_config_request_object
command.response_representation = Google::Apis::DataflowV1b3::GetDebugConfigResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::GetDebugConfigResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Send encoded debug capture data for component.
# @param [String] project_id
# The project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job id.
# @param [Google::Apis::DataflowV1b3::SendDebugCaptureRequest] send_debug_capture_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::SendDebugCaptureResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::SendDebugCaptureResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def send_project_location_job_debug_capture(project_id, location, job_id, send_debug_capture_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture', options)
command.request_representation = Google::Apis::DataflowV1b3::SendDebugCaptureRequest::Representation
command.request_object = send_debug_capture_request_object
command.response_representation = Google::Apis::DataflowV1b3::SendDebugCaptureResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::SendDebugCaptureResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request the job status. To request the status of a job, we recommend using `
# projects.locations.jobs.messages.list` with a [regional endpoint] (https://
# cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using `projects.
# jobs.messages.list` is not recommended, as you can only request the status of
# jobs that are running in `us-central1`.
# @param [String] project_id
# A project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job to get messages about.
# @param [String] end_time
# Return only messages with timestamps < end_time. The default is now (i.e.
# return up to the latest messages available).
# @param [String] minimum_importance
# Filter to only get messages with importance >= level
# @param [Fixnum] page_size
# If specified, determines the maximum number of messages to return. If
# unspecified, the service may choose an appropriate default, or may return an
# arbitrarily large number of results.
# @param [String] page_token
# If supplied, this should be the value of next_page_token returned by an
# earlier call. This will cause the next page of results to be returned.
# @param [String] start_time
# If specified, return only messages with timestamps >= start_time. The default
# is the job creation time (i.e. beginning of messages).
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListJobMessagesResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListJobMessagesResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_job_messages(project_id, location, job_id, end_time: nil, minimum_importance: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages', options)
command.response_representation = Google::Apis::DataflowV1b3::ListJobMessagesResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListJobMessagesResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['endTime'] = end_time unless end_time.nil?
command.query['minimumImportance'] = minimum_importance unless minimum_importance.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists snapshots.
# @param [String] project_id
# The project ID to list snapshots for.
# @param [String] location
# The location to list snapshots in.
# @param [String] job_id
# If specified, list snapshots created from this job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_job_snapshots(project_id, location, job_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/snapshots', options)
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Request detailed information about the execution status of a stage of the job.
# EXPERIMENTAL. This API is subject to change or removal without notice.
# @param [String] project_id
# A project id.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the job specified by job_id.
# @param [String] job_id
# The job to get execution details for.
# @param [String] stage_id
# The stage for which to fetch information.
# @param [String] end_time
# Upper time bound of work items to include, by start time.
# @param [Fixnum] page_size
# If specified, determines the maximum number of work items to return. If
# unspecified, the service may choose an appropriate default, or may return an
# arbitrarily large number of results.
# @param [String] page_token
# If supplied, this should be the value of next_page_token returned by an
# earlier call. This will cause the next page of results to be returned.
# @param [String] start_time
# Lower time bound of work items to include, by start time.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::StageExecutionDetails] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::StageExecutionDetails]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_job_stage_execution_details(project_id, location, job_id, stage_id, end_time: nil, page_size: nil, page_token: nil, start_time: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/stages/{stageId}/executionDetails', options)
command.response_representation = Google::Apis::DataflowV1b3::StageExecutionDetails::Representation
command.response_class = Google::Apis::DataflowV1b3::StageExecutionDetails
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.params['stageId'] = stage_id unless stage_id.nil?
command.query['endTime'] = end_time unless end_time.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['startTime'] = start_time unless start_time.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Leases a dataflow WorkItem to run.
# @param [String] project_id
# Identifies the project this worker belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the WorkItem's job.
# @param [String] job_id
# Identifies the workflow job this worker belongs to.
# @param [Google::Apis::DataflowV1b3::LeaseWorkItemRequest] lease_work_item_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::LeaseWorkItemResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::LeaseWorkItemResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def lease_project_location_work_item(project_id, location, job_id, lease_work_item_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease', options)
command.request_representation = Google::Apis::DataflowV1b3::LeaseWorkItemRequest::Representation
command.request_object = lease_work_item_request_object
command.response_representation = Google::Apis::DataflowV1b3::LeaseWorkItemResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::LeaseWorkItemResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Reports the status of dataflow WorkItems leased by a worker.
# @param [String] project_id
# The project which owns the WorkItem's job.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) that contains the WorkItem's job.
# @param [String] job_id
# The job which the WorkItem is part of.
# @param [Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest] report_work_item_status_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def report_project_location_job_work_item_status(project_id, location, job_id, report_work_item_status_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus', options)
command.request_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusRequest::Representation
command.request_object = report_work_item_status_request_object
command.response_representation = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ReportWorkItemStatusResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Deletes a snapshot.
# @param [String] project_id
# The ID of the Cloud Platform project that the snapshot belongs to.
# @param [String] location
# The location that contains this snapshot.
# @param [String] snapshot_id
# The ID of the snapshot.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::DeleteSnapshotResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::DeleteSnapshotResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def delete_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:delete, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
command.response_representation = Google::Apis::DataflowV1b3::DeleteSnapshotResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::DeleteSnapshotResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets information about a snapshot.
# @param [String] project_id
# The ID of the Cloud Platform project that the snapshot belongs to.
# @param [String] location
# The location that contains this snapshot.
# @param [String] snapshot_id
# The ID of the snapshot.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Snapshot]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_snapshot(project_id, location, snapshot_id, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots/{snapshotId}', options)
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
command.response_class = Google::Apis::DataflowV1b3::Snapshot
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists snapshots.
# @param [String] project_id
# The project ID to list snapshots for.
# @param [String] location
# The location to list snapshots in.
# @param [String] job_id
# If specified, list snapshots created from this job.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_location_snapshots(project_id, location, job_id: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/snapshots', options)
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['jobId'] = job_id unless job_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Validates a GoogleSQL query for Cloud Dataflow syntax. Will always confirm the
# given query parses correctly, and if able to look up schema information from
# DataCatalog, will validate that the query analyzes properly as well.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [String] query
# The sql query to validate.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ValidateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ValidateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def validate_project_location_sql(project_id, location, query: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/sql:validate', options)
command.response_representation = Google::Apis::DataflowV1b3::ValidateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ValidateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['query'] = query unless query.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Cloud Dataflow job from a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_job_from_template_with_location(project_id, location, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates', options)
command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
command.request_object = create_job_from_template_request_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the template associated with a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [String] gcs_path
# Required. A Cloud Storage path to the template from which to create the job.
# Must be valid Cloud Storage URL, beginning with 'gs://'.
# @param [String] view
# The view to retrieve. Defaults to METADATA_ONLY.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_location_template(project_id, location, gcs_path: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/locations/{location}/templates:get', options)
command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Launch a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
# @param [String] dynamic_template_gcs_path
# Path to dynamic template spec file on GCS. The file must be a Json serialized
# DynamicTemplateFieSpec object.
# @param [String] dynamic_template_staging_location
# Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
# beginning with `gs://`.
# @param [String] gcs_path
# A Cloud Storage path to the template from which to create the job. Must be
# valid Cloud Storage URL, beginning with 'gs://'.
# @param [Boolean] validate_only
# If true, the request is validated but not actually executed. Defaults to false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def launch_project_location_template(project_id, location, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/locations/{location}/templates:launch', options)
command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
command.request_object = launch_template_parameters_object
command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.params['location'] = location unless location.nil?
command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Gets information about a snapshot.
# @param [String] project_id
# The ID of the Cloud Platform project that the snapshot belongs to.
# @param [String] snapshot_id
# The ID of the snapshot.
# @param [String] location
# The location that contains this snapshot.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Snapshot] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Snapshot]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_snapshot(project_id, snapshot_id, location: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots/{snapshotId}', options)
command.response_representation = Google::Apis::DataflowV1b3::Snapshot::Representation
command.response_class = Google::Apis::DataflowV1b3::Snapshot
command.params['projectId'] = project_id unless project_id.nil?
command.params['snapshotId'] = snapshot_id unless snapshot_id.nil?
command.query['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Lists snapshots.
# @param [String] project_id
# The project ID to list snapshots for.
# @param [String] job_id
# If specified, list snapshots created from this job.
# @param [String] location
# The location to list snapshots in.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListSnapshotsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListSnapshotsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_snapshots(project_id, job_id: nil, location: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/snapshots', options)
command.response_representation = Google::Apis::DataflowV1b3::ListSnapshotsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListSnapshotsResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['jobId'] = job_id unless job_id.nil?
command.query['location'] = location unless location.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# List TemplateVersions using project_id and an optional display_name field.
# List all the TemplateVersions in the Template if display set. List all the
# TemplateVersions in the Project if display_name not set.
# @param [String] parent
# parent includes project_id, and display_name is optional. List by project_id(
# pid1) and display_name(tid1). Format: projects/`pid1`/catalogTemplates/`tid1`
# List by project_id(pid1). Format: projects/`pid1`
# @param [Fixnum] page_size
# The maximum number of TemplateVersions to return per page.
# @param [String] page_token
# The page token, received from a previous ListTemplateVersions call. Provide
# this to retrieve the subsequent page.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::ListTemplateVersionsResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def list_project_template_versions(parent, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/{+parent}/templateVersions', options)
command.response_representation = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::ListTemplateVersionsResponse
command.params['parent'] = parent unless parent.nil?
command.query['pageSize'] = page_size unless page_size.nil?
command.query['pageToken'] = page_token unless page_token.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Creates a Cloud Dataflow job from a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest] create_job_from_template_request_object
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::Job] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::Job]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def create_job_from_template(project_id, create_job_from_template_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates', options)
command.request_representation = Google::Apis::DataflowV1b3::CreateJobFromTemplateRequest::Representation
command.request_object = create_job_from_template_request_object
command.response_representation = Google::Apis::DataflowV1b3::Job::Representation
command.response_class = Google::Apis::DataflowV1b3::Job
command.params['projectId'] = project_id unless project_id.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Get the template associated with a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [String] gcs_path
# Required. A Cloud Storage path to the template from which to create the job.
# Must be valid Cloud Storage URL, beginning with 'gs://'.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [String] view
# The view to retrieve. Defaults to METADATA_ONLY.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::GetTemplateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::GetTemplateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def get_project_template(project_id, gcs_path: nil, location: nil, view: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:get, 'v1b3/projects/{projectId}/templates:get', options)
command.response_representation = Google::Apis::DataflowV1b3::GetTemplateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::GetTemplateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
command.query['location'] = location unless location.nil?
command.query['view'] = view unless view.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
# Launch a template.
# @param [String] project_id
# Required. The ID of the Cloud Platform project that the job belongs to.
# @param [Google::Apis::DataflowV1b3::LaunchTemplateParameters] launch_template_parameters_object
# @param [String] dynamic_template_gcs_path
# Path to dynamic template spec file on GCS. The file must be a Json serialized
# DynamicTemplateFieSpec object.
# @param [String] dynamic_template_staging_location
# Cloud Storage path for staging dependencies. Must be a valid Cloud Storage URL,
# beginning with `gs://`.
# @param [String] gcs_path
# A Cloud Storage path to the template from which to create the job. Must be
# valid Cloud Storage URL, beginning with 'gs://'.
# @param [String] location
# The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/
# regional-endpoints) to which to direct the request.
# @param [Boolean] validate_only
# If true, the request is validated but not actually executed. Defaults to false.
# @param [String] fields
# Selector specifying which fields to include in a partial response.
# @param [String] quota_user
# Available to use for quota purposes for server-side applications. Can be any
# arbitrary string assigned to a user, but should not exceed 40 characters.
# @param [Google::Apis::RequestOptions] options
# Request-specific options
#
# @yield [result, err] Result & error if block supplied
# @yieldparam result [Google::Apis::DataflowV1b3::LaunchTemplateResponse] parsed result object
# @yieldparam err [StandardError] error object if request failed
#
# @return [Google::Apis::DataflowV1b3::LaunchTemplateResponse]
#
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
# @raise [Google::Apis::AuthorizationError] Authorization is required
def launch_project_template(project_id, launch_template_parameters_object = nil, dynamic_template_gcs_path: nil, dynamic_template_staging_location: nil, gcs_path: nil, location: nil, validate_only: nil, fields: nil, quota_user: nil, options: nil, &block)
command = make_simple_command(:post, 'v1b3/projects/{projectId}/templates:launch', options)
command.request_representation = Google::Apis::DataflowV1b3::LaunchTemplateParameters::Representation
command.request_object = launch_template_parameters_object
command.response_representation = Google::Apis::DataflowV1b3::LaunchTemplateResponse::Representation
command.response_class = Google::Apis::DataflowV1b3::LaunchTemplateResponse
command.params['projectId'] = project_id unless project_id.nil?
command.query['dynamicTemplate.gcsPath'] = dynamic_template_gcs_path unless dynamic_template_gcs_path.nil?
command.query['dynamicTemplate.stagingLocation'] = dynamic_template_staging_location unless dynamic_template_staging_location.nil?
command.query['gcsPath'] = gcs_path unless gcs_path.nil?
command.query['location'] = location unless location.nil?
command.query['validateOnly'] = validate_only unless validate_only.nil?
command.query['fields'] = fields unless fields.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
execute_or_queue_command(command, &block)
end
protected
def apply_command_defaults(command)
command.query['key'] = key unless key.nil?
command.query['quotaUser'] = quota_user unless quota_user.nil?
end
end
end
end
end
|