github.com/rkt/rkt@v1.30.1-0.20200224141603-171c416fac02/api/v1alpha/docs/index.html (about) 1 <!DOCTYPE html> 2 3 <html> 4 <head> 5 <title>Protocol Documentation</title> 6 <meta charset="UTF-8"> 7 <link rel="stylesheet" type="text/css" href="http://fonts.googleapis.com/css?family=Ubuntu:400,700,400italic"/> 8 <style> 9 body { 10 width: 60em; 11 margin: 1em auto; 12 color: #222; 13 font-family: "Ubuntu", sans-serif; 14 padding-bottom: 4em; 15 } 16 17 h1 { 18 font-weight: normal; 19 border-bottom: 1px solid #aaa; 20 padding-bottom: 0.5ex; 21 } 22 23 h2 { 24 border-bottom: 1px solid #aaa; 25 padding-bottom: 0.5ex; 26 margin: 1.5em 0; 27 } 28 29 h3 { 30 font-weight: normal; 31 border-bottom: 1px solid #aaa; 32 padding-bottom: 0.5ex; 33 } 34 35 a { 36 text-decoration: none; 37 color: #567e25; 38 } 39 40 table { 41 width: 100%; 42 font-size: 80%; 43 border-collapse: collapse; 44 } 45 46 thead { 47 font-weight: 700; 48 background-color: #dcdcdc; 49 } 50 51 tbody tr:nth-child(even) { 52 background-color: #fbfbfb; 53 } 54 55 td { 56 border: 1px solid #ccc; 57 padding: 0.5ex 2ex; 58 } 59 60 td p { 61 text-indent: 1em; 62 margin: 0; 63 } 64 65 td p:nth-child(1) { 66 text-indent: 0; 67 } 68 69 70 .field-table td:nth-child(1) { 71 width: 10em; 72 } 73 .field-table td:nth-child(2) { 74 width: 10em; 75 } 76 .field-table td:nth-child(3) { 77 width: 6em; 78 } 79 .field-table td:nth-child(4) { 80 width: auto; 81 } 82 83 84 .extension-table td:nth-child(1) { 85 width: 10em; 86 } 87 .extension-table td:nth-child(2) { 88 width: 10em; 89 } 90 .extension-table td:nth-child(3) { 91 width: 10em; 92 } 93 .extension-table td:nth-child(4) { 94 width: 5em; 95 } 96 .extension-table td:nth-child(5) { 97 width: auto; 98 } 99 100 101 .enum-table td:nth-child(1) { 102 width: 10em; 103 } 104 .enum-table td:nth-child(2) { 105 width: 10em; 106 } 107 .enum-table td:nth-child(3) { 108 width: auto; 109 } 110 111 112 .scalar-value-types-table tr { 113 height: 3em; 114 } 115 116 117 #toc-container ul { 118 list-style-type: none; 119 padding-left: 1em; 120 line-height: 180%; 121 margin: 0; 122 } 123 #toc > li > a { 124 font-weight: bold; 125 } 126 127 128 .file-heading { 129 width: 100%; 130 display: table; 131 border-bottom: 1px solid #aaa; 132 margin: 4em 0 1.5em 0; 133 } 134 .file-heading h2 { 135 border: none; 136 display: table-cell; 137 } 138 .file-heading a { 139 text-align: right; 140 display: table-cell; 141 } 142 143 144 .badge { 145 width: 1.6em; 146 height: 1.6em; 147 display: inline-block; 148 149 line-height: 1.6em; 150 text-align: center; 151 font-weight: bold; 152 font-size: 60%; 153 154 color: #89ba48; 155 background-color: #dff0c8; 156 157 margin: 0.5ex 1em 0.5ex -1em; 158 border: 1px solid #fbfbfb; 159 border-radius: 1ex; 160 } 161 </style> 162 163 164 <link rel="stylesheet" type="text/css" href="stylesheet.css"/> 165 </head> 166 167 <body> 168 169 <h1 id="title">Protocol Documentation</h1> 170 171 <h2>Table of Contents</h2> 172 173 <div id="toc-container"> 174 <ul id="toc"> 175 176 177 <li> 178 <a href="#api.proto">api.proto</a> 179 <ul> 180 181 <li> 182 <a href="#v1alpha.App"><span class="badge">M</span>App</a> 183 </li> 184 185 <li> 186 <a href="#v1alpha.Event"><span class="badge">M</span>Event</a> 187 </li> 188 189 <li> 190 <a href="#v1alpha.EventFilter"><span class="badge">M</span>EventFilter</a> 191 </li> 192 193 <li> 194 <a href="#v1alpha.GetInfoRequest"><span class="badge">M</span>GetInfoRequest</a> 195 </li> 196 197 <li> 198 <a href="#v1alpha.GetInfoResponse"><span class="badge">M</span>GetInfoResponse</a> 199 </li> 200 201 <li> 202 <a href="#v1alpha.GetLogsRequest"><span class="badge">M</span>GetLogsRequest</a> 203 </li> 204 205 <li> 206 <a href="#v1alpha.GetLogsResponse"><span class="badge">M</span>GetLogsResponse</a> 207 </li> 208 209 <li> 210 <a href="#v1alpha.GlobalFlags"><span class="badge">M</span>GlobalFlags</a> 211 </li> 212 213 <li> 214 <a href="#v1alpha.Image"><span class="badge">M</span>Image</a> 215 </li> 216 217 <li> 218 <a href="#v1alpha.ImageFilter"><span class="badge">M</span>ImageFilter</a> 219 </li> 220 221 <li> 222 <a href="#v1alpha.ImageFormat"><span class="badge">M</span>ImageFormat</a> 223 </li> 224 225 <li> 226 <a href="#v1alpha.Info"><span class="badge">M</span>Info</a> 227 </li> 228 229 <li> 230 <a href="#v1alpha.InspectImageRequest"><span class="badge">M</span>InspectImageRequest</a> 231 </li> 232 233 <li> 234 <a href="#v1alpha.InspectImageResponse"><span class="badge">M</span>InspectImageResponse</a> 235 </li> 236 237 <li> 238 <a href="#v1alpha.InspectPodRequest"><span class="badge">M</span>InspectPodRequest</a> 239 </li> 240 241 <li> 242 <a href="#v1alpha.InspectPodResponse"><span class="badge">M</span>InspectPodResponse</a> 243 </li> 244 245 <li> 246 <a href="#v1alpha.KeyValue"><span class="badge">M</span>KeyValue</a> 247 </li> 248 249 <li> 250 <a href="#v1alpha.ListImagesRequest"><span class="badge">M</span>ListImagesRequest</a> 251 </li> 252 253 <li> 254 <a href="#v1alpha.ListImagesResponse"><span class="badge">M</span>ListImagesResponse</a> 255 </li> 256 257 <li> 258 <a href="#v1alpha.ListPodsRequest"><span class="badge">M</span>ListPodsRequest</a> 259 </li> 260 261 <li> 262 <a href="#v1alpha.ListPodsResponse"><span class="badge">M</span>ListPodsResponse</a> 263 </li> 264 265 <li> 266 <a href="#v1alpha.ListenEventsRequest"><span class="badge">M</span>ListenEventsRequest</a> 267 </li> 268 269 <li> 270 <a href="#v1alpha.ListenEventsResponse"><span class="badge">M</span>ListenEventsResponse</a> 271 </li> 272 273 <li> 274 <a href="#v1alpha.Network"><span class="badge">M</span>Network</a> 275 </li> 276 277 <li> 278 <a href="#v1alpha.Pod"><span class="badge">M</span>Pod</a> 279 </li> 280 281 <li> 282 <a href="#v1alpha.PodFilter"><span class="badge">M</span>PodFilter</a> 283 </li> 284 285 286 <li> 287 <a href="#v1alpha.AppState"><span class="badge">E</span>AppState</a> 288 </li> 289 290 <li> 291 <a href="#v1alpha.EventType"><span class="badge">E</span>EventType</a> 292 </li> 293 294 <li> 295 <a href="#v1alpha.ImageType"><span class="badge">E</span>ImageType</a> 296 </li> 297 298 <li> 299 <a href="#v1alpha.PodState"><span class="badge">E</span>PodState</a> 300 </li> 301 302 303 304 <li> 305 <a href="#v1alpha.PublicAPI"><span class="badge">S</span>PublicAPI</a> 306 </li> 307 308 </ul> 309 </li> 310 311 <li><a href="#scalar-value-types">Scalar Value Types</a></li> 312 </ul> 313 </div> 314 315 316 317 <div class="file-heading"> 318 <h2 id="api.proto">api.proto</h2><a href="#title">Top</a> 319 </div> 320 <p></p> 321 322 323 <h3 id="v1alpha.App">App</h3> 324 <p>App describes the information of an app that's running in a pod.</p> 325 326 327 <table class="field-table"> 328 <thead> 329 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 330 </thead> 331 <tbody> 332 333 <tr> 334 <td>name</td> 335 <td><a href="#string">string</a></td> 336 <td></td> 337 <td><p>Name of the app, required. </p></td> 338 </tr> 339 340 <tr> 341 <td>image</td> 342 <td><a href="#v1alpha.Image">Image</a></td> 343 <td></td> 344 <td><p>Image used by the app, required. However, this may only contain the image id 345 if it is returned by ListPods(). </p></td> 346 </tr> 347 348 <tr> 349 <td>state</td> 350 <td><a href="#v1alpha.AppState">AppState</a></td> 351 <td></td> 352 <td><p>State of the app. optional, non-empty only if it's returned by InspectPod(). </p></td> 353 </tr> 354 355 <tr> 356 <td>exit_code</td> 357 <td><a href="#sint32">sint32</a></td> 358 <td></td> 359 <td><p>Exit code of the app. optional, only valid if it's returned by InspectPod() and 360 the app has already exited. </p></td> 361 </tr> 362 363 <tr> 364 <td>annotations</td> 365 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 366 <td>repeated</td> 367 <td><p>Annotations for this app. </p></td> 368 </tr> 369 370 </tbody> 371 </table> 372 373 374 375 376 <h3 id="v1alpha.Event">Event</h3> 377 <p>Event describes the events that will be received via ListenEvents().</p> 378 379 380 <table class="field-table"> 381 <thead> 382 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 383 </thead> 384 <tbody> 385 386 <tr> 387 <td>type</td> 388 <td><a href="#v1alpha.EventType">EventType</a></td> 389 <td></td> 390 <td><p>Type of the event, required. </p></td> 391 </tr> 392 393 <tr> 394 <td>id</td> 395 <td><a href="#string">string</a></td> 396 <td></td> 397 <td><p>ID of the subject that causes the event, required. 398 If the event is a pod or app event, the id is the pod's uuid. 399 If the event is an image event, the id is the image's id. </p></td> 400 </tr> 401 402 <tr> 403 <td>from</td> 404 <td><a href="#string">string</a></td> 405 <td></td> 406 <td><p>Name of the subject that causes the event, required. 407 If the event is a pod event, the name is the pod's name. 408 If the event is an app event, the name is the app's name. 409 If the event is an image event, the name is the image's name. </p></td> 410 </tr> 411 412 <tr> 413 <td>time</td> 414 <td><a href="#int64">int64</a></td> 415 <td></td> 416 <td><p>Timestamp of when the event happens, it is the seconds since epoch, required. </p></td> 417 </tr> 418 419 <tr> 420 <td>data</td> 421 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 422 <td>repeated</td> 423 <td><p>Data of the event, in the form of key-value pairs, optional. </p></td> 424 </tr> 425 426 </tbody> 427 </table> 428 429 430 431 432 <h3 id="v1alpha.EventFilter">EventFilter</h3> 433 <p>EventFilter defines the condition that the returned events needs to satisfy in ListImages().</p><p>The condition are combined by 'AND'.</p> 434 435 436 <table class="field-table"> 437 <thead> 438 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 439 </thead> 440 <tbody> 441 442 <tr> 443 <td>types</td> 444 <td><a href="#v1alpha.EventType">EventType</a></td> 445 <td>repeated</td> 446 <td><p>If not empty, then only returns the events that have the listed types. </p></td> 447 </tr> 448 449 <tr> 450 <td>ids</td> 451 <td><a href="#string">string</a></td> 452 <td>repeated</td> 453 <td><p>If not empty, then only returns the events whose 'id' is included in the listed ids. </p></td> 454 </tr> 455 456 <tr> 457 <td>names</td> 458 <td><a href="#string">string</a></td> 459 <td>repeated</td> 460 <td><p>If not empty, then only returns the events whose 'from' is included in the listed names. </p></td> 461 </tr> 462 463 <tr> 464 <td>since_time</td> 465 <td><a href="#int64">int64</a></td> 466 <td></td> 467 <td><p>If set, then only returns the events after this timestamp. 468 If the server starts after since_time, then only the events happened after the start of the server will be returned. 469 If since_time is a future timestamp, then no events will be returned until that time. </p></td> 470 </tr> 471 472 <tr> 473 <td>until_time</td> 474 <td><a href="#int64">int64</a></td> 475 <td></td> 476 <td><p>If set, then only returns the events before this timestamp. 477 If it is a future timestamp, then the event stream will be closed at that moment. </p></td> 478 </tr> 479 480 </tbody> 481 </table> 482 483 484 485 486 <h3 id="v1alpha.GetInfoRequest">GetInfoRequest</h3> 487 <p>Request for GetInfo().</p> 488 489 490 491 492 493 <h3 id="v1alpha.GetInfoResponse">GetInfoResponse</h3> 494 <p>Response for GetInfo().</p> 495 496 497 <table class="field-table"> 498 <thead> 499 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 500 </thead> 501 <tbody> 502 503 <tr> 504 <td>info</td> 505 <td><a href="#v1alpha.Info">Info</a></td> 506 <td></td> 507 <td><p>Required. </p></td> 508 </tr> 509 510 </tbody> 511 </table> 512 513 514 515 516 <h3 id="v1alpha.GetLogsRequest">GetLogsRequest</h3> 517 <p>Request for GetLogs().</p> 518 519 520 <table class="field-table"> 521 <thead> 522 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 523 </thead> 524 <tbody> 525 526 <tr> 527 <td>pod_id</td> 528 <td><a href="#string">string</a></td> 529 <td></td> 530 <td><p>ID of the pod which we will get logs from, required. </p></td> 531 </tr> 532 533 <tr> 534 <td>app_name</td> 535 <td><a href="#string">string</a></td> 536 <td></td> 537 <td><p>Name of the app within the pod which we will get logs 538 from, optional. If not set, then the logs of all the 539 apps within the pod will be returned. </p></td> 540 </tr> 541 542 <tr> 543 <td>lines</td> 544 <td><a href="#int32">int32</a></td> 545 <td></td> 546 <td><p>Number of most recent lines to return, optional. </p></td> 547 </tr> 548 549 <tr> 550 <td>follow</td> 551 <td><a href="#bool">bool</a></td> 552 <td></td> 553 <td><p>If true, then a response stream will not be closed, 554 and new log response will be sent via the stream, default is false. </p></td> 555 </tr> 556 557 <tr> 558 <td>since_time</td> 559 <td><a href="#int64">int64</a></td> 560 <td></td> 561 <td><p>If set, then only the logs after the timestamp will 562 be returned, optional. </p></td> 563 </tr> 564 565 <tr> 566 <td>until_time</td> 567 <td><a href="#int64">int64</a></td> 568 <td></td> 569 <td><p>If set, then only the logs before the timestamp will 570 be returned, optional. </p></td> 571 </tr> 572 573 </tbody> 574 </table> 575 576 577 578 579 <h3 id="v1alpha.GetLogsResponse">GetLogsResponse</h3> 580 <p>Response for GetLogs().</p> 581 582 583 <table class="field-table"> 584 <thead> 585 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 586 </thead> 587 <tbody> 588 589 <tr> 590 <td>lines</td> 591 <td><a href="#string">string</a></td> 592 <td>repeated</td> 593 <td><p>List of the log lines that returned, optional as the response can contain no logs. </p></td> 594 </tr> 595 596 </tbody> 597 </table> 598 599 600 601 602 <h3 id="v1alpha.GlobalFlags">GlobalFlags</h3> 603 <p>GlobalFlags describes the flags that passed to rkt api service when it is launched.</p> 604 605 606 <table class="field-table"> 607 <thead> 608 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 609 </thead> 610 <tbody> 611 612 <tr> 613 <td>dir</td> 614 <td><a href="#string">string</a></td> 615 <td></td> 616 <td><p>Data directory. </p></td> 617 </tr> 618 619 <tr> 620 <td>system_config_dir</td> 621 <td><a href="#string">string</a></td> 622 <td></td> 623 <td><p>System configuration directory. </p></td> 624 </tr> 625 626 <tr> 627 <td>local_config_dir</td> 628 <td><a href="#string">string</a></td> 629 <td></td> 630 <td><p>Local configuration directory. </p></td> 631 </tr> 632 633 <tr> 634 <td>user_config_dir</td> 635 <td><a href="#string">string</a></td> 636 <td></td> 637 <td><p>User configuration directory. </p></td> 638 </tr> 639 640 <tr> 641 <td>insecure_flags</td> 642 <td><a href="#string">string</a></td> 643 <td></td> 644 <td><p>Insecure flags configurates what security features to disable. </p></td> 645 </tr> 646 647 <tr> 648 <td>trust_keys_from_https</td> 649 <td><a href="#bool">bool</a></td> 650 <td></td> 651 <td><p>Whether to automatically trust gpg keys fetched from https </p></td> 652 </tr> 653 654 </tbody> 655 </table> 656 657 658 659 660 <h3 id="v1alpha.Image">Image</h3> 661 <p>Image describes the image's information.</p> 662 663 664 <table class="field-table"> 665 <thead> 666 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 667 </thead> 668 <tbody> 669 670 <tr> 671 <td>base_format</td> 672 <td><a href="#v1alpha.ImageFormat">ImageFormat</a></td> 673 <td></td> 674 <td><p>Base format of the image, required. This indicates the original format 675 for the image as nowadays all the image formats will be transformed to 676 ACI. </p></td> 677 </tr> 678 679 <tr> 680 <td>id</td> 681 <td><a href="#string">string</a></td> 682 <td></td> 683 <td><p>ID of the image, a string that can be used to uniquely identify the image, 684 e.g. sha512 hash of the ACIs, required. </p></td> 685 </tr> 686 687 <tr> 688 <td>name</td> 689 <td><a href="#string">string</a></td> 690 <td></td> 691 <td><p>Name of the image in the image manifest, e.g. 'coreos.com/etcd', optional. </p></td> 692 </tr> 693 694 <tr> 695 <td>version</td> 696 <td><a href="#string">string</a></td> 697 <td></td> 698 <td><p>Version of the image, e.g. 'latest', '2.0.10', optional. </p></td> 699 </tr> 700 701 <tr> 702 <td>import_timestamp</td> 703 <td><a href="#int64">int64</a></td> 704 <td></td> 705 <td><p>Timestamp of when the image is imported, it is the seconds since epoch, optional. </p></td> 706 </tr> 707 708 <tr> 709 <td>manifest</td> 710 <td><a href="#bytes">bytes</a></td> 711 <td></td> 712 <td><p>JSON-encoded byte array that represents the image manifest, optional. </p></td> 713 </tr> 714 715 <tr> 716 <td>size</td> 717 <td><a href="#int64">int64</a></td> 718 <td></td> 719 <td><p>Size is the size in bytes of this image in the store. </p></td> 720 </tr> 721 722 <tr> 723 <td>annotations</td> 724 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 725 <td>repeated</td> 726 <td><p>Annotations on this image. </p></td> 727 </tr> 728 729 <tr> 730 <td>labels</td> 731 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 732 <td>repeated</td> 733 <td><p>Labels of this image. </p></td> 734 </tr> 735 736 </tbody> 737 </table> 738 739 740 741 742 <h3 id="v1alpha.ImageFilter">ImageFilter</h3> 743 <p>ImageFilter defines the condition that the returned images need to satisfy in ListImages().</p><p>The conditions are combined by 'AND', and different filters are combined by 'OR'.</p> 744 745 746 <table class="field-table"> 747 <thead> 748 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 749 </thead> 750 <tbody> 751 752 <tr> 753 <td>ids</td> 754 <td><a href="#string">string</a></td> 755 <td>repeated</td> 756 <td><p>If not empty, the images that have any of the ids will be returned. </p></td> 757 </tr> 758 759 <tr> 760 <td>prefixes</td> 761 <td><a href="#string">string</a></td> 762 <td>repeated</td> 763 <td><p>if not empty, the images that have any of the prefixes in the name will be returned. </p></td> 764 </tr> 765 766 <tr> 767 <td>base_names</td> 768 <td><a href="#string">string</a></td> 769 <td>repeated</td> 770 <td><p>If not empty, the images that have any of the base names will be returned. 771 For example, both 'coreos.com/etcd' and 'k8s.io/etcd' will be returned if 'etcd' is included, 772 however 'k8s.io/etcd-backup' will not be returned. </p></td> 773 </tr> 774 775 <tr> 776 <td>keywords</td> 777 <td><a href="#string">string</a></td> 778 <td>repeated</td> 779 <td><p>If not empty, the images that have any of the keywords in the name will be returned. 780 For example, both 'kubernetes-etcd', 'etcd:latest' will be returned if 'etcd' is included, </p></td> 781 </tr> 782 783 <tr> 784 <td>labels</td> 785 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 786 <td>repeated</td> 787 <td><p>If not empty, the images that have all of the labels will be returned. </p></td> 788 </tr> 789 790 <tr> 791 <td>imported_after</td> 792 <td><a href="#int64">int64</a></td> 793 <td></td> 794 <td><p>If set, the images that are imported after this timestamp will be returned. </p></td> 795 </tr> 796 797 <tr> 798 <td>imported_before</td> 799 <td><a href="#int64">int64</a></td> 800 <td></td> 801 <td><p>If set, the images that are imported before this timestamp will be returned. </p></td> 802 </tr> 803 804 <tr> 805 <td>annotations</td> 806 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 807 <td>repeated</td> 808 <td><p>If not empty, the images that have all of the annotations will be returned. </p></td> 809 </tr> 810 811 <tr> 812 <td>full_names</td> 813 <td><a href="#string">string</a></td> 814 <td>repeated</td> 815 <td><p>If not empty, the images that have any of the exact full names will be returned. </p></td> 816 </tr> 817 818 </tbody> 819 </table> 820 821 822 823 824 <h3 id="v1alpha.ImageFormat">ImageFormat</h3> 825 <p>ImageFormat defines the format of the image.</p> 826 827 828 <table class="field-table"> 829 <thead> 830 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 831 </thead> 832 <tbody> 833 834 <tr> 835 <td>type</td> 836 <td><a href="#v1alpha.ImageType">ImageType</a></td> 837 <td></td> 838 <td><p>Type of the image, required. </p></td> 839 </tr> 840 841 <tr> 842 <td>version</td> 843 <td><a href="#string">string</a></td> 844 <td></td> 845 <td><p>Version of the image format, required. </p></td> 846 </tr> 847 848 </tbody> 849 </table> 850 851 852 853 854 <h3 id="v1alpha.Info">Info</h3> 855 <p>Info describes the information of rkt on the machine.</p> 856 857 858 <table class="field-table"> 859 <thead> 860 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 861 </thead> 862 <tbody> 863 864 <tr> 865 <td>rkt_version</td> 866 <td><a href="#string">string</a></td> 867 <td></td> 868 <td><p>Version of rkt, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/). </p></td> 869 </tr> 870 871 <tr> 872 <td>appc_version</td> 873 <td><a href="#string">string</a></td> 874 <td></td> 875 <td><p>Version of appc, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/). </p></td> 876 </tr> 877 878 <tr> 879 <td>api_version</td> 880 <td><a href="#string">string</a></td> 881 <td></td> 882 <td><p>Latest version of the api that's supported by the service, required, in the form of Semantic Versioning 2.0.0 (http://semver.org/). </p></td> 883 </tr> 884 885 <tr> 886 <td>global_flags</td> 887 <td><a href="#v1alpha.GlobalFlags">GlobalFlags</a></td> 888 <td></td> 889 <td><p>The global flags that passed to the rkt api service when it's launched. </p></td> 890 </tr> 891 892 </tbody> 893 </table> 894 895 896 897 898 <h3 id="v1alpha.InspectImageRequest">InspectImageRequest</h3> 899 <p>Request for InspectImage().</p> 900 901 902 <table class="field-table"> 903 <thead> 904 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 905 </thead> 906 <tbody> 907 908 <tr> 909 <td>id</td> 910 <td><a href="#string">string</a></td> 911 <td></td> 912 <td><p>Required. </p></td> 913 </tr> 914 915 </tbody> 916 </table> 917 918 919 920 921 <h3 id="v1alpha.InspectImageResponse">InspectImageResponse</h3> 922 <p>Response for InspectImage().</p> 923 924 925 <table class="field-table"> 926 <thead> 927 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 928 </thead> 929 <tbody> 930 931 <tr> 932 <td>image</td> 933 <td><a href="#v1alpha.Image">Image</a></td> 934 <td></td> 935 <td><p>Required. </p></td> 936 </tr> 937 938 </tbody> 939 </table> 940 941 942 943 944 <h3 id="v1alpha.InspectPodRequest">InspectPodRequest</h3> 945 <p>Request for InspectPod().</p> 946 947 948 <table class="field-table"> 949 <thead> 950 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 951 </thead> 952 <tbody> 953 954 <tr> 955 <td>id</td> 956 <td><a href="#string">string</a></td> 957 <td></td> 958 <td><p>ID of the pod which we are querying status for, required. </p></td> 959 </tr> 960 961 </tbody> 962 </table> 963 964 965 966 967 <h3 id="v1alpha.InspectPodResponse">InspectPodResponse</h3> 968 <p>Response for InspectPod().</p> 969 970 971 <table class="field-table"> 972 <thead> 973 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 974 </thead> 975 <tbody> 976 977 <tr> 978 <td>pod</td> 979 <td><a href="#v1alpha.Pod">Pod</a></td> 980 <td></td> 981 <td><p>Required. </p></td> 982 </tr> 983 984 </tbody> 985 </table> 986 987 988 989 990 <h3 id="v1alpha.KeyValue">KeyValue</h3> 991 <p></p> 992 993 994 <table class="field-table"> 995 <thead> 996 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 997 </thead> 998 <tbody> 999 1000 <tr> 1001 <td>Key</td> 1002 <td><a href="#string">string</a></td> 1003 <td></td> 1004 <td><p>Key part of the key-value pair. </p></td> 1005 </tr> 1006 1007 <tr> 1008 <td>value</td> 1009 <td><a href="#string">string</a></td> 1010 <td></td> 1011 <td><p>Value part of the key-value pair. </p></td> 1012 </tr> 1013 1014 </tbody> 1015 </table> 1016 1017 1018 1019 1020 <h3 id="v1alpha.ListImagesRequest">ListImagesRequest</h3> 1021 <p>Request for ListImages().</p> 1022 1023 1024 <table class="field-table"> 1025 <thead> 1026 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1027 </thead> 1028 <tbody> 1029 1030 <tr> 1031 <td>filters</td> 1032 <td><a href="#v1alpha.ImageFilter">ImageFilter</a></td> 1033 <td>repeated</td> 1034 <td><p>Optional. </p></td> 1035 </tr> 1036 1037 <tr> 1038 <td>detail</td> 1039 <td><a href="#bool">bool</a></td> 1040 <td></td> 1041 <td><p>Optional. </p></td> 1042 </tr> 1043 1044 </tbody> 1045 </table> 1046 1047 1048 1049 1050 <h3 id="v1alpha.ListImagesResponse">ListImagesResponse</h3> 1051 <p>Response for ListImages().</p> 1052 1053 1054 <table class="field-table"> 1055 <thead> 1056 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1057 </thead> 1058 <tbody> 1059 1060 <tr> 1061 <td>images</td> 1062 <td><a href="#v1alpha.Image">Image</a></td> 1063 <td>repeated</td> 1064 <td><p>Required. </p></td> 1065 </tr> 1066 1067 </tbody> 1068 </table> 1069 1070 1071 1072 1073 <h3 id="v1alpha.ListPodsRequest">ListPodsRequest</h3> 1074 <p>Request for ListPods().</p> 1075 1076 1077 <table class="field-table"> 1078 <thead> 1079 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1080 </thead> 1081 <tbody> 1082 1083 <tr> 1084 <td>filters</td> 1085 <td><a href="#v1alpha.PodFilter">PodFilter</a></td> 1086 <td>repeated</td> 1087 <td><p>Optional. </p></td> 1088 </tr> 1089 1090 <tr> 1091 <td>detail</td> 1092 <td><a href="#bool">bool</a></td> 1093 <td></td> 1094 <td><p>Optional. </p></td> 1095 </tr> 1096 1097 </tbody> 1098 </table> 1099 1100 1101 1102 1103 <h3 id="v1alpha.ListPodsResponse">ListPodsResponse</h3> 1104 <p>Response for ListPods().</p> 1105 1106 1107 <table class="field-table"> 1108 <thead> 1109 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1110 </thead> 1111 <tbody> 1112 1113 <tr> 1114 <td>pods</td> 1115 <td><a href="#v1alpha.Pod">Pod</a></td> 1116 <td>repeated</td> 1117 <td><p>Required. </p></td> 1118 </tr> 1119 1120 </tbody> 1121 </table> 1122 1123 1124 1125 1126 <h3 id="v1alpha.ListenEventsRequest">ListenEventsRequest</h3> 1127 <p>Request for ListenEvents().</p> 1128 1129 1130 <table class="field-table"> 1131 <thead> 1132 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1133 </thead> 1134 <tbody> 1135 1136 <tr> 1137 <td>filter</td> 1138 <td><a href="#v1alpha.EventFilter">EventFilter</a></td> 1139 <td></td> 1140 <td><p>Optional. </p></td> 1141 </tr> 1142 1143 </tbody> 1144 </table> 1145 1146 1147 1148 1149 <h3 id="v1alpha.ListenEventsResponse">ListenEventsResponse</h3> 1150 <p>Response for ListenEvents().</p> 1151 1152 1153 <table class="field-table"> 1154 <thead> 1155 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1156 </thead> 1157 <tbody> 1158 1159 <tr> 1160 <td>events</td> 1161 <td><a href="#v1alpha.Event">Event</a></td> 1162 <td>repeated</td> 1163 <td><p>Aggregate multiple events to reduce round trips, optional as the response can contain no events. </p></td> 1164 </tr> 1165 1166 </tbody> 1167 </table> 1168 1169 1170 1171 1172 <h3 id="v1alpha.Network">Network</h3> 1173 <p>Network describes the network information of a pod.</p> 1174 1175 1176 <table class="field-table"> 1177 <thead> 1178 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1179 </thead> 1180 <tbody> 1181 1182 <tr> 1183 <td>name</td> 1184 <td><a href="#string">string</a></td> 1185 <td></td> 1186 <td><p>Name of the network that a pod belongs to, required. </p></td> 1187 </tr> 1188 1189 <tr> 1190 <td>ipv4</td> 1191 <td><a href="#string">string</a></td> 1192 <td></td> 1193 <td><p>Pod's IPv4 address within the network, optional if IPv6 address is given. </p></td> 1194 </tr> 1195 1196 <tr> 1197 <td>ipv6</td> 1198 <td><a href="#string">string</a></td> 1199 <td></td> 1200 <td><p>Pod's IPv6 address within the network, optional if IPv4 address is given. </p></td> 1201 </tr> 1202 1203 </tbody> 1204 </table> 1205 1206 1207 1208 1209 <h3 id="v1alpha.Pod">Pod</h3> 1210 <p>Pod describes a pod's information.</p><p>If a pod is in Embryo, Preparing, AbortedPrepare state,</p><p>only id and state will be returned.</p><p>If a pod is in other states, the pod manifest and</p><p>apps will be returned when 'detailed' is true in the request.</p><p>A valid pid of the stage1 process of the pod will be returned</p><p>if the pod is Running has run once.</p><p>Networks are only returned when a pod is in Running.</p> 1211 1212 1213 <table class="field-table"> 1214 <thead> 1215 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1216 </thead> 1217 <tbody> 1218 1219 <tr> 1220 <td>id</td> 1221 <td><a href="#string">string</a></td> 1222 <td></td> 1223 <td><p>ID of the pod, in the form of a UUID. </p></td> 1224 </tr> 1225 1226 <tr> 1227 <td>pid</td> 1228 <td><a href="#sint32">sint32</a></td> 1229 <td></td> 1230 <td><p>PID of the stage1 process of the pod. </p></td> 1231 </tr> 1232 1233 <tr> 1234 <td>state</td> 1235 <td><a href="#v1alpha.PodState">PodState</a></td> 1236 <td></td> 1237 <td><p>State of the pod. </p></td> 1238 </tr> 1239 1240 <tr> 1241 <td>apps</td> 1242 <td><a href="#v1alpha.App">App</a></td> 1243 <td>repeated</td> 1244 <td><p>List of apps in the pod. </p></td> 1245 </tr> 1246 1247 <tr> 1248 <td>networks</td> 1249 <td><a href="#v1alpha.Network">Network</a></td> 1250 <td>repeated</td> 1251 <td><p>Network information of the pod. 1252 Note that a pod can be in multiple networks. </p></td> 1253 </tr> 1254 1255 <tr> 1256 <td>manifest</td> 1257 <td><a href="#bytes">bytes</a></td> 1258 <td></td> 1259 <td><p>JSON-encoded byte array that represents the pod manifest of the pod. </p></td> 1260 </tr> 1261 1262 <tr> 1263 <td>annotations</td> 1264 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 1265 <td>repeated</td> 1266 <td><p>Annotations on this pod. </p></td> 1267 </tr> 1268 1269 <tr> 1270 <td>cgroup</td> 1271 <td><a href="#string">string</a></td> 1272 <td></td> 1273 <td><p>Cgroup of the pod, empty if the pod is not running. </p></td> 1274 </tr> 1275 1276 <tr> 1277 <td>created_at</td> 1278 <td><a href="#int64">int64</a></td> 1279 <td></td> 1280 <td><p>Timestamp of when the pod is created, nanoseconds since epoch. 1281 Zero if the pod is not created. </p></td> 1282 </tr> 1283 1284 <tr> 1285 <td>started_at</td> 1286 <td><a href="#int64">int64</a></td> 1287 <td></td> 1288 <td><p>Timestamp of when the pod is started, nanoseconds since epoch. 1289 Zero if the pod is not started. </p></td> 1290 </tr> 1291 1292 <tr> 1293 <td>gc_marked_at</td> 1294 <td><a href="#int64">int64</a></td> 1295 <td></td> 1296 <td><p>Timestamp of when the pod is moved to exited-garbage/garbage, 1297 in nanoseconds since epoch. 1298 Zero if the pod is not moved to exited-garbage/garbage yet. </p></td> 1299 </tr> 1300 1301 </tbody> 1302 </table> 1303 1304 1305 1306 1307 <h3 id="v1alpha.PodFilter">PodFilter</h3> 1308 <p>PodFilter defines the condition that the returned pods need to satisfy in ListPods().</p><p>The conditions are combined by 'AND', and different filters are combined by 'OR'.</p> 1309 1310 1311 <table class="field-table"> 1312 <thead> 1313 <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr> 1314 </thead> 1315 <tbody> 1316 1317 <tr> 1318 <td>ids</td> 1319 <td><a href="#string">string</a></td> 1320 <td>repeated</td> 1321 <td><p>If not empty, the pods that have any of the ids will be returned. </p></td> 1322 </tr> 1323 1324 <tr> 1325 <td>states</td> 1326 <td><a href="#v1alpha.PodState">PodState</a></td> 1327 <td>repeated</td> 1328 <td><p>If not empty, the pods that have any of the states will be returned. </p></td> 1329 </tr> 1330 1331 <tr> 1332 <td>app_names</td> 1333 <td><a href="#string">string</a></td> 1334 <td>repeated</td> 1335 <td><p>If not empty, the pods that all of the apps will be returned. </p></td> 1336 </tr> 1337 1338 <tr> 1339 <td>image_ids</td> 1340 <td><a href="#string">string</a></td> 1341 <td>repeated</td> 1342 <td><p>If not empty, the pods that have all of the images(in the apps) will be returned </p></td> 1343 </tr> 1344 1345 <tr> 1346 <td>network_names</td> 1347 <td><a href="#string">string</a></td> 1348 <td>repeated</td> 1349 <td><p>If not empty, the pods that are in all of the networks will be returned. </p></td> 1350 </tr> 1351 1352 <tr> 1353 <td>annotations</td> 1354 <td><a href="#v1alpha.KeyValue">KeyValue</a></td> 1355 <td>repeated</td> 1356 <td><p>If not empty, the pods that have all of the annotations will be returned. </p></td> 1357 </tr> 1358 1359 <tr> 1360 <td>cgroups</td> 1361 <td><a href="#string">string</a></td> 1362 <td>repeated</td> 1363 <td><p>If not empty, the pods whose cgroup are listed will be returned. </p></td> 1364 </tr> 1365 1366 <tr> 1367 <td>pod_sub_cgroups</td> 1368 <td><a href="#string">string</a></td> 1369 <td>repeated</td> 1370 <td><p>If not empty, the pods whose these cgroup belong to will be returned. 1371 i.e. the pod's cgroup is a prefix of the specified cgroup </p></td> 1372 </tr> 1373 1374 </tbody> 1375 </table> 1376 1377 1378 1379 1380 1381 1382 <h3 id="v1alpha.AppState">AppState</h3> 1383 <p>AppState defines the possible states of the app.</p> 1384 <table class="enum-table"> 1385 <thead> 1386 <tr><td>Name</td><td>Number</td><td>Description</td></tr> 1387 </thead> 1388 <tbody> 1389 1390 <tr> 1391 <td>APP_STATE_UNDEFINED</td> 1392 <td>0</td> 1393 <td><p></p></td> 1394 </tr> 1395 1396 <tr> 1397 <td>APP_STATE_RUNNING</td> 1398 <td>1</td> 1399 <td><p></p></td> 1400 </tr> 1401 1402 <tr> 1403 <td>APP_STATE_EXITED</td> 1404 <td>2</td> 1405 <td><p></p></td> 1406 </tr> 1407 1408 </tbody> 1409 </table> 1410 1411 <h3 id="v1alpha.EventType">EventType</h3> 1412 <p>EventType defines the type of the events that will be received via ListenEvents().</p> 1413 <table class="enum-table"> 1414 <thead> 1415 <tr><td>Name</td><td>Number</td><td>Description</td></tr> 1416 </thead> 1417 <tbody> 1418 1419 <tr> 1420 <td>EVENT_TYPE_UNDEFINED</td> 1421 <td>0</td> 1422 <td><p></p></td> 1423 </tr> 1424 1425 <tr> 1426 <td>EVENT_TYPE_POD_PREPARED</td> 1427 <td>1</td> 1428 <td><p>Pod events.</p></td> 1429 </tr> 1430 1431 <tr> 1432 <td>EVENT_TYPE_POD_PREPARE_ABORTED</td> 1433 <td>2</td> 1434 <td><p></p></td> 1435 </tr> 1436 1437 <tr> 1438 <td>EVENT_TYPE_POD_STARTED</td> 1439 <td>3</td> 1440 <td><p></p></td> 1441 </tr> 1442 1443 <tr> 1444 <td>EVENT_TYPE_POD_EXITED</td> 1445 <td>4</td> 1446 <td><p></p></td> 1447 </tr> 1448 1449 <tr> 1450 <td>EVENT_TYPE_POD_GARBAGE_COLLECTED</td> 1451 <td>5</td> 1452 <td><p></p></td> 1453 </tr> 1454 1455 <tr> 1456 <td>EVENT_TYPE_APP_STARTED</td> 1457 <td>6</td> 1458 <td><p>App events.</p></td> 1459 </tr> 1460 1461 <tr> 1462 <td>EVENT_TYPE_APP_EXITED</td> 1463 <td>7</td> 1464 <td><p>(XXX)yifan: Maybe also return exit code in the event object?</p></td> 1465 </tr> 1466 1467 <tr> 1468 <td>EVENT_TYPE_IMAGE_IMPORTED</td> 1469 <td>8</td> 1470 <td><p>Image events.</p></td> 1471 </tr> 1472 1473 <tr> 1474 <td>EVENT_TYPE_IMAGE_REMOVED</td> 1475 <td>9</td> 1476 <td><p></p></td> 1477 </tr> 1478 1479 </tbody> 1480 </table> 1481 1482 <h3 id="v1alpha.ImageType">ImageType</h3> 1483 <p>ImageType defines the supported image type.</p> 1484 <table class="enum-table"> 1485 <thead> 1486 <tr><td>Name</td><td>Number</td><td>Description</td></tr> 1487 </thead> 1488 <tbody> 1489 1490 <tr> 1491 <td>IMAGE_TYPE_UNDEFINED</td> 1492 <td>0</td> 1493 <td><p></p></td> 1494 </tr> 1495 1496 <tr> 1497 <td>IMAGE_TYPE_APPC</td> 1498 <td>1</td> 1499 <td><p></p></td> 1500 </tr> 1501 1502 <tr> 1503 <td>IMAGE_TYPE_DOCKER</td> 1504 <td>2</td> 1505 <td><p></p></td> 1506 </tr> 1507 1508 <tr> 1509 <td>IMAGE_TYPE_OCI</td> 1510 <td>3</td> 1511 <td><p></p></td> 1512 </tr> 1513 1514 </tbody> 1515 </table> 1516 1517 <h3 id="v1alpha.PodState">PodState</h3> 1518 <p>PodState defines the possible states of the pod.</p><p>See https://github.com/rkt/rkt/blob/master/Documentation/devel/pod-lifecycle.md for a detailed</p><p>explanation of each state.</p> 1519 <table class="enum-table"> 1520 <thead> 1521 <tr><td>Name</td><td>Number</td><td>Description</td></tr> 1522 </thead> 1523 <tbody> 1524 1525 <tr> 1526 <td>POD_STATE_UNDEFINED</td> 1527 <td>0</td> 1528 <td><p></p></td> 1529 </tr> 1530 1531 <tr> 1532 <td>POD_STATE_EMBRYO</td> 1533 <td>1</td> 1534 <td><p>States before the pod is running. 1535 1536 1537 Pod is created, ready to entering 'preparing' state.</p></td> 1538 </tr> 1539 1540 <tr> 1541 <td>POD_STATE_PREPARING</td> 1542 <td>2</td> 1543 <td><p>Pod is being prepared. On success it will become 'prepared', otherwise it will become 'aborted prepared'.</p></td> 1544 </tr> 1545 1546 <tr> 1547 <td>POD_STATE_PREPARED</td> 1548 <td>3</td> 1549 <td><p>Pod has been successfully prepared, ready to enter 'running' state. it can also enter 'deleting' if it's garbage collected before running.</p></td> 1550 </tr> 1551 1552 <tr> 1553 <td>POD_STATE_RUNNING</td> 1554 <td>4</td> 1555 <td><p>State that indicates the pod is running. 1556 1557 1558 Pod is running, when it exits, it will become 'exited'.</p></td> 1559 </tr> 1560 1561 <tr> 1562 <td>POD_STATE_ABORTED_PREPARE</td> 1563 <td>5</td> 1564 <td><p>States that indicates the pod is exited, and will never run. 1565 1566 1567 Pod failed to prepare, it will only be garbage collected and will never run again.</p></td> 1568 </tr> 1569 1570 <tr> 1571 <td>POD_STATE_EXITED</td> 1572 <td>6</td> 1573 <td><p>Pod has exited, it now can be garbage collected.</p></td> 1574 </tr> 1575 1576 <tr> 1577 <td>POD_STATE_DELETING</td> 1578 <td>7</td> 1579 <td><p>Pod is being garbage collected, after that it will enter 'garbage' state.</p></td> 1580 </tr> 1581 1582 <tr> 1583 <td>POD_STATE_GARBAGE</td> 1584 <td>8</td> 1585 <td><p>Pod is marked as garbage collected, it no longer exists on the machine.</p></td> 1586 </tr> 1587 1588 </tbody> 1589 </table> 1590 1591 1592 1593 1594 1595 <h3 id="v1alpha.PublicAPI">PublicAPI</h3> 1596 <p>PublicAPI defines the read-only APIs that will be supported.</p><p>These will be handled over TCP sockets.</p> 1597 <table class="enum-table"> 1598 <thead> 1599 <tr><td>Method Name</td><td>Request Type</td><td>Response Type</td><td>Description</td></tr> 1600 </thead> 1601 <tbody> 1602 1603 <tr> 1604 <td>GetInfo</td> 1605 <td><a href="#v1alpha.GetInfoRequest">GetInfoRequest</a></td> 1606 <td><a href="#v1alpha.GetInfoResponse">GetInfoResponse</a></td> 1607 <td><p>GetInfo gets the rkt's information on the machine.</p></td> 1608 </tr> 1609 1610 <tr> 1611 <td>ListPods</td> 1612 <td><a href="#v1alpha.ListPodsRequest">ListPodsRequest</a></td> 1613 <td><a href="#v1alpha.ListPodsResponse">ListPodsResponse</a></td> 1614 <td><p>ListPods lists rkt pods on the machine.</p></td> 1615 </tr> 1616 1617 <tr> 1618 <td>InspectPod</td> 1619 <td><a href="#v1alpha.InspectPodRequest">InspectPodRequest</a></td> 1620 <td><a href="#v1alpha.InspectPodResponse">InspectPodResponse</a></td> 1621 <td><p>InspectPod gets detailed pod information of the specified pod.</p></td> 1622 </tr> 1623 1624 <tr> 1625 <td>ListImages</td> 1626 <td><a href="#v1alpha.ListImagesRequest">ListImagesRequest</a></td> 1627 <td><a href="#v1alpha.ListImagesResponse">ListImagesResponse</a></td> 1628 <td><p>ListImages lists the images on the machine.</p></td> 1629 </tr> 1630 1631 <tr> 1632 <td>InspectImage</td> 1633 <td><a href="#v1alpha.InspectImageRequest">InspectImageRequest</a></td> 1634 <td><a href="#v1alpha.InspectImageResponse">InspectImageResponse</a></td> 1635 <td><p>InspectImage gets the detailed image information of the specified image.</p></td> 1636 </tr> 1637 1638 <tr> 1639 <td>ListenEvents</td> 1640 <td><a href="#v1alpha.ListenEventsRequest">ListenEventsRequest</a></td> 1641 <td><a href="#v1alpha.ListenEventsResponse">ListenEventsResponse</a></td> 1642 <td><p>ListenEvents listens for the events, it will return a response stream 1643 that will contain event objects.</p></td> 1644 </tr> 1645 1646 <tr> 1647 <td>GetLogs</td> 1648 <td><a href="#v1alpha.GetLogsRequest">GetLogsRequest</a></td> 1649 <td><a href="#v1alpha.GetLogsResponse">GetLogsResponse</a></td> 1650 <td><p>GetLogs gets the logs for a pod, if the app is also specified, then only the logs 1651 of the app will be returned. 1652 1653 If 'follow' in the 'GetLogsRequest' is set to 'true', then the response stream 1654 will not be closed after the first response, the future logs will be sent via 1655 the stream.</p></td> 1656 </tr> 1657 1658 </tbody> 1659 </table> 1660 1661 1662 1663 <h2 id="scalar-value-types">Scalar Value Types</h2> 1664 <table class="scalar-value-types-table"> 1665 <thead> 1666 <tr><td>.proto Type</td><td>Notes</td><td>C++ Type</td><td>Java Type</td><td>Python Type</td></tr> 1667 </thead> 1668 <tbody> 1669 1670 <tr id="double"> 1671 <td>double</td> 1672 <td></td> 1673 <td>double</td> 1674 <td>double</td> 1675 <td>float</td> 1676 </tr> 1677 1678 <tr id="float"> 1679 <td>float</td> 1680 <td></td> 1681 <td>float</td> 1682 <td>float</td> 1683 <td>float</td> 1684 </tr> 1685 1686 <tr id="int32"> 1687 <td>int32</td> 1688 <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.</td> 1689 <td>int32</td> 1690 <td>int</td> 1691 <td>int</td> 1692 </tr> 1693 1694 <tr id="int64"> 1695 <td>int64</td> 1696 <td>Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.</td> 1697 <td>int64</td> 1698 <td>long</td> 1699 <td>int/long</td> 1700 </tr> 1701 1702 <tr id="uint32"> 1703 <td>uint32</td> 1704 <td>Uses variable-length encoding.</td> 1705 <td>uint32</td> 1706 <td>int</td> 1707 <td>int/long</td> 1708 </tr> 1709 1710 <tr id="uint64"> 1711 <td>uint64</td> 1712 <td>Uses variable-length encoding.</td> 1713 <td>uint64</td> 1714 <td>long</td> 1715 <td>int/long</td> 1716 </tr> 1717 1718 <tr id="sint32"> 1719 <td>sint32</td> 1720 <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.</td> 1721 <td>int32</td> 1722 <td>int</td> 1723 <td>int</td> 1724 </tr> 1725 1726 <tr id="sint64"> 1727 <td>sint64</td> 1728 <td>Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.</td> 1729 <td>int64</td> 1730 <td>long</td> 1731 <td>int/long</td> 1732 </tr> 1733 1734 <tr id="fixed32"> 1735 <td>fixed32</td> 1736 <td>Always four bytes. More efficient than uint32 if values are often greater than 2^28.</td> 1737 <td>uint32</td> 1738 <td>int</td> 1739 <td>int</td> 1740 </tr> 1741 1742 <tr id="fixed64"> 1743 <td>fixed64</td> 1744 <td>Always eight bytes. More efficient than uint64 if values are often greater than 2^56.</td> 1745 <td>uint64</td> 1746 <td>long</td> 1747 <td>int/long</td> 1748 </tr> 1749 1750 <tr id="sfixed32"> 1751 <td>sfixed32</td> 1752 <td>Always four bytes.</td> 1753 <td>int32</td> 1754 <td>int</td> 1755 <td>int</td> 1756 </tr> 1757 1758 <tr id="sfixed64"> 1759 <td>sfixed64</td> 1760 <td>Always eight bytes.</td> 1761 <td>int64</td> 1762 <td>long</td> 1763 <td>int/long</td> 1764 </tr> 1765 1766 <tr id="bool"> 1767 <td>bool</td> 1768 <td></td> 1769 <td>bool</td> 1770 <td>boolean</td> 1771 <td>boolean</td> 1772 </tr> 1773 1774 <tr id="string"> 1775 <td>string</td> 1776 <td>A string must always contain UTF-8 encoded or 7-bit ASCII text.</td> 1777 <td>string</td> 1778 <td>String</td> 1779 <td>str/unicode</td> 1780 </tr> 1781 1782 <tr id="bytes"> 1783 <td>bytes</td> 1784 <td>May contain any arbitrary sequence of bytes.</td> 1785 <td>string</td> 1786 <td>ByteString</td> 1787 <td>str</td> 1788 </tr> 1789 1790 </tbody> 1791 </table> 1792 </body> 1793 </html> 1794