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
// This file is @generated by prost-build.
/// Describes a worker, which is a list of one or more devices and the
/// connections between them. A device could be a computer, a phone, or even an
/// accelerator like a GPU; it's up to the farm administrator to decide how to
/// model their farm. For example, if a farm only has one type of GPU, the GPU
/// could be modelled as a "has_gpu" property on its host computer; if it has
/// many subproperties itself, it might be better to model it as a separate
/// device.
///
/// The first device in the worker is the "primary device" - that is, the device
/// running a bot and which is responsible for actually executing commands. All
/// other devices are considered to be attached devices, and must be controllable
/// by the primary device.
///
/// This message (and all its submessages) can be used in two contexts:
///
/// * Status: sent by the bot to report the current capabilities of the device to
/// allow reservation matching.
/// * Request: sent by a client to request a device with certain capabilities in
/// a reservation.
///
/// Several of the fields in this message have different semantics depending on
/// which of which of these contexts it is used. These semantics are described
/// below.
///
/// Several messages in Worker and its submessages have the concept of keys and
/// values, such as `Worker.Property` and `Device.Property`. All keys are simple
/// strings, but certain keys are "standard" keys and should be broadly supported
/// across farms and implementations; these are listed below each relevant
/// message. Bot implementations or farm admins may add *additional* keys, but
/// these SHOULD all begin with an underscore so they do not conflict with
/// standard keys that may be added in the future.
///
/// Keys are not context sensitive.
///
/// See <http://goo.gl/NurY8g> for more information on the Worker message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Worker {
/// A list of devices; the first device is the primary device. See the `Device`
/// message for more information.
#[prost(message, repeated, tag = "1")]
pub devices: ::prost::alloc::vec::Vec<Device>,
/// A worker may contain "global" properties. For example, certain machines
/// might be reserved for certain types of jobs, like short-running compilation
/// versus long-running integration tests. This property is known as a "pool"
/// and is not related to any one device within the worker; rather, it applies
/// to the worker as a whole.
///
/// The behaviour of repeated keys is identical to that of Device.Property.
#[prost(message, repeated, tag = "2")]
pub properties: ::prost::alloc::vec::Vec<worker::Property>,
/// Bots can be configured in certain ways when accepting leases. For example,
/// many leases are executed inside a Docker container. To support this, the
/// bot needs to be able to report that it has Docker installed (and knows how
/// to execute something inside a container), and the task submitter needs to
/// specify which image should be used to start the container. Similarly, a
/// lease may be able to run as one of several users on the worker; in such
/// cases, the bot needs to report what users are available, and the submitter
/// needs to choose one.
///
/// Therefore, when this message is reported by the bot to the service, each
/// key represents a *type* of configuration that the bot knows how to set,
/// while each *value* represents a legal value for that configuration (the
/// empty string is interpretted as a wildcard, such as for Docker images).
/// When this message is sent by the server to the bot in the context of a
/// lease, it represents a command to the bot to apply the setting. Keys may
/// be repeated during reporting but not in a lease.
#[prost(message, repeated, tag = "3")]
pub configs: ::prost::alloc::vec::Vec<worker::Config>,
}
/// Nested message and enum types in `Worker`.
pub mod worker {
/// A global property; see the `properties` field for more information.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Property {
/// For general information on keys, see the documentation to `Worker`.
///
/// The current set of standard keys are:
///
/// * pool: different workers can be reserved for different purposes. For
/// example, an admin might want to segregate long-running integration tests
/// from short-running unit tests, so unit tests will always get some
/// throughput. To support this, the server can assign different values for
/// `pool` (such as "itest" and "utest") to different workers, and then have
/// jobs request workers from those pools.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// The property's value.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
/// A configuration request or report; see the `configs` field for more
/// information.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Config {
/// For general information on keys, see the documentation to `Worker`.
///
/// The current set of standard keys are:
///
/// * DockerImage: the image of the container. When being reported by the
/// bot, the empty value should always be included if the bot is able to pull
/// its own images; the bot may optionally *also* report images that are
/// present in its cache. When being requested in a lease, the value is the
/// URI of the image (eg `gcr.io/user/image@sha256:hash`).
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// The configuration's value.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
}
/// Any device, including computers, phones, accelerators (e.g. GPUs), etc. All
/// names must be unique.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Device {
/// The handle can be thought of as the "name" of the device, and must be
/// unique within a Worker.
///
/// In the Status context, the handle should be some human-understandable name,
/// perhaps corresponding to a label physically written on the device to make
/// it easy to locate. In the Request context, the name should be the
/// *logical* name expected by the task. The bot is responsible for mapping the
/// logical name expected by the task to a machine-readable name that the task
/// can actually use, such as a USB address. The method by which this mapping
/// is communicated to the task is not covered in this API.
#[prost(string, tag = "1")]
pub handle: ::prost::alloc::string::String,
/// Properties of this device that don't change based on the tasks that are
/// running on it, e.g. OS, CPU architecture, etc.
///
/// Keys may be repeated, and have the following interpretation:
///
/// * Status context: the device can support *any* the listed values. For
/// example, an "ISA" property might include "x86", "x86-64" and "sse4".
///
/// * Request context: the device *must* support *all* of the listed values.
#[prost(message, repeated, tag = "2")]
pub properties: ::prost::alloc::vec::Vec<device::Property>,
}
/// Nested message and enum types in `Device`.
pub mod device {
/// A device property; see `properties` for more information.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Property {
/// For general information on keys, see the documentation to `Worker`.
///
/// The current set of standard keys are:
///
/// * os: a human-readable description of the OS. Examples include `linux`,
/// `ubuntu` and `ubuntu 14.04` (note that a bot may advertise itself as more
/// than one). This will be replaced in the future by more well-structured
/// keys and values to represent OS variants.
///
/// * has-docker: "true" if the bot has Docker installed. This will be
/// replaced in the future by a more structured message for Docker support.
#[prost(string, tag = "1")]
pub key: ::prost::alloc::string::String,
/// The property's value.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
}
/// A bot session represents the state of a bot while in continuous contact with
/// the server for a period of time. The session includes information about the
/// worker - that is, the *worker* (the physical or virtual hardware) is
/// considered to be a property of the bot (the software agent running on that
/// hardware), which is the reverse of real life, but more natural from the point
/// of the view of this API, which communicates solely with the bot and not
/// directly with the underlying worker.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct BotSession {
/// The bot session name, as selected by the server. Output only during a call
/// to CreateBotSession.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// A unique bot ID within the farm used to persistently identify this bot over
/// time (i.e., over multiple sessions). This ID must be unique within a
/// farm. Typically, the bot ID will be the same as the name of the primary
/// device in the worker (e.g., what you'd get from typing `uname -n` on *nix),
/// but this is not required since a single device may allow multiple bots to
/// run on it, each with access to different resources. What is important is
/// that this ID is meaningful to humans, who might need to hunt a physical
/// machine down to fix it.
///
/// When CreateBotSession is successfully called with a bot_id, all prior
/// sessions with the same ID are invalidated. If a bot attempts to update an
/// invalid session, the server must reject that request, and may also
/// quarantine the other bot with the same bot IDs (ie, stop sending it new
/// leases and alert an admin).
#[prost(string, tag = "2")]
pub bot_id: ::prost::alloc::string::String,
/// The status of the bot. This must be populated in every call to
/// UpdateBotSession.
#[prost(enumeration = "BotStatus", tag = "3")]
pub status: i32,
/// A description of the worker hosting this bot. The Worker message is used
/// here in the Status context (see Worker for more information). If multiple
/// bots are running on the worker, this field should only describe the
/// resources accessible from this bot.
///
/// During the call to CreateBotSession, the server may make arbitrary changes
/// to the worker's `server_properties` field (see that field for more
/// information). Otherwise, this field is input-only.
#[prost(message, optional, tag = "4")]
pub worker: ::core::option::Option<Worker>,
/// A list of all leases that are a part of this session. See the Lease message
/// for details.
#[prost(message, repeated, tag = "5")]
pub leases: ::prost::alloc::vec::Vec<Lease>,
/// The time at which this bot session will expire, unless the bot calls
/// UpdateBotSession again. Output only.
#[prost(message, optional, tag = "6")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
/// The version of the bot code currently running. The server may use this
/// information to issue an admin action to tell the bot to update itself.
#[prost(string, tag = "7")]
pub version: ::prost::alloc::string::String,
}
/// A Lease is a lease that the scheduler has assigned to this bot. If the bot
/// notices (by UpdateBotSession) that it has any leases in the PENDING state, it
/// should call UpdateBotSession to put the leases into the ACTIVE state and
/// start executing their assignments.
///
/// All fields in this message are output-only, *except* the `state` and `status`
/// fields. Note that repeated fields can only be updated as a unit, so on every
/// update the bot must provide an update for *all* the leases the server expects
/// it to report on.
///
/// The scheduler *should* ensure that all leases scheduled to a bot can actually
/// be accepted, but race conditions may occur. In such cases, the bot should
/// attempt to accept the leases in the order they are listed by the server, to
/// allow the server to control priorities.
///
/// The server will remove COMPLETED leases from time to time, after which the
/// bot shouldn't report on them any more (the server will ignore superfluous
/// COMPLETED records).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Lease {
/// A short string uniquely identifing the lease within this bot session.
#[prost(string, tag = "7")]
pub id: ::prost::alloc::string::String,
/// The actual work to be performed, if any. May be omitted by the server if
/// the lease is not in the `PENDING` state. The message must be meaningful to
/// the bot. Output only (must only be set by the server).
#[prost(message, optional, tag = "8")]
pub payload: ::core::option::Option<::prost_types::Any>,
/// Any result the bot wishes to provide about the lease. Must not be changed
/// after the first call with the lease in the `COMPLETED` or `CANCELLED`
/// state. Input only (must only be set by the bot, will not be echoed by the
/// server).
#[prost(message, optional, tag = "9")]
pub result: ::core::option::Option<::prost_types::Any>,
/// The state of the lease. See LeaseState for more information.
#[prost(enumeration = "LeaseState", tag = "2")]
pub state: i32,
/// The final status of the lease (should be populated by the bot if the state
/// is completed). This is the status of the lease, not of any task represented
/// by the lease. For example, if the bot could not accept the lease because it
/// asked for some resource the bot didn't have, this status will be
/// FAILED_PRECONDITION. But if the assignment in the lease didn't execute
/// correctly, this field will be `OK` while the failure of the assignment must
/// communicated via the `result` field.
#[prost(message, optional, tag = "3")]
pub status: ::core::option::Option<super::super::super::rpc::Status>,
/// The requirements that are being claimed by this lease. This field may be
/// omitted by the server if the lease is not pending.
#[prost(message, optional, tag = "4")]
pub requirements: ::core::option::Option<Worker>,
/// The time at which this lease expires. The server *may* extend this over
/// time, but due to race conditions, the bot is not *required* to respect any
/// expiry date except the first one.
#[prost(message, optional, tag = "5")]
pub expire_time: ::core::option::Option<::prost_types::Timestamp>,
/// DEPRECATED. The assignment should be provided to the bot via the `payload`
/// field. Clients that wish to use a simple name (such as a queue of work
/// provided elsewhere) should define a custom message type and encode it into
/// `payload`.
#[deprecated]
#[prost(string, tag = "1")]
pub assignment: ::prost::alloc::string::String,
/// DEPRECATED. Use `payload` instead.
#[deprecated]
#[prost(message, optional, tag = "6")]
pub inline_assignment: ::core::option::Option<::prost_types::Any>,
}
/// AdminTemp is a prelimiary set of administration tasks. It's called "Temp"
/// because we do not yet know the best way to represent admin tasks; it's
/// possible that this will be entirely replaced in later versions of this API.
/// If this message proves to be sufficient, it will be renamed in the alpha or
/// beta release of this API.
///
/// This message (suitably marshalled into a protobuf.Any) can be used as the
/// inline_assignment field in a lease; the lease assignment field should simply
/// be `"admin"` in these cases.
///
/// This message is heavily based on Swarming administration tasks from the LUCI
/// project (<http://github.com/luci/luci-py/appengine/swarming>).
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct AdminTemp {
/// The admin action; see `Command` for legal values.
#[prost(enumeration = "admin_temp::Command", tag = "1")]
pub command: i32,
/// The argument to the admin action; see `Command` for semantics.
#[prost(string, tag = "2")]
pub arg: ::prost::alloc::string::String,
}
/// Nested message and enum types in `AdminTemp`.
pub mod admin_temp {
/// Possible administration actions.
#[derive(
Clone,
Copy,
Debug,
PartialEq,
Eq,
Hash,
PartialOrd,
Ord,
::prost::Enumeration
)]
#[repr(i32)]
pub enum Command {
/// Illegal value.
Unspecified = 0,
/// Download and run a new version of the bot. `arg` will be a resource
/// accessible via `ByteStream.Read` to obtain the new bot code.
BotUpdate = 1,
/// Restart the bot without downloading a new version. `arg` will be a
/// message to log.
BotRestart = 2,
/// Shut down the bot. `arg` will be a task resource name (similar to those
/// in tasks.proto) that the bot can use to tell the server that it is
/// terminating.
BotTerminate = 3,
/// Restart the host computer. `arg` will be a message to log.
HostRestart = 4,
}
impl Command {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
Command::Unspecified => "UNSPECIFIED",
Command::BotUpdate => "BOT_UPDATE",
Command::BotRestart => "BOT_RESTART",
Command::BotTerminate => "BOT_TERMINATE",
Command::HostRestart => "HOST_RESTART",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"UNSPECIFIED" => Some(Self::Unspecified),
"BOT_UPDATE" => Some(Self::BotUpdate),
"BOT_RESTART" => Some(Self::BotRestart),
"BOT_TERMINATE" => Some(Self::BotTerminate),
"HOST_RESTART" => Some(Self::HostRestart),
_ => None,
}
}
}
}
/// Request message for CreateBotSession.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CreateBotSessionRequest {
/// Required. The farm resource.
#[prost(string, tag = "1")]
pub parent: ::prost::alloc::string::String,
/// Required. The bot session to create. Server-assigned fields like name must
/// be unset.
#[prost(message, optional, tag = "2")]
pub bot_session: ::core::option::Option<BotSession>,
}
/// Request message for UpdateBotSession.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct UpdateBotSessionRequest {
/// Required. The bot session name. Must match bot_session.name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// Required. The bot session resource to update.
#[prost(message, optional, tag = "2")]
pub bot_session: ::core::option::Option<BotSession>,
/// Required. The fields on the bot that should be updated. See the BotSession
/// resource for which fields are updatable by which caller.
#[prost(message, optional, tag = "3")]
pub update_mask: ::core::option::Option<::prost_types::FieldMask>,
}
/// A coarse description of the status of the bot that the server uses to
/// determine whether to assign the bot new leases.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum BotStatus {
/// Default value; do not use.
Unspecified = 0,
/// The bot is healthy, and will accept leases as normal.
Ok = 1,
/// The bot is unhealthy and will not accept new leases. For example, the bot
/// may have detected that available disk space is too low. This situation may
/// resolve itself, but will typically require human intervention.
Unhealthy = 2,
/// The bot has been asked to reboot the host. The bot will not accept new
/// leases; once all leases are complete, this session will no longer be
/// updated but the bot will be expected to establish a new session after the
/// reboot completes.
HostRebooting = 3,
/// The bot has been asked to shut down. As with HOST_REBOOTING, once all
/// leases are completed, the session will no longer be updated and the bot
/// will not be expected to establish a new session.
///
/// Bots are typically only asked to shut down if its host computer will be
/// modified in some way, such as deleting a VM.
BotTerminating = 4,
/// The bot is initializing and is not ready to accept leases.
Initializing = 5,
}
impl BotStatus {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
BotStatus::Unspecified => "BOT_STATUS_UNSPECIFIED",
BotStatus::Ok => "OK",
BotStatus::Unhealthy => "UNHEALTHY",
BotStatus::HostRebooting => "HOST_REBOOTING",
BotStatus::BotTerminating => "BOT_TERMINATING",
BotStatus::Initializing => "INITIALIZING",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"BOT_STATUS_UNSPECIFIED" => Some(Self::Unspecified),
"OK" => Some(Self::Ok),
"UNHEALTHY" => Some(Self::Unhealthy),
"HOST_REBOOTING" => Some(Self::HostRebooting),
"BOT_TERMINATING" => Some(Self::BotTerminating),
"INITIALIZING" => Some(Self::Initializing),
_ => None,
}
}
}
/// The state of the lease. All leases start in the PENDING state. A bot can
/// change PENDING to ACTIVE or (in the case of an error) COMPLETED, or from
/// ACTIVE to COMPLETED. The server can change PENDING or ACTIVE to CANCELLED if
/// it wants the bot to release its resources - for example, if the bot needs to
/// be quarantined (it's producing bad output) or a cell needs to be drained.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, PartialOrd, Ord, ::prost::Enumeration)]
#[repr(i32)]
pub enum LeaseState {
/// Default value; do not use.
Unspecified = 0,
/// Pending: the server expects the bot to accept this lease. This may only be
/// set by the server.
Pending = 1,
/// Active: the bot has accepted this lease. This may only be set by the bot.
Active = 2,
/// Completed: the bot is no longer leased. This may only be set by the bot,
/// and the status field must be populated iff the state is COMPLETED.
Completed = 4,
/// Cancelled: The bot should immediately release all resources associated with
/// the lease. This may only be set by the server.
Cancelled = 5,
}
impl LeaseState {
/// String value of the enum field names used in the ProtoBuf definition.
///
/// The values are not transformed in any way and thus are considered stable
/// (if the ProtoBuf definition does not change) and safe for programmatic use.
pub fn as_str_name(&self) -> &'static str {
match self {
LeaseState::Unspecified => "LEASE_STATE_UNSPECIFIED",
LeaseState::Pending => "PENDING",
LeaseState::Active => "ACTIVE",
LeaseState::Completed => "COMPLETED",
LeaseState::Cancelled => "CANCELLED",
}
}
/// Creates an enum from field names used in the ProtoBuf definition.
pub fn from_str_name(value: &str) -> ::core::option::Option<Self> {
match value {
"LEASE_STATE_UNSPECIFIED" => Some(Self::Unspecified),
"PENDING" => Some(Self::Pending),
"ACTIVE" => Some(Self::Active),
"COMPLETED" => Some(Self::Completed),
"CANCELLED" => Some(Self::Cancelled),
_ => None,
}
}
}
/// Generated client implementations.
pub mod bots_client {
#![allow(unused_variables, dead_code, missing_docs, clippy::let_unit_value)]
use tonic::codegen::*;
use tonic::codegen::http::Uri;
/// Design doc: https://goo.gl/oojM5H
///
/// Loosely speaking, the Bots interface monitors a collection of workers (think
/// of them as "computers" for a moment). This collection is known as a "farm,"
/// and its purpose is to perform work on behalf of a client.
///
/// Each worker runs a small program known as a "bot" that allows it to be
/// controlled by the server. This interface contains only methods that are
/// called by the bots themselves; admin functionality is out of scope for this
/// interface.
///
/// More precisely, we use the term "worker" to refer to the physical "thing"
/// running the bot. We use the term "worker," and not "machine" or "computer,"
/// since a worker may consist of more than one machine - e.g., a computer with
/// multiple attached devices, or even a cluster of computers, with only one of
/// them running the bot. Conversely, a single machine may host several bots, in
/// which case each bot has a "worker" corresponding to the slice of the machine
/// being managed by that bot.
///
/// The main resource in the Bots interface is not, surprisingly, a Bot - it is a
/// BotSession, which represents a period of time in which a bot is in continuous
/// contact with the server (see the BotSession message for more information).
/// The parent of a bot session can be thought of as an instance of a farm. That
/// is, one endpoint may be able to manage many farms for many users. For
/// example, for a farm managed through GCP, the parent resource will typically
/// take the form "projects/{project_id}". This is referred to below as "the farm
/// resource."
#[derive(Debug, Clone)]
pub struct BotsClient<T> {
inner: tonic::client::Grpc<T>,
}
impl<T> BotsClient<T>
where
T: tonic::client::GrpcService<tonic::body::BoxBody>,
T::Error: Into<StdError>,
T::ResponseBody: Body<Data = Bytes> + std::marker::Send + 'static,
<T::ResponseBody as Body>::Error: Into<StdError> + std::marker::Send,
{
pub fn new(inner: T) -> Self {
let inner = tonic::client::Grpc::new(inner);
Self { inner }
}
pub fn with_origin(inner: T, origin: Uri) -> Self {
let inner = tonic::client::Grpc::with_origin(inner, origin);
Self { inner }
}
pub fn with_interceptor<F>(
inner: T,
interceptor: F,
) -> BotsClient<InterceptedService<T, F>>
where
F: tonic::service::Interceptor,
T::ResponseBody: Default,
T: tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
Response = http::Response<
<T as tonic::client::GrpcService<tonic::body::BoxBody>>::ResponseBody,
>,
>,
<T as tonic::codegen::Service<
http::Request<tonic::body::BoxBody>,
>>::Error: Into<StdError> + std::marker::Send + std::marker::Sync,
{
BotsClient::new(InterceptedService::new(inner, interceptor))
}
/// Compress requests with the given encoding.
///
/// This requires the server to support it otherwise it might respond with an
/// error.
#[must_use]
pub fn send_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.send_compressed(encoding);
self
}
/// Enable decompressing responses.
#[must_use]
pub fn accept_compressed(mut self, encoding: CompressionEncoding) -> Self {
self.inner = self.inner.accept_compressed(encoding);
self
}
/// Limits the maximum size of a decoded message.
///
/// Default: `4MB`
#[must_use]
pub fn max_decoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_decoding_message_size(limit);
self
}
/// Limits the maximum size of an encoded message.
///
/// Default: `usize::MAX`
#[must_use]
pub fn max_encoding_message_size(mut self, limit: usize) -> Self {
self.inner = self.inner.max_encoding_message_size(limit);
self
}
/// CreateBotSession is called when the bot first joins the farm, and
/// establishes a session ID to ensure that multiple machines do not register
/// using the same name accidentally.
pub async fn create_bot_session(
&mut self,
request: impl tonic::IntoRequest<super::CreateBotSessionRequest>,
) -> std::result::Result<tonic::Response<super::BotSession>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.devtools.remoteworkers.v1test2.Bots/CreateBotSession",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.devtools.remoteworkers.v1test2.Bots",
"CreateBotSession",
),
);
self.inner.unary(req, path, codec).await
}
/// UpdateBotSession must be called periodically by the bot (on a schedule
/// determined by the server) to let the server know about its status, and to
/// pick up new lease requests from the server.
pub async fn update_bot_session(
&mut self,
request: impl tonic::IntoRequest<super::UpdateBotSessionRequest>,
) -> std::result::Result<tonic::Response<super::BotSession>, tonic::Status> {
self.inner
.ready()
.await
.map_err(|e| {
tonic::Status::new(
tonic::Code::Unknown,
format!("Service was not ready: {}", e.into()),
)
})?;
let codec = tonic::codec::ProstCodec::default();
let path = http::uri::PathAndQuery::from_static(
"/google.devtools.remoteworkers.v1test2.Bots/UpdateBotSession",
);
let mut req = request.into_request();
req.extensions_mut()
.insert(
GrpcMethod::new(
"google.devtools.remoteworkers.v1test2.Bots",
"UpdateBotSession",
),
);
self.inner.unary(req, path, codec).await
}
}
}
/// Describes a shell-style task to execute, suitable for providing as the Bots
/// interface's `Lease.payload` field.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandTask {
/// The inputs to the task.
#[prost(message, optional, tag = "1")]
pub inputs: ::core::option::Option<command_task::Inputs>,
/// The expected outputs from the task.
#[prost(message, optional, tag = "4")]
pub expected_outputs: ::core::option::Option<command_task::Outputs>,
/// The timeouts of this task.
#[prost(message, optional, tag = "5")]
pub timeouts: ::core::option::Option<command_task::Timeouts>,
}
/// Nested message and enum types in `CommandTask`.
pub mod command_task {
/// Describes the inputs to a shell-style task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Inputs {
/// The command itself to run (e.g., argv).
///
/// This field should be passed directly to the underlying operating system,
/// and so it must be sensible to that operating system. For example, on
/// Windows, the first argument might be "C:\Windows\System32\ping.exe" -
/// that is, using drive letters and backslashes. A command for a *nix
/// system, on the other hand, would use forward slashes.
///
/// All other fields in the RWAPI must consistently use forward slashes,
/// since those fields may be interpretted by both the service and the bot.
#[prost(string, repeated, tag = "1")]
pub arguments: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The input filesystem to be set up prior to the task beginning. The
/// contents should be a repeated set of FileMetadata messages though other
/// formats are allowed if better for the implementation (eg, a LUCI-style
/// .isolated file).
///
/// This field is repeated since implementations might want to cache the
/// metadata, in which case it may be useful to break up portions of the
/// filesystem that change frequently (eg, specific input files) from those
/// that don't (eg, standard header files).
#[prost(message, repeated, tag = "2")]
pub files: ::prost::alloc::vec::Vec<super::Digest>,
/// Inline contents for blobs expected to be needed by the bot to execute the
/// task. For example, contents of entries in `files` or blobs that are
/// indirectly referenced by an entry there.
///
/// The bot should check against this list before downloading required task
/// inputs to reduce the number of communications between itself and the
/// remote CAS server.
#[prost(message, repeated, tag = "4")]
pub inline_blobs: ::prost::alloc::vec::Vec<super::Blob>,
/// All environment variables required by the task.
#[prost(message, repeated, tag = "3")]
pub environment_variables: ::prost::alloc::vec::Vec<inputs::EnvironmentVariable>,
/// Directory from which a command is executed. It is a relative directory
/// with respect to the bot's working directory (i.e., "./"). If it is
/// non-empty, then it must exist under "./". Otherwise, "./" will be used.
#[prost(string, tag = "5")]
pub working_directory: ::prost::alloc::string::String,
}
/// Nested message and enum types in `Inputs`.
pub mod inputs {
/// An environment variable required by this task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct EnvironmentVariable {
/// The envvar name.
#[prost(string, tag = "1")]
pub name: ::prost::alloc::string::String,
/// The envvar value.
#[prost(string, tag = "2")]
pub value: ::prost::alloc::string::String,
}
}
/// Describes the expected outputs of the command.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Outputs {
/// A list of expected files, relative to the execution root. All paths
/// MUST be delimited by forward slashes.
#[prost(string, repeated, tag = "1")]
pub files: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// A list of expected directories, relative to the execution root. All paths
/// MUST be delimited by forward slashes.
#[prost(string, repeated, tag = "2")]
pub directories: ::prost::alloc::vec::Vec<::prost::alloc::string::String>,
/// The destination to which any stdout should be sent. The method by which
/// the bot should send the stream contents to that destination is not
/// defined in this API. As examples, the destination could be a file
/// referenced in the `files` field in this message, or it could be a URI
/// that must be written via the ByteStream API.
#[prost(string, tag = "3")]
pub stdout_destination: ::prost::alloc::string::String,
/// The destination to which any stderr should be sent. The method by which
/// the bot should send the stream contents to that destination is not
/// defined in this API. As examples, the destination could be a file
/// referenced in the `files` field in this message, or it could be a URI
/// that must be written via the ByteStream API.
#[prost(string, tag = "4")]
pub stderr_destination: ::prost::alloc::string::String,
}
/// Describes the timeouts associated with this task.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct Timeouts {
/// This specifies the maximum time that the task can run, excluding the
/// time required to download inputs or upload outputs. That is, the worker
/// will terminate the task if it runs longer than this.
#[prost(message, optional, tag = "1")]
pub execution: ::core::option::Option<::prost_types::Duration>,
/// This specifies the maximum amount of time the task can be idle - that is,
/// go without generating some output in either stdout or stderr. If the
/// process is silent for more than the specified time, the worker will
/// terminate the task.
#[prost(message, optional, tag = "2")]
pub idle: ::core::option::Option<::prost_types::Duration>,
/// If the execution or IO timeouts are exceeded, the worker will try to
/// gracefully terminate the task and return any existing logs. However,
/// tasks may be hard-frozen in which case this process will fail. This
/// timeout specifies how long to wait for a terminated task to shut down
/// gracefully (e.g. via SIGTERM) before we bring down the hammer (e.g.
/// SIGKILL on *nix, CTRL_BREAK_EVENT on Windows).
#[prost(message, optional, tag = "3")]
pub shutdown: ::core::option::Option<::prost_types::Duration>,
}
}
/// DEPRECATED - use CommandResult instead.
/// Describes the actual outputs from the task.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandOutputs {
/// exit_code is only fully reliable if the status' code is OK. If the task
/// exceeded its deadline or was cancelled, the process may still produce an
/// exit code as it is cancelled, and this will be populated, but a successful
/// (zero) is unlikely to be correct unless the status code is OK.
#[prost(int32, tag = "1")]
pub exit_code: i32,
/// The output files. The blob referenced by the digest should contain
/// one of the following (implementation-dependent):
/// * A marshalled DirectoryMetadata of the returned filesystem
/// * A LUCI-style .isolated file
#[prost(message, optional, tag = "2")]
pub outputs: ::core::option::Option<Digest>,
}
/// DEPRECATED - use CommandResult instead.
/// Can be used as part of CompleteRequest.metadata, or are part of a more
/// sophisticated message.
#[derive(Clone, Copy, PartialEq, ::prost::Message)]
pub struct CommandOverhead {
/// The elapsed time between calling Accept and Complete. The server will also
/// have its own idea of what this should be, but this excludes the overhead of
/// the RPCs and the bot response time.
#[prost(message, optional, tag = "1")]
pub duration: ::core::option::Option<::prost_types::Duration>,
/// The amount of time *not* spent executing the command (ie
/// uploading/downloading files).
#[prost(message, optional, tag = "2")]
pub overhead: ::core::option::Option<::prost_types::Duration>,
}
/// All information about the execution of a command, suitable for providing as
/// the Bots interface's `Lease.result` field.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct CommandResult {
/// An overall status for the command. For example, if the command timed out,
/// this might have a code of DEADLINE_EXCEEDED; if it was killed by the OS for
/// memory exhaustion, it might have a code of RESOURCE_EXHAUSTED.
#[prost(message, optional, tag = "1")]
pub status: ::core::option::Option<super::super::super::rpc::Status>,
/// The exit code of the process. An exit code of "0" should only be trusted if
/// `status` has a code of OK (otherwise it may simply be unset).
#[prost(int32, tag = "2")]
pub exit_code: i32,
/// The output files. The blob referenced by the digest should contain
/// one of the following (implementation-dependent):
/// * A marshalled DirectoryMetadata of the returned filesystem
/// * A LUCI-style .isolated file
#[prost(message, optional, tag = "3")]
pub outputs: ::core::option::Option<Digest>,
/// The elapsed time between calling Accept and Complete. The server will also
/// have its own idea of what this should be, but this excludes the overhead of
/// the RPCs and the bot response time.
#[deprecated]
#[prost(message, optional, tag = "4")]
pub duration: ::core::option::Option<::prost_types::Duration>,
/// The amount of time *not* spent executing the command (ie
/// uploading/downloading files).
#[deprecated]
#[prost(message, optional, tag = "5")]
pub overhead: ::core::option::Option<::prost_types::Duration>,
/// Implementation-dependent metadata about the task. Both servers and bots
/// may define messages which can be encoded here; bots are free to provide
/// metadata in multiple formats, and servers are free to choose one or more
/// of the values to process and ignore others. In particular, it is *not*
/// considered an error for the bot to provide the server with a field that it
/// doesn't know about.
#[prost(message, repeated, tag = "6")]
pub metadata: ::prost::alloc::vec::Vec<::prost_types::Any>,
}
/// The metadata for a file. Similar to the equivalent message in the Remote
/// Execution API.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct FileMetadata {
/// The path of this file. If this message is part of the
/// CommandOutputs.outputs fields, the path is relative to the execution root
/// and must correspond to an entry in CommandTask.outputs.files. If this
/// message is part of a Directory message, then the path is relative to the
/// root of that directory. All paths MUST be delimited by forward slashes.
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
/// A pointer to the contents of the file. The method by which a client
/// retrieves the contents from a CAS system is not defined here.
#[prost(message, optional, tag = "2")]
pub digest: ::core::option::Option<Digest>,
/// If the file is small enough, its contents may also or alternatively be
/// listed here.
#[prost(bytes = "bytes", tag = "3")]
pub contents: ::prost::bytes::Bytes,
/// Properties of the file
#[prost(bool, tag = "4")]
pub is_executable: bool,
}
/// The metadata for a directory. Similar to the equivalent message in the Remote
/// Execution API.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct DirectoryMetadata {
/// The path of the directory, as in
/// [FileMetadata.path][google.devtools.remoteworkers.v1test2.FileMetadata.path].
#[prost(string, tag = "1")]
pub path: ::prost::alloc::string::String,
/// A pointer to the contents of the directory, in the form of a marshalled
/// Directory message.
#[prost(message, optional, tag = "2")]
pub digest: ::core::option::Option<Digest>,
}
/// The CommandTask and CommandResult messages assume the existence of a service
/// that can serve blobs of content, identified by a hash and size known as a
/// "digest." The method by which these blobs may be retrieved is not specified
/// here, but a model implementation is in the Remote Execution API's
/// "ContentAddressibleStorage" interface.
///
/// In the context of the RWAPI, a Digest will virtually always refer to the
/// contents of a file or a directory. The latter is represented by the
/// byte-encoded Directory message.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Digest {
/// A string-encoded hash (eg "1a2b3c", not the byte array \[0x1a, 0x2b, 0x3c\])
/// using an implementation-defined hash algorithm (eg SHA-256).
#[prost(string, tag = "1")]
pub hash: ::prost::alloc::string::String,
/// The size of the contents. While this is not strictly required as part of an
/// identifier (after all, any given hash will have exactly one canonical
/// size), it's useful in almost all cases when one might want to send or
/// retrieve blobs of content and is included here for this reason.
#[prost(int64, tag = "2")]
pub size_bytes: i64,
}
/// Describes a blob of binary content with its digest.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Blob {
/// The digest of the blob. This should be verified by the receiver.
#[prost(message, optional, tag = "1")]
pub digest: ::core::option::Option<Digest>,
/// The contents of the blob.
#[prost(bytes = "bytes", tag = "2")]
pub contents: ::prost::bytes::Bytes,
}
/// The contents of a directory. Similar to the equivalent message in the Remote
/// Execution API.
#[derive(Clone, PartialEq, ::prost::Message)]
pub struct Directory {
/// The files in this directory
#[prost(message, repeated, tag = "1")]
pub files: ::prost::alloc::vec::Vec<FileMetadata>,
/// Any subdirectories
#[prost(message, repeated, tag = "2")]
pub directories: ::prost::alloc::vec::Vec<DirectoryMetadata>,
}