1"""Generated message classes for genomics version v1alpha2. 2 3Uploads, processes, queries, and searches Genomics data in the cloud. 4""" 5# NOTE: This file is autogenerated and should not be edited by hand. 6 7from __future__ import absolute_import 8 9from apitools.base.protorpclite import messages as _messages 10from apitools.base.py import encoding 11from apitools.base.py import extra_types 12 13 14package = 'genomics' 15 16 17class CancelOperationRequest(_messages.Message): 18 r"""The request message for Operations.CancelOperation.""" 19 20 21class ComputeEngine(_messages.Message): 22 r"""Describes a Compute Engine resource that is being managed by a running 23 pipeline. 24 25 Fields: 26 diskNames: The names of the disks that were created for this pipeline. 27 instanceName: The instance on which the operation is running. 28 machineType: The machine type of the instance. 29 zone: The availability zone in which the instance resides. 30 """ 31 32 diskNames = _messages.StringField(1, repeated=True) 33 instanceName = _messages.StringField(2) 34 machineType = _messages.StringField(3) 35 zone = _messages.StringField(4) 36 37 38class ContainerKilledEvent(_messages.Message): 39 r"""An event generated when a container is forcibly terminated by the 40 worker. Currently, this only occurs when the container outlives the timeout 41 specified by the user. 42 43 Fields: 44 actionId: The numeric ID of the action that started the container. 45 """ 46 47 actionId = _messages.IntegerField(1, variant=_messages.Variant.INT32) 48 49 50class ContainerStartedEvent(_messages.Message): 51 r"""An event generated when a container starts. 52 53 Messages: 54 PortMappingsValue: The container-to-host port mappings installed for this 55 container. This set will contain any ports exposed using the 56 `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` 57 definition. 58 59 Fields: 60 actionId: The numeric ID of the action that started this container. 61 ipAddress: The public IP address that can be used to connect to the 62 container. This field is only populated when at least one port mapping 63 is present. If the instance was created with a private address, this 64 field will be empty even if port mappings exist. 65 portMappings: The container-to-host port mappings installed for this 66 container. This set will contain any ports exposed using the 67 `PUBLISH_EXPOSED_PORTS` flag as well as any specified in the `Action` 68 definition. 69 """ 70 71 @encoding.MapUnrecognizedFields('additionalProperties') 72 class PortMappingsValue(_messages.Message): 73 r"""The container-to-host port mappings installed for this container. This 74 set will contain any ports exposed using the `PUBLISH_EXPOSED_PORTS` flag 75 as well as any specified in the `Action` definition. 76 77 Messages: 78 AdditionalProperty: An additional property for a PortMappingsValue 79 object. 80 81 Fields: 82 additionalProperties: Additional properties of type PortMappingsValue 83 """ 84 85 class AdditionalProperty(_messages.Message): 86 r"""An additional property for a PortMappingsValue object. 87 88 Fields: 89 key: Name of the additional property. 90 value: A integer attribute. 91 """ 92 93 key = _messages.StringField(1) 94 value = _messages.IntegerField(2, variant=_messages.Variant.INT32) 95 96 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 97 98 actionId = _messages.IntegerField(1, variant=_messages.Variant.INT32) 99 ipAddress = _messages.StringField(2) 100 portMappings = _messages.MessageField('PortMappingsValue', 3) 101 102 103class ContainerStoppedEvent(_messages.Message): 104 r"""An event generated when a container exits. 105 106 Fields: 107 actionId: The numeric ID of the action that started this container. 108 exitStatus: The exit status of the container. 109 stderr: The tail end of any content written to standard error by the 110 container. If the content emits large amounts of debugging noise or 111 contains sensitive information, you can prevent the content from being 112 printed by setting the `DISABLE_STANDARD_ERROR_CAPTURE` flag. Note that 113 only a small amount of the end of the stream is captured here. The 114 entire stream is stored in the `/google/logs` directory mounted into 115 each action, and can be copied off the machine as described elsewhere. 116 """ 117 118 actionId = _messages.IntegerField(1, variant=_messages.Variant.INT32) 119 exitStatus = _messages.IntegerField(2, variant=_messages.Variant.INT32) 120 stderr = _messages.StringField(3) 121 122 123class ControllerConfig(_messages.Message): 124 r"""Stores the information that the controller will fetch from the server in 125 order to run. Should only be used by VMs created by the Pipelines Service 126 and not by end users. 127 128 Messages: 129 DisksValue: A DisksValue object. 130 GcsSinksValue: A GcsSinksValue object. 131 GcsSourcesValue: A GcsSourcesValue object. 132 VarsValue: A VarsValue object. 133 134 Fields: 135 cmd: A string attribute. 136 disks: A DisksValue attribute. 137 gcsLogPath: A string attribute. 138 gcsSinks: A GcsSinksValue attribute. 139 gcsSources: A GcsSourcesValue attribute. 140 image: A string attribute. 141 machineType: A string attribute. 142 vars: A VarsValue attribute. 143 """ 144 145 @encoding.MapUnrecognizedFields('additionalProperties') 146 class DisksValue(_messages.Message): 147 r"""A DisksValue object. 148 149 Messages: 150 AdditionalProperty: An additional property for a DisksValue object. 151 152 Fields: 153 additionalProperties: Additional properties of type DisksValue 154 """ 155 156 class AdditionalProperty(_messages.Message): 157 r"""An additional property for a DisksValue object. 158 159 Fields: 160 key: Name of the additional property. 161 value: A string attribute. 162 """ 163 164 key = _messages.StringField(1) 165 value = _messages.StringField(2) 166 167 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 168 169 @encoding.MapUnrecognizedFields('additionalProperties') 170 class GcsSinksValue(_messages.Message): 171 r"""A GcsSinksValue object. 172 173 Messages: 174 AdditionalProperty: An additional property for a GcsSinksValue object. 175 176 Fields: 177 additionalProperties: Additional properties of type GcsSinksValue 178 """ 179 180 class AdditionalProperty(_messages.Message): 181 r"""An additional property for a GcsSinksValue object. 182 183 Fields: 184 key: Name of the additional property. 185 value: A RepeatedString attribute. 186 """ 187 188 key = _messages.StringField(1) 189 value = _messages.MessageField('RepeatedString', 2) 190 191 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 192 193 @encoding.MapUnrecognizedFields('additionalProperties') 194 class GcsSourcesValue(_messages.Message): 195 r"""A GcsSourcesValue object. 196 197 Messages: 198 AdditionalProperty: An additional property for a GcsSourcesValue object. 199 200 Fields: 201 additionalProperties: Additional properties of type GcsSourcesValue 202 """ 203 204 class AdditionalProperty(_messages.Message): 205 r"""An additional property for a GcsSourcesValue object. 206 207 Fields: 208 key: Name of the additional property. 209 value: A RepeatedString attribute. 210 """ 211 212 key = _messages.StringField(1) 213 value = _messages.MessageField('RepeatedString', 2) 214 215 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 216 217 @encoding.MapUnrecognizedFields('additionalProperties') 218 class VarsValue(_messages.Message): 219 r"""A VarsValue object. 220 221 Messages: 222 AdditionalProperty: An additional property for a VarsValue object. 223 224 Fields: 225 additionalProperties: Additional properties of type VarsValue 226 """ 227 228 class AdditionalProperty(_messages.Message): 229 r"""An additional property for a VarsValue object. 230 231 Fields: 232 key: Name of the additional property. 233 value: A string attribute. 234 """ 235 236 key = _messages.StringField(1) 237 value = _messages.StringField(2) 238 239 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 240 241 cmd = _messages.StringField(1) 242 disks = _messages.MessageField('DisksValue', 2) 243 gcsLogPath = _messages.StringField(3) 244 gcsSinks = _messages.MessageField('GcsSinksValue', 4) 245 gcsSources = _messages.MessageField('GcsSourcesValue', 5) 246 image = _messages.StringField(6) 247 machineType = _messages.StringField(7) 248 vars = _messages.MessageField('VarsValue', 8) 249 250 251class DelayedEvent(_messages.Message): 252 r"""An event generated whenever a resource limitation or transient error 253 delays execution of a pipeline that was otherwise ready to run. 254 255 Fields: 256 cause: A textual description of the cause of the delay. The string can 257 change without notice because it is often generated by another service 258 (such as Compute Engine). 259 metrics: If the delay was caused by a resource shortage, this field lists 260 the Compute Engine metrics that are preventing this operation from 261 running (for example, `CPUS` or `INSTANCES`). If the particular metric 262 is not known, a single `UNKNOWN` metric will be present. 263 """ 264 265 cause = _messages.StringField(1) 266 metrics = _messages.StringField(2, repeated=True) 267 268 269class Disk(_messages.Message): 270 r"""A Google Compute Engine disk resource specification. 271 272 Enums: 273 TypeValueValuesEnum: Required. The type of the disk to create. 274 275 Fields: 276 autoDelete: Deprecated. Disks created by the Pipelines API will be deleted 277 at the end of the pipeline run, regardless of what this field is set to. 278 mountPoint: Required at create time and cannot be overridden at run time. 279 Specifies the path in the docker container where files on this disk 280 should be located. For example, if `mountPoint` is `/mnt/disk`, and the 281 parameter has `localPath` `inputs/file.txt`, the docker container can 282 access the data at `/mnt/disk/inputs/file.txt`. 283 name: Required. The name of the disk that can be used in the pipeline 284 parameters. Must be 1 - 63 characters. The name "boot" is reserved for 285 system use. 286 readOnly: Specifies how a sourced-base persistent disk will be mounted. 287 See https://cloud.google.com/compute/docs/disks/persistent- 288 disks#use_multi_instances for more details. Can only be set at create 289 time. 290 sizeGb: The size of the disk. Defaults to 500 (GB). This field is not 291 applicable for local SSD. 292 source: The full or partial URL of the persistent disk to attach. See 293 https://cloud.google.com/compute/docs/reference/latest/instances#resourc 294 e and https://cloud.google.com/compute/docs/disks/persistent- 295 disks#snapshots for more details. 296 type: Required. The type of the disk to create. 297 """ 298 299 class TypeValueValuesEnum(_messages.Enum): 300 r"""Required. The type of the disk to create. 301 302 Values: 303 TYPE_UNSPECIFIED: Default disk type. Use one of the other options below. 304 PERSISTENT_HDD: Specifies a Google Compute Engine persistent hard disk. 305 See https://cloud.google.com/compute/docs/disks/#pdspecs for details. 306 PERSISTENT_SSD: Specifies a Google Compute Engine persistent solid-state 307 disk. See https://cloud.google.com/compute/docs/disks/#pdspecs for 308 details. 309 LOCAL_SSD: Specifies a Google Compute Engine local SSD. See 310 https://cloud.google.com/compute/docs/disks/local-ssd for details. 311 """ 312 TYPE_UNSPECIFIED = 0 313 PERSISTENT_HDD = 1 314 PERSISTENT_SSD = 2 315 LOCAL_SSD = 3 316 317 autoDelete = _messages.BooleanField(1) 318 mountPoint = _messages.StringField(2) 319 name = _messages.StringField(3) 320 readOnly = _messages.BooleanField(4) 321 sizeGb = _messages.IntegerField(5, variant=_messages.Variant.INT32) 322 source = _messages.StringField(6) 323 type = _messages.EnumField('TypeValueValuesEnum', 7) 324 325 326class DockerExecutor(_messages.Message): 327 r"""The Docker execuctor specification. 328 329 Fields: 330 cmd: Required. The command or newline delimited script to run. The command 331 string will be executed within a bash shell. If the command exits with a 332 non-zero exit code, output parameter de-localization will be skipped and 333 the pipeline operation's `error` field will be populated. Maximum 334 command string length is 16384. 335 imageName: Required. Image name from either Docker Hub or Google Container 336 Registry. Users that run pipelines must have READ access to the image. 337 """ 338 339 cmd = _messages.StringField(1) 340 imageName = _messages.StringField(2) 341 342 343class Empty(_messages.Message): 344 r"""A generic empty message that you can re-use to avoid defining duplicated 345 empty messages in your APIs. A typical example is to use it as the request 346 or the response type of an API method. For instance: service Foo { rpc 347 Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON 348 representation for `Empty` is empty JSON object `{}`. 349 """ 350 351 352 353class Event(_messages.Message): 354 r"""Carries information about events that occur during pipeline execution. 355 356 Messages: 357 DetailsValue: Machine-readable details about the event. 358 359 Fields: 360 description: A human-readable description of the event. Note that these 361 strings can change at any time without notice. Any application logic 362 must use the information in the `details` field. 363 details: Machine-readable details about the event. 364 timestamp: The time at which the event occurred. 365 """ 366 367 @encoding.MapUnrecognizedFields('additionalProperties') 368 class DetailsValue(_messages.Message): 369 r"""Machine-readable details about the event. 370 371 Messages: 372 AdditionalProperty: An additional property for a DetailsValue object. 373 374 Fields: 375 additionalProperties: Properties of the object. Contains field @type 376 with type URL. 377 """ 378 379 class AdditionalProperty(_messages.Message): 380 r"""An additional property for a DetailsValue object. 381 382 Fields: 383 key: Name of the additional property. 384 value: A extra_types.JsonValue attribute. 385 """ 386 387 key = _messages.StringField(1) 388 value = _messages.MessageField('extra_types.JsonValue', 2) 389 390 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 391 392 description = _messages.StringField(1) 393 details = _messages.MessageField('DetailsValue', 2) 394 timestamp = _messages.StringField(3) 395 396 397class FailedEvent(_messages.Message): 398 r"""An event generated when the execution of a pipeline has failed. Note 399 that other events can continue to occur after this event. 400 401 Enums: 402 CodeValueValuesEnum: The Google standard error code that best describes 403 this failure. 404 405 Fields: 406 cause: The human-readable description of the cause of the failure. 407 code: The Google standard error code that best describes this failure. 408 """ 409 410 class CodeValueValuesEnum(_messages.Enum): 411 r"""The Google standard error code that best describes this failure. 412 413 Values: 414 OK: Not an error; returned on success HTTP Mapping: 200 OK 415 CANCELLED: The operation was cancelled, typically by the caller. HTTP 416 Mapping: 499 Client Closed Request 417 UNKNOWN: Unknown error. For example, this error may be returned when a 418 `Status` value received from another address space belongs to an error 419 space that is not known in this address space. Also errors raised by 420 APIs that do not return enough error information may be converted to 421 this error. HTTP Mapping: 500 Internal Server Error 422 INVALID_ARGUMENT: The client specified an invalid argument. Note that 423 this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates 424 arguments that are problematic regardless of the state of the system 425 (e.g., a malformed file name). HTTP Mapping: 400 Bad Request 426 DEADLINE_EXCEEDED: The deadline expired before the operation could 427 complete. For operations that change the state of the system, this 428 error may be returned even if the operation has completed 429 successfully. For example, a successful response from a server could 430 have been delayed long enough for the deadline to expire. HTTP 431 Mapping: 504 Gateway Timeout 432 NOT_FOUND: Some requested entity (e.g., file or directory) was not 433 found. Note to server developers: if a request is denied for an entire 434 class of users, such as gradual feature rollout or undocumented 435 allowlist, `NOT_FOUND` may be used. If a request is denied for some 436 users within a class of users, such as user-based access control, 437 `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found 438 ALREADY_EXISTS: The entity that a client attempted to create (e.g., file 439 or directory) already exists. HTTP Mapping: 409 Conflict 440 PERMISSION_DENIED: The caller does not have permission to execute the 441 specified operation. `PERMISSION_DENIED` must not be used for 442 rejections caused by exhausting some resource (use 443 `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` 444 must not be used if the caller can not be identified (use 445 `UNAUTHENTICATED` instead for those errors). This error code does not 446 imply the request is valid or the requested entity exists or satisfies 447 other pre-conditions. HTTP Mapping: 403 Forbidden 448 UNAUTHENTICATED: The request does not have valid authentication 449 credentials for the operation. HTTP Mapping: 401 Unauthorized 450 RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user 451 quota, or perhaps the entire file system is out of space. HTTP 452 Mapping: 429 Too Many Requests 453 FAILED_PRECONDITION: The operation was rejected because the system is 454 not in a state required for the operation's execution. For example, 455 the directory to be deleted is non-empty, an rmdir operation is 456 applied to a non-directory, etc. Service implementors can use the 457 following guidelines to decide between `FAILED_PRECONDITION`, 458 `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can 459 retry just the failing call. (b) Use `ABORTED` if the client should 460 retry at a higher level (e.g., when a client-specified test-and-set 461 fails, indicating the client should restart a read-modify-write 462 sequence). (c) Use `FAILED_PRECONDITION` if the client should not 463 retry until the system state has been explicitly fixed. E.g., if an 464 "rmdir" fails because the directory is non-empty, 465 `FAILED_PRECONDITION` should be returned since the client should not 466 retry unless the files are deleted from the directory. HTTP Mapping: 467 400 Bad Request 468 ABORTED: The operation was aborted, typically due to a concurrency issue 469 such as a sequencer check failure or transaction abort. See the 470 guidelines above for deciding between `FAILED_PRECONDITION`, 471 `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict 472 OUT_OF_RANGE: The operation was attempted past the valid range. E.g., 473 seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this 474 error indicates a problem that may be fixed if the system state 475 changes. For example, a 32-bit file system will generate 476 `INVALID_ARGUMENT` if asked to read at an offset that is not in the 477 range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read 478 from an offset past the current file size. There is a fair bit of 479 overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend 480 using `OUT_OF_RANGE` (the more specific error) when it applies so that 481 callers who are iterating through a space can easily look for an 482 `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 483 Bad Request 484 UNIMPLEMENTED: The operation is not implemented or is not 485 supported/enabled in this service. HTTP Mapping: 501 Not Implemented 486 INTERNAL: Internal errors. This means that some invariants expected by 487 the underlying system have been broken. This error code is reserved 488 for serious errors. HTTP Mapping: 500 Internal Server Error 489 UNAVAILABLE: The service is currently unavailable. This is most likely a 490 transient condition, which can be corrected by retrying with a 491 backoff. Note that it is not always safe to retry non-idempotent 492 operations. See the guidelines above for deciding between 493 `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 494 Service Unavailable 495 DATA_LOSS: Unrecoverable data loss or corruption. HTTP Mapping: 500 496 Internal Server Error 497 """ 498 OK = 0 499 CANCELLED = 1 500 UNKNOWN = 2 501 INVALID_ARGUMENT = 3 502 DEADLINE_EXCEEDED = 4 503 NOT_FOUND = 5 504 ALREADY_EXISTS = 6 505 PERMISSION_DENIED = 7 506 UNAUTHENTICATED = 8 507 RESOURCE_EXHAUSTED = 9 508 FAILED_PRECONDITION = 10 509 ABORTED = 11 510 OUT_OF_RANGE = 12 511 UNIMPLEMENTED = 13 512 INTERNAL = 14 513 UNAVAILABLE = 15 514 DATA_LOSS = 16 515 516 cause = _messages.StringField(1) 517 code = _messages.EnumField('CodeValueValuesEnum', 2) 518 519 520class GenomicsOperationsCancelRequest(_messages.Message): 521 r"""A GenomicsOperationsCancelRequest object. 522 523 Fields: 524 cancelOperationRequest: A CancelOperationRequest resource to be passed as 525 the request body. 526 name: The name of the operation resource to be cancelled. 527 """ 528 529 cancelOperationRequest = _messages.MessageField('CancelOperationRequest', 1) 530 name = _messages.StringField(2, required=True) 531 532 533class GenomicsOperationsGetRequest(_messages.Message): 534 r"""A GenomicsOperationsGetRequest object. 535 536 Fields: 537 name: The name of the operation resource. 538 """ 539 540 name = _messages.StringField(1, required=True) 541 542 543class GenomicsOperationsListRequest(_messages.Message): 544 r"""A GenomicsOperationsListRequest object. 545 546 Fields: 547 filter: A string for filtering Operations. In v2alpha1, the following 548 filter fields are supported: * createTime: The time this job was created 549 * events: The set of event (names) that have occurred while running the 550 pipeline. The : operator can be used to determine if a particular event 551 has occurred. * error: If the pipeline is running, this value is NULL. 552 Once the pipeline finishes, the value is the standard Google error code. 553 * labels.key or labels."key with space" where key is a label key. * 554 done: If the pipeline is running, this value is false. Once the pipeline 555 finishes, the value is true. In v1 and v1alpha2, the following filter 556 fields are supported: * projectId: Required. Corresponds to 557 OperationMetadata.projectId. * createTime: The time this job was 558 created, in seconds from the 559 [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `>=` and/or 560 `<=` operators. * status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or 561 `CANCELED`. Only one status may be specified. * labels.key where key is 562 a label key. Examples: * `projectId = my-project AND createTime >= 563 1432140000` * `projectId = my-project AND createTime >= 1432140000 AND 564 createTime <= 1432150000 AND status = RUNNING` * `projectId = my-project 565 AND labels.color = *` * `projectId = my-project AND labels.color = red` 566 name: The name of the operation's parent resource. 567 pageSize: The maximum number of results to return. The maximum value is 568 256. 569 pageToken: The standard list page token. 570 """ 571 572 filter = _messages.StringField(1) 573 name = _messages.StringField(2, required=True) 574 pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) 575 pageToken = _messages.StringField(4) 576 577 578class GenomicsPipelinesDeleteRequest(_messages.Message): 579 r"""A GenomicsPipelinesDeleteRequest object. 580 581 Fields: 582 pipelineId: Caller must have WRITE access to the project in which this 583 pipeline is defined. 584 """ 585 586 pipelineId = _messages.StringField(1, required=True) 587 588 589class GenomicsPipelinesGetControllerConfigRequest(_messages.Message): 590 r"""A GenomicsPipelinesGetControllerConfigRequest object. 591 592 Fields: 593 operationId: The operation to retrieve controller configuration for. 594 validationToken: A string attribute. 595 """ 596 597 operationId = _messages.StringField(1) 598 validationToken = _messages.IntegerField(2, variant=_messages.Variant.UINT64) 599 600 601class GenomicsPipelinesGetRequest(_messages.Message): 602 r"""A GenomicsPipelinesGetRequest object. 603 604 Fields: 605 pipelineId: Caller must have READ access to the project in which this 606 pipeline is defined. 607 """ 608 609 pipelineId = _messages.StringField(1, required=True) 610 611 612class GenomicsPipelinesListRequest(_messages.Message): 613 r"""A GenomicsPipelinesListRequest object. 614 615 Fields: 616 namePrefix: Pipelines with names that match this prefix should be 617 returned. If unspecified, all pipelines in the project, up to 618 `pageSize`, will be returned. 619 pageSize: Number of pipelines to return at once. Defaults to 256, and max 620 is 2048. 621 pageToken: Token to use to indicate where to start getting results. If 622 unspecified, returns the first page of results. 623 projectId: Required. The name of the project to search for pipelines. 624 Caller must have READ access to this project. 625 """ 626 627 namePrefix = _messages.StringField(1) 628 pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) 629 pageToken = _messages.StringField(3) 630 projectId = _messages.StringField(4) 631 632 633class ListOperationsResponse(_messages.Message): 634 r"""The response message for Operations.ListOperations. 635 636 Fields: 637 nextPageToken: The standard List next-page token. 638 operations: A list of operations that matches the specified filter in the 639 request. 640 """ 641 642 nextPageToken = _messages.StringField(1) 643 operations = _messages.MessageField('Operation', 2, repeated=True) 644 645 646class ListPipelinesResponse(_messages.Message): 647 r"""The response of ListPipelines. Contains at most `pageSize` pipelines. If 648 it contains `pageSize` pipelines, and more pipelines exist, then 649 `nextPageToken` will be populated and should be used as the `pageToken` 650 argument to a subsequent ListPipelines request. 651 652 Fields: 653 nextPageToken: The token to use to get the next page of results. 654 pipelines: The matched pipelines. 655 """ 656 657 nextPageToken = _messages.StringField(1) 658 pipelines = _messages.MessageField('Pipeline', 2, repeated=True) 659 660 661class LocalCopy(_messages.Message): 662 r"""LocalCopy defines how a remote file should be copied to and from the VM. 663 664 Fields: 665 disk: Required. The name of the disk where this parameter is located. Can 666 be the name of one of the disks specified in the Resources field, or 667 "boot", which represents the Docker instance's boot disk and has a mount 668 point of `/`. 669 path: Required. The path within the user's docker container where this 670 input should be localized to and from, relative to the specified disk's 671 mount point. For example: file.txt, 672 """ 673 674 disk = _messages.StringField(1) 675 path = _messages.StringField(2) 676 677 678class LoggingOptions(_messages.Message): 679 r"""The logging options for the pipeline run. 680 681 Fields: 682 gcsPath: The location in Google Cloud Storage to which the pipeline logs 683 will be copied. Can be specified as a fully qualified directory path, in 684 which case logs will be output with a unique identifier as the filename 685 in that directory, or as a fully specified path, which must end in 686 `.log`, in which case that path will be used, and the user must ensure 687 that logs are not overwritten. Stdout and stderr logs from the run are 688 also generated and output as `-stdout.log` and `-stderr.log`. 689 """ 690 691 gcsPath = _messages.StringField(1) 692 693 694class Operation(_messages.Message): 695 r"""This resource represents a long-running operation that is the result of 696 a network API call. 697 698 Messages: 699 MetadataValue: An OperationMetadata or Metadata object. This will always 700 be returned with the Operation. 701 ResponseValue: An Empty object. 702 703 Fields: 704 done: If the value is `false`, it means the operation is still in 705 progress. If `true`, the operation is completed, and either `error` or 706 `response` is available. 707 error: The error result of the operation in case of failure or 708 cancellation. 709 metadata: An OperationMetadata or Metadata object. This will always be 710 returned with the Operation. 711 name: The server-assigned name, which is only unique within the same 712 service that originally returns it. For example: 713 `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw` 714 response: An Empty object. 715 """ 716 717 @encoding.MapUnrecognizedFields('additionalProperties') 718 class MetadataValue(_messages.Message): 719 r"""An OperationMetadata or Metadata object. This will always be returned 720 with the Operation. 721 722 Messages: 723 AdditionalProperty: An additional property for a MetadataValue object. 724 725 Fields: 726 additionalProperties: Properties of the object. Contains field @type 727 with type URL. 728 """ 729 730 class AdditionalProperty(_messages.Message): 731 r"""An additional property for a MetadataValue object. 732 733 Fields: 734 key: Name of the additional property. 735 value: A extra_types.JsonValue attribute. 736 """ 737 738 key = _messages.StringField(1) 739 value = _messages.MessageField('extra_types.JsonValue', 2) 740 741 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 742 743 @encoding.MapUnrecognizedFields('additionalProperties') 744 class ResponseValue(_messages.Message): 745 r"""An Empty object. 746 747 Messages: 748 AdditionalProperty: An additional property for a ResponseValue object. 749 750 Fields: 751 additionalProperties: Properties of the object. Contains field @type 752 with type URL. 753 """ 754 755 class AdditionalProperty(_messages.Message): 756 r"""An additional property for a ResponseValue object. 757 758 Fields: 759 key: Name of the additional property. 760 value: A extra_types.JsonValue attribute. 761 """ 762 763 key = _messages.StringField(1) 764 value = _messages.MessageField('extra_types.JsonValue', 2) 765 766 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 767 768 done = _messages.BooleanField(1) 769 error = _messages.MessageField('Status', 2) 770 metadata = _messages.MessageField('MetadataValue', 3) 771 name = _messages.StringField(4) 772 response = _messages.MessageField('ResponseValue', 5) 773 774 775class OperationEvent(_messages.Message): 776 r"""An event that occurred during an Operation. 777 778 Fields: 779 description: Required description of event. 780 endTime: Optional time of when event finished. An event can have a start 781 time and no finish time. If an event has a finish time, there must be a 782 start time. 783 startTime: Optional time of when event started. 784 """ 785 786 description = _messages.StringField(1) 787 endTime = _messages.StringField(2) 788 startTime = _messages.StringField(3) 789 790 791class OperationMetadata(_messages.Message): 792 r"""Metadata describing an Operation. 793 794 Messages: 795 LabelsValue: Optionally provided by the caller when submitting the request 796 that creates the operation. 797 RequestValue: The original request that started the operation. Note that 798 this will be in current version of the API. If the operation was started 799 with v1beta2 API and a GetOperation is performed on v1 API, a v1 request 800 will be returned. 801 RuntimeMetadataValue: Runtime metadata on this Operation. 802 803 Fields: 804 clientId: This field is deprecated. Use `labels` instead. Optionally 805 provided by the caller when submitting the request that creates the 806 operation. 807 createTime: The time at which the job was submitted to the Genomics 808 service. 809 endTime: The time at which the job stopped running. 810 events: Optional event messages that were generated during the job's 811 execution. This also contains any warnings that were generated during 812 import or export. 813 labels: Optionally provided by the caller when submitting the request that 814 creates the operation. 815 projectId: The Google Cloud Project in which the job is scoped. 816 request: The original request that started the operation. Note that this 817 will be in current version of the API. If the operation was started with 818 v1beta2 API and a GetOperation is performed on v1 API, a v1 request will 819 be returned. 820 runtimeMetadata: Runtime metadata on this Operation. 821 startTime: The time at which the job began to run. 822 """ 823 824 @encoding.MapUnrecognizedFields('additionalProperties') 825 class LabelsValue(_messages.Message): 826 r"""Optionally provided by the caller when submitting the request that 827 creates the operation. 828 829 Messages: 830 AdditionalProperty: An additional property for a LabelsValue object. 831 832 Fields: 833 additionalProperties: Additional properties of type LabelsValue 834 """ 835 836 class AdditionalProperty(_messages.Message): 837 r"""An additional property for a LabelsValue object. 838 839 Fields: 840 key: Name of the additional property. 841 value: A string attribute. 842 """ 843 844 key = _messages.StringField(1) 845 value = _messages.StringField(2) 846 847 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 848 849 @encoding.MapUnrecognizedFields('additionalProperties') 850 class RequestValue(_messages.Message): 851 r"""The original request that started the operation. Note that this will 852 be in current version of the API. If the operation was started with 853 v1beta2 API and a GetOperation is performed on v1 API, a v1 request will 854 be returned. 855 856 Messages: 857 AdditionalProperty: An additional property for a RequestValue object. 858 859 Fields: 860 additionalProperties: Properties of the object. Contains field @type 861 with type URL. 862 """ 863 864 class AdditionalProperty(_messages.Message): 865 r"""An additional property for a RequestValue object. 866 867 Fields: 868 key: Name of the additional property. 869 value: A extra_types.JsonValue attribute. 870 """ 871 872 key = _messages.StringField(1) 873 value = _messages.MessageField('extra_types.JsonValue', 2) 874 875 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 876 877 @encoding.MapUnrecognizedFields('additionalProperties') 878 class RuntimeMetadataValue(_messages.Message): 879 r"""Runtime metadata on this Operation. 880 881 Messages: 882 AdditionalProperty: An additional property for a RuntimeMetadataValue 883 object. 884 885 Fields: 886 additionalProperties: Properties of the object. Contains field @type 887 with type URL. 888 """ 889 890 class AdditionalProperty(_messages.Message): 891 r"""An additional property for a RuntimeMetadataValue object. 892 893 Fields: 894 key: Name of the additional property. 895 value: A extra_types.JsonValue attribute. 896 """ 897 898 key = _messages.StringField(1) 899 value = _messages.MessageField('extra_types.JsonValue', 2) 900 901 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 902 903 clientId = _messages.StringField(1) 904 createTime = _messages.StringField(2) 905 endTime = _messages.StringField(3) 906 events = _messages.MessageField('OperationEvent', 4, repeated=True) 907 labels = _messages.MessageField('LabelsValue', 5) 908 projectId = _messages.StringField(6) 909 request = _messages.MessageField('RequestValue', 7) 910 runtimeMetadata = _messages.MessageField('RuntimeMetadataValue', 8) 911 startTime = _messages.StringField(9) 912 913 914class Pipeline(_messages.Message): 915 r"""The pipeline object. Represents a transformation from a set of input 916 parameters to a set of output parameters. The transformation is defined as a 917 docker image and command to run within that image. Each pipeline is run on a 918 Google Compute Engine VM. A pipeline can be created with the `create` method 919 and then later run with the `run` method, or a pipeline can be defined and 920 run all at once with the `run` method. 921 922 Fields: 923 description: User-specified description. 924 docker: Specifies the docker run information. 925 inputParameters: Input parameters of the pipeline. 926 name: Required. A user specified pipeline name that does not have to be 927 unique. This name can be used for filtering Pipelines in ListPipelines. 928 outputParameters: Output parameters of the pipeline. 929 pipelineId: Unique pipeline id that is generated by the service when 930 CreatePipeline is called. Cannot be specified in the Pipeline used in 931 the CreatePipelineRequest, and will be populated in the response to 932 CreatePipeline and all subsequent Get and List calls. Indicates that the 933 service has registered this pipeline. 934 projectId: Required. The project in which to create the pipeline. The 935 caller must have WRITE access. 936 resources: Required. Specifies resource requirements for the pipeline run. 937 Required fields: * minimumCpuCores * minimumRamGb 938 """ 939 940 description = _messages.StringField(1) 941 docker = _messages.MessageField('DockerExecutor', 2) 942 inputParameters = _messages.MessageField('PipelineParameter', 3, repeated=True) 943 name = _messages.StringField(4) 944 outputParameters = _messages.MessageField('PipelineParameter', 5, repeated=True) 945 pipelineId = _messages.StringField(6) 946 projectId = _messages.StringField(7) 947 resources = _messages.MessageField('PipelineResources', 8) 948 949 950class PipelineParameter(_messages.Message): 951 r"""Parameters facilitate setting and delivering data into the pipeline's 952 execution environment. They are defined at create time, with optional 953 defaults, and can be overridden at run time. If `localCopy` is unset, then 954 the parameter specifies a string that is passed as-is into the pipeline, as 955 the value of the environment variable with the given name. A default value 956 can be optionally specified at create time. The default can be overridden at 957 run time using the inputs map. If no default is given, a value must be 958 supplied at runtime. If `localCopy` is defined, then the parameter specifies 959 a data source or sink, both in Google Cloud Storage and on the Docker 960 container where the pipeline computation is run. The service account 961 associated with the Pipeline (by default the project's Compute Engine 962 service account) must have access to the Google Cloud Storage paths. At run 963 time, the Google Cloud Storage paths can be overridden if a default was 964 provided at create time, or must be set otherwise. The pipeline runner 965 should add a key/value pair to either the inputs or outputs map. The 966 indicated data copies will be carried out before/after pipeline execution, 967 just as if the corresponding arguments were provided to `gsutil cp`. For 968 example: Given the following `PipelineParameter`, specified in the 969 `inputParameters` list: ``` {name: "input_file", localCopy: {path: 970 "file.txt", disk: "pd1"}} ``` where `disk` is defined in the 971 `PipelineResources` object as: ``` {name: "pd1", mountPoint: "/mnt/disk/"} 972 ``` We create a disk named `pd1`, mount it on the host VM, and map 973 `/mnt/pd1` to `/mnt/disk` in the docker container. At runtime, an entry for 974 `input_file` would be required in the inputs map, such as: ``` 975 inputs["input_file"] = "gs://my-bucket/bar.txt" ``` This would generate the 976 following gsutil call: ``` gsutil cp gs://my-bucket/bar.txt 977 /mnt/pd1/file.txt ``` The file `/mnt/pd1/file.txt` maps to 978 `/mnt/disk/file.txt` in the Docker container. Acceptable paths are: Google 979 Cloud storage pathLocal path file file glob directory For outputs, the 980 direction of the copy is reversed: ``` gsutil cp /mnt/disk/file.txt gs://my- 981 bucket/bar.txt ``` Acceptable paths are: Local pathGoogle Cloud Storage path 982 file file file directory - directory must already exist glob directory - 983 directory will be created if it doesn't exist One restriction due to docker 984 limitations, is that for outputs that are found on the boot disk, the local 985 path cannot be a glob and must be a file. 986 987 Fields: 988 defaultValue: The default value for this parameter. Can be overridden at 989 runtime. If `localCopy` is present, then this must be a Google Cloud 990 Storage path beginning with `gs://`. 991 description: Human-readable description. 992 localCopy: If present, this parameter is marked for copying to and from 993 the VM. `LocalCopy` indicates where on the VM the file should be. The 994 value given to this parameter (either at runtime or using 995 `defaultValue`) must be the remote path where the file should be. 996 name: Required. Name of the parameter - the pipeline runner uses this 997 string as the key to the input and output maps in RunPipeline. 998 """ 999 1000 defaultValue = _messages.StringField(1) 1001 description = _messages.StringField(2) 1002 localCopy = _messages.MessageField('LocalCopy', 3) 1003 name = _messages.StringField(4) 1004 1005 1006class PipelineResources(_messages.Message): 1007 r"""The system resources for the pipeline run. 1008 1009 Fields: 1010 acceleratorCount: Optional. The number of accelerators of the specified 1011 type to attach. By specifying this parameter, you will download and 1012 install the following third-party software onto your managed Compute 1013 Engine instances: NVIDIA(R) Tesla(R) drivers and NVIDIA(R) CUDA toolkit. 1014 acceleratorType: Optional. The Compute Engine defined accelerator type. By 1015 specifying this parameter, you will download and install the following 1016 third-party software onto your managed Compute Engine instances: 1017 NVIDIA(R) Tesla(R) drivers and NVIDIA(R) CUDA toolkit. Please see 1018 https://cloud.google.com/compute/docs/gpus/ for a list of available 1019 accelerator types. 1020 bootDiskSizeGb: The size of the boot disk. Defaults to 10 (GB). 1021 disks: Disks to attach. 1022 minimumCpuCores: The minimum number of cores to use. Defaults to 1. 1023 minimumRamGb: The minimum amount of RAM to use. Defaults to 3.75 (GB) 1024 noAddress: Whether to assign an external IP to the instance. This is an 1025 experimental feature that may go away. Defaults to false. Corresponds to 1026 `--no_address` flag for [gcloud compute instances create] (https://cloud 1027 .google.com/sdk/gcloud/reference/compute/instances/create). In order to 1028 use this, must be true for both create time and run time. Cannot be true 1029 at run time if false at create time. If you need to ssh into a private 1030 IP VM for debugging, you can ssh to a public VM and then ssh into the 1031 private VM's Internal IP. If noAddress is set, this pipeline run may 1032 only load docker images from Google Container Registry and not Docker 1033 Hub. Before using this, you must [configure access to Google services 1034 from internal IPs](https://cloud.google.com/compute/docs/configure- 1035 private-google- 1036 access#configuring_access_to_google_services_from_internal_ips). 1037 preemptible: Whether to use preemptible VMs. Defaults to `false`. In order 1038 to use this, must be true for both create time and run time. Cannot be 1039 true at run time if false at create time. 1040 zones: List of Google Compute Engine availability zones to which resource 1041 creation will restricted. If empty, any zone may be chosen. 1042 """ 1043 1044 acceleratorCount = _messages.IntegerField(1) 1045 acceleratorType = _messages.StringField(2) 1046 bootDiskSizeGb = _messages.IntegerField(3, variant=_messages.Variant.INT32) 1047 disks = _messages.MessageField('Disk', 4, repeated=True) 1048 minimumCpuCores = _messages.IntegerField(5, variant=_messages.Variant.INT32) 1049 minimumRamGb = _messages.FloatField(6) 1050 noAddress = _messages.BooleanField(7) 1051 preemptible = _messages.BooleanField(8) 1052 zones = _messages.StringField(9, repeated=True) 1053 1054 1055class PullStartedEvent(_messages.Message): 1056 r"""An event generated when the worker starts pulling an image. 1057 1058 Fields: 1059 imageUri: The URI of the image that was pulled. 1060 """ 1061 1062 imageUri = _messages.StringField(1) 1063 1064 1065class PullStoppedEvent(_messages.Message): 1066 r"""An event generated when the worker stops pulling an image. 1067 1068 Fields: 1069 imageUri: The URI of the image that was pulled. 1070 """ 1071 1072 imageUri = _messages.StringField(1) 1073 1074 1075class RepeatedString(_messages.Message): 1076 r"""A RepeatedString object. 1077 1078 Fields: 1079 values: A string attribute. 1080 """ 1081 1082 values = _messages.StringField(1, repeated=True) 1083 1084 1085class RunPipelineArgs(_messages.Message): 1086 r"""The pipeline run arguments. 1087 1088 Messages: 1089 InputsValue: Pipeline input arguments; keys are defined in the pipeline 1090 documentation. All input parameters that do not have default values must 1091 be specified. If parameters with defaults are specified here, the 1092 defaults will be overridden. 1093 LabelsValue: Labels to apply to this pipeline run. Labels will also be 1094 applied to compute resources (VM, disks) created by this pipeline run. 1095 When listing operations, operations can filtered by labels. Label keys 1096 may not be empty; label values may be empty. Non-empty labels must be 1097 1-63 characters long, and comply with [RFC1035] 1098 (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1099 1-63 characters long and match the regular expression 1100 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a 1101 lowercase letter, and all following characters must be a dash, lowercase 1102 letter, or digit, except the last character, which cannot be a dash. 1103 OutputsValue: Pipeline output arguments; keys are defined in the pipeline 1104 documentation. All output parameters of without default values must be 1105 specified. If parameters with defaults are specified here, the defaults 1106 will be overridden. 1107 1108 Fields: 1109 clientId: This field is deprecated. Use `labels` instead. Client-specified 1110 pipeline operation identifier. 1111 inputs: Pipeline input arguments; keys are defined in the pipeline 1112 documentation. All input parameters that do not have default values must 1113 be specified. If parameters with defaults are specified here, the 1114 defaults will be overridden. 1115 keepVmAliveOnFailureDuration: How long to keep the VM up after a failure 1116 (for example docker command failed, copying input or output files 1117 failed, etc). While the VM is up, one can ssh into the VM to debug. 1118 Default is 0; maximum allowed value is 1 day. 1119 labels: Labels to apply to this pipeline run. Labels will also be applied 1120 to compute resources (VM, disks) created by this pipeline run. When 1121 listing operations, operations can filtered by labels. Label keys may 1122 not be empty; label values may be empty. Non-empty labels must be 1-63 1123 characters long, and comply with [RFC1035] 1124 (https://www.ietf.org/rfc/rfc1035.txt). Specifically, the name must be 1125 1-63 characters long and match the regular expression 1126 `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a 1127 lowercase letter, and all following characters must be a dash, lowercase 1128 letter, or digit, except the last character, which cannot be a dash. 1129 logging: Required. Logging options. Used by the service to communicate 1130 results to the user. 1131 outputs: Pipeline output arguments; keys are defined in the pipeline 1132 documentation. All output parameters of without default values must be 1133 specified. If parameters with defaults are specified here, the defaults 1134 will be overridden. 1135 projectId: Required. The project in which to run the pipeline. The caller 1136 must have WRITER access to all Google Cloud services and resources (e.g. 1137 Google Compute Engine) will be used. 1138 resources: Specifies resource requirements/overrides for the pipeline run. 1139 serviceAccount: The Google Cloud Service Account that will be used to 1140 access data and services. By default, the compute service account 1141 associated with `projectId` is used. 1142 """ 1143 1144 @encoding.MapUnrecognizedFields('additionalProperties') 1145 class InputsValue(_messages.Message): 1146 r"""Pipeline input arguments; keys are defined in the pipeline 1147 documentation. All input parameters that do not have default values must 1148 be specified. If parameters with defaults are specified here, the defaults 1149 will be overridden. 1150 1151 Messages: 1152 AdditionalProperty: An additional property for a InputsValue object. 1153 1154 Fields: 1155 additionalProperties: Additional properties of type InputsValue 1156 """ 1157 1158 class AdditionalProperty(_messages.Message): 1159 r"""An additional property for a InputsValue object. 1160 1161 Fields: 1162 key: Name of the additional property. 1163 value: A string attribute. 1164 """ 1165 1166 key = _messages.StringField(1) 1167 value = _messages.StringField(2) 1168 1169 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 1170 1171 @encoding.MapUnrecognizedFields('additionalProperties') 1172 class LabelsValue(_messages.Message): 1173 r"""Labels to apply to this pipeline run. Labels will also be applied to 1174 compute resources (VM, disks) created by this pipeline run. When listing 1175 operations, operations can filtered by labels. Label keys may not be 1176 empty; label values may be empty. Non-empty labels must be 1-63 characters 1177 long, and comply with [RFC1035] (https://www.ietf.org/rfc/rfc1035.txt). 1178 Specifically, the name must be 1-63 characters long and match the regular 1179 expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character 1180 must be a lowercase letter, and all following characters must be a dash, 1181 lowercase letter, or digit, except the last character, which cannot be a 1182 dash. 1183 1184 Messages: 1185 AdditionalProperty: An additional property for a LabelsValue object. 1186 1187 Fields: 1188 additionalProperties: Additional properties of type LabelsValue 1189 """ 1190 1191 class AdditionalProperty(_messages.Message): 1192 r"""An additional property for a LabelsValue object. 1193 1194 Fields: 1195 key: Name of the additional property. 1196 value: A string attribute. 1197 """ 1198 1199 key = _messages.StringField(1) 1200 value = _messages.StringField(2) 1201 1202 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 1203 1204 @encoding.MapUnrecognizedFields('additionalProperties') 1205 class OutputsValue(_messages.Message): 1206 r"""Pipeline output arguments; keys are defined in the pipeline 1207 documentation. All output parameters of without default values must be 1208 specified. If parameters with defaults are specified here, the defaults 1209 will be overridden. 1210 1211 Messages: 1212 AdditionalProperty: An additional property for a OutputsValue object. 1213 1214 Fields: 1215 additionalProperties: Additional properties of type OutputsValue 1216 """ 1217 1218 class AdditionalProperty(_messages.Message): 1219 r"""An additional property for a OutputsValue object. 1220 1221 Fields: 1222 key: Name of the additional property. 1223 value: A string attribute. 1224 """ 1225 1226 key = _messages.StringField(1) 1227 value = _messages.StringField(2) 1228 1229 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 1230 1231 clientId = _messages.StringField(1) 1232 inputs = _messages.MessageField('InputsValue', 2) 1233 keepVmAliveOnFailureDuration = _messages.StringField(3) 1234 labels = _messages.MessageField('LabelsValue', 4) 1235 logging = _messages.MessageField('LoggingOptions', 5) 1236 outputs = _messages.MessageField('OutputsValue', 6) 1237 projectId = _messages.StringField(7) 1238 resources = _messages.MessageField('PipelineResources', 8) 1239 serviceAccount = _messages.MessageField('ServiceAccount', 9) 1240 1241 1242class RunPipelineRequest(_messages.Message): 1243 r"""The request to run a pipeline. If `pipelineId` is specified, it refers 1244 to a saved pipeline created with CreatePipeline and set as the `pipelineId` 1245 of the returned Pipeline object. If `ephemeralPipeline` is specified, that 1246 pipeline is run once with the given args and not saved. It is an error to 1247 specify both `pipelineId` and `ephemeralPipeline`. `pipelineArgs` must be 1248 specified. 1249 1250 Fields: 1251 ephemeralPipeline: A new pipeline object to run once and then delete. 1252 pipelineArgs: The arguments to use when running this pipeline. 1253 pipelineId: The already created pipeline to run. 1254 """ 1255 1256 ephemeralPipeline = _messages.MessageField('Pipeline', 1) 1257 pipelineArgs = _messages.MessageField('RunPipelineArgs', 2) 1258 pipelineId = _messages.StringField(3) 1259 1260 1261class RunPipelineResponse(_messages.Message): 1262 r"""The response to the RunPipeline method, returned in the operation's 1263 result field on success. 1264 """ 1265 1266 1267 1268class RuntimeMetadata(_messages.Message): 1269 r"""Runtime metadata that will be populated in the runtimeMetadata field of 1270 the Operation associated with a RunPipeline execution. 1271 1272 Fields: 1273 computeEngine: Execution information specific to Google Compute Engine. 1274 """ 1275 1276 computeEngine = _messages.MessageField('ComputeEngine', 1) 1277 1278 1279class ServiceAccount(_messages.Message): 1280 r"""A Google Cloud Service Account. 1281 1282 Fields: 1283 email: Email address of the service account. Defaults to `default`, which 1284 uses the compute service account associated with the project. 1285 scopes: List of scopes to be enabled for this service account on the VM. 1286 The following scopes are automatically included: * 1287 https://www.googleapis.com/auth/compute * 1288 https://www.googleapis.com/auth/devstorage.full_control * 1289 https://www.googleapis.com/auth/genomics * 1290 https://www.googleapis.com/auth/logging.write * 1291 https://www.googleapis.com/auth/monitoring.write 1292 """ 1293 1294 email = _messages.StringField(1) 1295 scopes = _messages.StringField(2, repeated=True) 1296 1297 1298class SetOperationStatusRequest(_messages.Message): 1299 r"""Request to set operation status. Should only be used by VMs created by 1300 the Pipelines Service and not by end users. 1301 1302 Enums: 1303 ErrorCodeValueValuesEnum: 1304 1305 Fields: 1306 errorCode: A ErrorCodeValueValuesEnum attribute. 1307 errorMessage: A string attribute. 1308 operationId: A string attribute. 1309 timestampEvents: A TimestampEvent attribute. 1310 validationToken: A string attribute. 1311 """ 1312 1313 class ErrorCodeValueValuesEnum(_messages.Enum): 1314 r"""ErrorCodeValueValuesEnum enum type. 1315 1316 Values: 1317 OK: Not an error; returned on success HTTP Mapping: 200 OK 1318 CANCELLED: The operation was cancelled, typically by the caller. HTTP 1319 Mapping: 499 Client Closed Request 1320 UNKNOWN: Unknown error. For example, this error may be returned when a 1321 `Status` value received from another address space belongs to an error 1322 space that is not known in this address space. Also errors raised by 1323 APIs that do not return enough error information may be converted to 1324 this error. HTTP Mapping: 500 Internal Server Error 1325 INVALID_ARGUMENT: The client specified an invalid argument. Note that 1326 this differs from `FAILED_PRECONDITION`. `INVALID_ARGUMENT` indicates 1327 arguments that are problematic regardless of the state of the system 1328 (e.g., a malformed file name). HTTP Mapping: 400 Bad Request 1329 DEADLINE_EXCEEDED: The deadline expired before the operation could 1330 complete. For operations that change the state of the system, this 1331 error may be returned even if the operation has completed 1332 successfully. For example, a successful response from a server could 1333 have been delayed long enough for the deadline to expire. HTTP 1334 Mapping: 504 Gateway Timeout 1335 NOT_FOUND: Some requested entity (e.g., file or directory) was not 1336 found. Note to server developers: if a request is denied for an entire 1337 class of users, such as gradual feature rollout or undocumented 1338 allowlist, `NOT_FOUND` may be used. If a request is denied for some 1339 users within a class of users, such as user-based access control, 1340 `PERMISSION_DENIED` must be used. HTTP Mapping: 404 Not Found 1341 ALREADY_EXISTS: The entity that a client attempted to create (e.g., file 1342 or directory) already exists. HTTP Mapping: 409 Conflict 1343 PERMISSION_DENIED: The caller does not have permission to execute the 1344 specified operation. `PERMISSION_DENIED` must not be used for 1345 rejections caused by exhausting some resource (use 1346 `RESOURCE_EXHAUSTED` instead for those errors). `PERMISSION_DENIED` 1347 must not be used if the caller can not be identified (use 1348 `UNAUTHENTICATED` instead for those errors). This error code does not 1349 imply the request is valid or the requested entity exists or satisfies 1350 other pre-conditions. HTTP Mapping: 403 Forbidden 1351 UNAUTHENTICATED: The request does not have valid authentication 1352 credentials for the operation. HTTP Mapping: 401 Unauthorized 1353 RESOURCE_EXHAUSTED: Some resource has been exhausted, perhaps a per-user 1354 quota, or perhaps the entire file system is out of space. HTTP 1355 Mapping: 429 Too Many Requests 1356 FAILED_PRECONDITION: The operation was rejected because the system is 1357 not in a state required for the operation's execution. For example, 1358 the directory to be deleted is non-empty, an rmdir operation is 1359 applied to a non-directory, etc. Service implementors can use the 1360 following guidelines to decide between `FAILED_PRECONDITION`, 1361 `ABORTED`, and `UNAVAILABLE`: (a) Use `UNAVAILABLE` if the client can 1362 retry just the failing call. (b) Use `ABORTED` if the client should 1363 retry at a higher level (e.g., when a client-specified test-and-set 1364 fails, indicating the client should restart a read-modify-write 1365 sequence). (c) Use `FAILED_PRECONDITION` if the client should not 1366 retry until the system state has been explicitly fixed. E.g., if an 1367 "rmdir" fails because the directory is non-empty, 1368 `FAILED_PRECONDITION` should be returned since the client should not 1369 retry unless the files are deleted from the directory. HTTP Mapping: 1370 400 Bad Request 1371 ABORTED: The operation was aborted, typically due to a concurrency issue 1372 such as a sequencer check failure or transaction abort. See the 1373 guidelines above for deciding between `FAILED_PRECONDITION`, 1374 `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 409 Conflict 1375 OUT_OF_RANGE: The operation was attempted past the valid range. E.g., 1376 seeking or reading past end-of-file. Unlike `INVALID_ARGUMENT`, this 1377 error indicates a problem that may be fixed if the system state 1378 changes. For example, a 32-bit file system will generate 1379 `INVALID_ARGUMENT` if asked to read at an offset that is not in the 1380 range [0,2^32-1], but it will generate `OUT_OF_RANGE` if asked to read 1381 from an offset past the current file size. There is a fair bit of 1382 overlap between `FAILED_PRECONDITION` and `OUT_OF_RANGE`. We recommend 1383 using `OUT_OF_RANGE` (the more specific error) when it applies so that 1384 callers who are iterating through a space can easily look for an 1385 `OUT_OF_RANGE` error to detect when they are done. HTTP Mapping: 400 1386 Bad Request 1387 UNIMPLEMENTED: The operation is not implemented or is not 1388 supported/enabled in this service. HTTP Mapping: 501 Not Implemented 1389 INTERNAL: Internal errors. This means that some invariants expected by 1390 the underlying system have been broken. This error code is reserved 1391 for serious errors. HTTP Mapping: 500 Internal Server Error 1392 UNAVAILABLE: The service is currently unavailable. This is most likely a 1393 transient condition, which can be corrected by retrying with a 1394 backoff. Note that it is not always safe to retry non-idempotent 1395 operations. See the guidelines above for deciding between 1396 `FAILED_PRECONDITION`, `ABORTED`, and `UNAVAILABLE`. HTTP Mapping: 503 1397 Service Unavailable 1398 DATA_LOSS: Unrecoverable data loss or corruption. HTTP Mapping: 500 1399 Internal Server Error 1400 """ 1401 OK = 0 1402 CANCELLED = 1 1403 UNKNOWN = 2 1404 INVALID_ARGUMENT = 3 1405 DEADLINE_EXCEEDED = 4 1406 NOT_FOUND = 5 1407 ALREADY_EXISTS = 6 1408 PERMISSION_DENIED = 7 1409 UNAUTHENTICATED = 8 1410 RESOURCE_EXHAUSTED = 9 1411 FAILED_PRECONDITION = 10 1412 ABORTED = 11 1413 OUT_OF_RANGE = 12 1414 UNIMPLEMENTED = 13 1415 INTERNAL = 14 1416 UNAVAILABLE = 15 1417 DATA_LOSS = 16 1418 1419 errorCode = _messages.EnumField('ErrorCodeValueValuesEnum', 1) 1420 errorMessage = _messages.StringField(2) 1421 operationId = _messages.StringField(3) 1422 timestampEvents = _messages.MessageField('TimestampEvent', 4, repeated=True) 1423 validationToken = _messages.IntegerField(5, variant=_messages.Variant.UINT64) 1424 1425 1426class StandardQueryParameters(_messages.Message): 1427 r"""Query parameters accepted by all methods. 1428 1429 Enums: 1430 FXgafvValueValuesEnum: V1 error format. 1431 AltValueValuesEnum: Data format for response. 1432 1433 Fields: 1434 f__xgafv: V1 error format. 1435 access_token: OAuth access token. 1436 alt: Data format for response. 1437 callback: JSONP 1438 fields: Selector specifying which fields to include in a partial response. 1439 key: API key. Your API key identifies your project and provides you with 1440 API access, quota, and reports. Required unless you provide an OAuth 2.0 1441 token. 1442 oauth_token: OAuth 2.0 token for the current user. 1443 prettyPrint: Returns response with indentations and line breaks. 1444 quotaUser: Available to use for quota purposes for server-side 1445 applications. Can be any arbitrary string assigned to a user, but should 1446 not exceed 40 characters. 1447 trace: A tracing token of the form "token:<tokenid>" to include in api 1448 requests. 1449 uploadType: Legacy upload protocol for media (e.g. "media", "multipart"). 1450 upload_protocol: Upload protocol for media (e.g. "raw", "multipart"). 1451 """ 1452 1453 class AltValueValuesEnum(_messages.Enum): 1454 r"""Data format for response. 1455 1456 Values: 1457 json: Responses with Content-Type of application/json 1458 media: Media download with context-dependent Content-Type 1459 proto: Responses with Content-Type of application/x-protobuf 1460 """ 1461 json = 0 1462 media = 1 1463 proto = 2 1464 1465 class FXgafvValueValuesEnum(_messages.Enum): 1466 r"""V1 error format. 1467 1468 Values: 1469 _1: v1 error format 1470 _2: v2 error format 1471 """ 1472 _1 = 0 1473 _2 = 1 1474 1475 f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1) 1476 access_token = _messages.StringField(2) 1477 alt = _messages.EnumField('AltValueValuesEnum', 3, default='json') 1478 callback = _messages.StringField(4) 1479 fields = _messages.StringField(5) 1480 key = _messages.StringField(6) 1481 oauth_token = _messages.StringField(7) 1482 prettyPrint = _messages.BooleanField(8, default=True) 1483 quotaUser = _messages.StringField(9) 1484 trace = _messages.StringField(10) 1485 uploadType = _messages.StringField(11) 1486 upload_protocol = _messages.StringField(12) 1487 1488 1489class Status(_messages.Message): 1490 r"""The `Status` type defines a logical error model that is suitable for 1491 different programming environments, including REST APIs and RPC APIs. It is 1492 used by [gRPC](https://github.com/grpc). Each `Status` message contains 1493 three pieces of data: error code, error message, and error details. You can 1494 find out more about this error model and how to work with it in the [API 1495 Design Guide](https://cloud.google.com/apis/design/errors). 1496 1497 Messages: 1498 DetailsValueListEntry: A DetailsValueListEntry object. 1499 1500 Fields: 1501 code: The status code, which should be an enum value of google.rpc.Code. 1502 details: A list of messages that carry the error details. There is a 1503 common set of message types for APIs to use. 1504 message: A developer-facing error message, which should be in English. Any 1505 user-facing error message should be localized and sent in the 1506 google.rpc.Status.details field, or localized by the client. 1507 """ 1508 1509 @encoding.MapUnrecognizedFields('additionalProperties') 1510 class DetailsValueListEntry(_messages.Message): 1511 r"""A DetailsValueListEntry object. 1512 1513 Messages: 1514 AdditionalProperty: An additional property for a DetailsValueListEntry 1515 object. 1516 1517 Fields: 1518 additionalProperties: Properties of the object. Contains field @type 1519 with type URL. 1520 """ 1521 1522 class AdditionalProperty(_messages.Message): 1523 r"""An additional property for a DetailsValueListEntry object. 1524 1525 Fields: 1526 key: Name of the additional property. 1527 value: A extra_types.JsonValue attribute. 1528 """ 1529 1530 key = _messages.StringField(1) 1531 value = _messages.MessageField('extra_types.JsonValue', 2) 1532 1533 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 1534 1535 code = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1536 details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True) 1537 message = _messages.StringField(3) 1538 1539 1540class TimestampEvent(_messages.Message): 1541 r"""Stores the list of events and times they occured for major events in job 1542 execution. 1543 1544 Fields: 1545 description: String indicating the type of event 1546 timestamp: The time this event occured. 1547 """ 1548 1549 description = _messages.StringField(1) 1550 timestamp = _messages.StringField(2) 1551 1552 1553class UnexpectedExitStatusEvent(_messages.Message): 1554 r"""An event generated when the execution of a container results in a non- 1555 zero exit status that was not otherwise ignored. Execution will continue, 1556 but only actions that are flagged as `ALWAYS_RUN` will be executed. Other 1557 actions will be skipped. 1558 1559 Fields: 1560 actionId: The numeric ID of the action that started the container. 1561 exitStatus: The exit status of the container. 1562 """ 1563 1564 actionId = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1565 exitStatus = _messages.IntegerField(2, variant=_messages.Variant.INT32) 1566 1567 1568class WorkerAssignedEvent(_messages.Message): 1569 r"""An event generated after a worker VM has been assigned to run the 1570 pipeline. 1571 1572 Fields: 1573 instance: The worker's instance name. 1574 machineType: The machine type that was assigned for the worker. 1575 zone: The zone the worker is running in. 1576 """ 1577 1578 instance = _messages.StringField(1) 1579 machineType = _messages.StringField(2) 1580 zone = _messages.StringField(3) 1581 1582 1583class WorkerReleasedEvent(_messages.Message): 1584 r"""An event generated when the worker VM that was assigned to the pipeline 1585 has been released (deleted). 1586 1587 Fields: 1588 instance: The worker's instance name. 1589 zone: The zone the worker was running in. 1590 """ 1591 1592 instance = _messages.StringField(1) 1593 zone = _messages.StringField(2) 1594 1595 1596encoding.AddCustomJsonFieldMapping( 1597 StandardQueryParameters, 'f__xgafv', '$.xgafv') 1598encoding.AddCustomJsonEnumMapping( 1599 StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1') 1600encoding.AddCustomJsonEnumMapping( 1601 StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2') 1602