1"""Generated message classes for dataproc version v1beta2. 2 3Manages Hadoop-based clusters and jobs on Google Cloud Platform. 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 = 'dataproc' 15 16 17class AcceleratorConfig(_messages.Message): 18 r"""Specifies the type and number of accelerator cards attached to the 19 instances of an instance group (see GPUs on Compute Engine 20 (https://cloud.google.com/compute/docs/gpus/)). 21 22 Fields: 23 acceleratorCount: The number of the accelerator cards of this type exposed 24 to this instance. 25 acceleratorTypeUri: Full URL, partial URI, or short name of the 26 accelerator type resource to expose to this instance. See Compute Engine 27 AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/a 28 cceleratorTypes)Examples * 29 https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us- 30 east1-a/acceleratorTypes/nvidia-tesla-k80 * 31 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 32 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc 33 Auto Zone Placement 34 (https://cloud.google.com/dataproc/docs/concepts/configuring- 35 clusters/auto-zone#using_auto_zone_placement) feature, you must use the 36 short name of the accelerator type resource, for example, nvidia- 37 tesla-k80. 38 """ 39 40 acceleratorCount = _messages.IntegerField(1, variant=_messages.Variant.INT32) 41 acceleratorTypeUri = _messages.StringField(2) 42 43 44class AutoscalingConfig(_messages.Message): 45 r"""Autoscaling Policy config associated with the cluster. 46 47 Fields: 48 policyUri: Optional. The autoscaling policy used by the cluster.Only 49 resource names including projectid and location (region) are valid. 50 Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/lo 51 cations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[proj 52 ect_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note 53 that the policy must be in the same project and Dataproc region. 54 """ 55 56 policyUri = _messages.StringField(1) 57 58 59class AutoscalingPolicy(_messages.Message): 60 r"""Describes an autoscaling policy for Dataproc cluster autoscaler. 61 62 Fields: 63 basicAlgorithm: A BasicAutoscalingAlgorithm attribute. 64 id: Required. The policy id.The id must contain only letters (a-z, A-Z), 65 numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end 66 with underscore or hyphen. Must consist of between 3 and 50 characters. 67 name: Output only. The "resource name" of the autoscaling policy, as 68 described in https://cloud.google.com/apis/design/resource_names. For 69 projects.regions.autoscalingPolicies, the resource name of the policy 70 has the following format: 71 projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} 72 For projects.locations.autoscalingPolicies, the resource name of the 73 policy has the following format: projects/{project_id}/locations/{locati 74 on}/autoscalingPolicies/{policy_id} 75 secondaryWorkerConfig: Optional. Describes how the autoscaler will operate 76 for secondary workers. 77 workerConfig: Required. Describes how the autoscaler will operate for 78 primary workers. 79 """ 80 81 basicAlgorithm = _messages.MessageField('BasicAutoscalingAlgorithm', 1) 82 id = _messages.StringField(2) 83 name = _messages.StringField(3) 84 secondaryWorkerConfig = _messages.MessageField('InstanceGroupAutoscalingPolicyConfig', 4) 85 workerConfig = _messages.MessageField('InstanceGroupAutoscalingPolicyConfig', 5) 86 87 88class BasicAutoscalingAlgorithm(_messages.Message): 89 r"""Basic algorithm for autoscaling. 90 91 Fields: 92 cooldownPeriod: Optional. Duration between scaling events. A scaling 93 period starts after the update operation from the previous event has 94 completed.Bounds: 2m, 1d. Default: 2m. 95 yarnConfig: Required. YARN autoscaling configuration. 96 """ 97 98 cooldownPeriod = _messages.StringField(1) 99 yarnConfig = _messages.MessageField('BasicYarnAutoscalingConfig', 2) 100 101 102class BasicYarnAutoscalingConfig(_messages.Message): 103 r"""Basic autoscaling configurations for YARN. 104 105 Fields: 106 gracefulDecommissionTimeout: Required. Timeout for YARN graceful 107 decommissioning of Node Managers. Specifies the duration to wait for 108 jobs to complete before forcefully removing workers (and potentially 109 interrupting jobs). Only applicable to downscaling operations.Bounds: 110 0s, 1d. 111 scaleDownFactor: Required. Fraction of average YARN pending memory in the 112 last cooldown period for which to remove workers. A scale-down factor of 113 1 will result in scaling down so that there is no available memory 114 remaining after the update (more aggressive scaling). A scale-down 115 factor of 0 disables removing workers, which can be beneficial for 116 autoscaling a single job. See How autoscaling works for more 117 information.Bounds: 0.0, 1.0. 118 scaleDownMinWorkerFraction: Optional. Minimum scale-down threshold as a 119 fraction of total cluster size before scaling occurs. For example, in a 120 20-worker cluster, a threshold of 0.1 means the autoscaler must 121 recommend at least a 2 worker scale-down for the cluster to scale. A 122 threshold of 0 means the autoscaler will scale down on any recommended 123 change.Bounds: 0.0, 1.0. Default: 0.0. 124 scaleUpFactor: Required. Fraction of average YARN pending memory in the 125 last cooldown period for which to add workers. A scale-up factor of 1.0 126 will result in scaling up so that there is no pending memory remaining 127 after the update (more aggressive scaling). A scale-up factor closer to 128 0 will result in a smaller magnitude of scaling up (less aggressive 129 scaling). See How autoscaling works for more information.Bounds: 0.0, 130 1.0. 131 scaleUpMinWorkerFraction: Optional. Minimum scale-up threshold as a 132 fraction of total cluster size before scaling occurs. For example, in a 133 20-worker cluster, a threshold of 0.1 means the autoscaler must 134 recommend at least a 2-worker scale-up for the cluster to scale. A 135 threshold of 0 means the autoscaler will scale up on any recommended 136 change.Bounds: 0.0, 1.0. Default: 0.0. 137 """ 138 139 gracefulDecommissionTimeout = _messages.StringField(1) 140 scaleDownFactor = _messages.FloatField(2) 141 scaleDownMinWorkerFraction = _messages.FloatField(3) 142 scaleUpFactor = _messages.FloatField(4) 143 scaleUpMinWorkerFraction = _messages.FloatField(5) 144 145 146class Binding(_messages.Message): 147 r"""Associates members with a role. 148 149 Fields: 150 condition: The condition that is associated with this binding.If the 151 condition evaluates to true, then this binding applies to the current 152 request.If the condition evaluates to false, then this binding does not 153 apply to the current request. However, a different role binding might 154 grant the same role to one or more of the members in this binding.To 155 learn which resources support conditions in their IAM policies, see the 156 IAM documentation 157 (https://cloud.google.com/iam/help/conditions/resource-policies). 158 members: Specifies the identities requesting access for a Cloud Platform 159 resource. members can have the following values: allUsers: A special 160 identifier that represents anyone who is on the internet; with or 161 without a Google account. allAuthenticatedUsers: A special identifier 162 that represents anyone who is authenticated with a Google account or a 163 service account. user:{emailid}: An email address that represents a 164 specific Google account. For example, alice@example.com . 165 serviceAccount:{emailid}: An email address that represents a service 166 account. For example, my-other-app@appspot.gserviceaccount.com. 167 group:{emailid}: An email address that represents a Google group. For 168 example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An 169 email address (plus unique identifier) representing a user that has been 170 recently deleted. For example, 171 alice@example.com?uid=123456789012345678901. If the user is recovered, 172 this value reverts to user:{emailid} and the recovered user retains the 173 role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An 174 email address (plus unique identifier) representing a service account 175 that has been recently deleted. For example, my-other- 176 app@appspot.gserviceaccount.com?uid=123456789012345678901. If the 177 service account is undeleted, this value reverts to 178 serviceAccount:{emailid} and the undeleted service account retains the 179 role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email 180 address (plus unique identifier) representing a Google group that has 181 been recently deleted. For example, 182 admins@example.com?uid=123456789012345678901. If the group is recovered, 183 this value reverts to group:{emailid} and the recovered group retains 184 the role in the binding. domain:{domain}: The G Suite domain (primary) 185 that represents all the users of that domain. For example, google.com or 186 example.com. 187 role: Role that is assigned to members. For example, roles/viewer, 188 roles/editor, or roles/owner. 189 """ 190 191 condition = _messages.MessageField('Expr', 1) 192 members = _messages.StringField(2, repeated=True) 193 role = _messages.StringField(3) 194 195 196class CancelJobRequest(_messages.Message): 197 r"""A request to cancel a job.""" 198 199 200class Cluster(_messages.Message): 201 r"""Describes the identifying information, config, and status of a cluster 202 of Compute Engine instances. 203 204 Messages: 205 LabelsValue: Optional. The labels to associate with this cluster. Label 206 keys must contain 1 to 63 characters, and must conform to RFC 1035 207 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, 208 if present, must contain 1 to 63 characters, and must conform to RFC 209 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can 210 be associated with a cluster. 211 212 Fields: 213 clusterName: Required. The cluster name. Cluster names within a project 214 must be unique. Names of deleted clusters can be reused. 215 clusterUuid: Output only. A cluster UUID (Unique Universal Identifier). 216 Dataproc generates this value when it creates the cluster. 217 config: Required. The cluster config. Note that Dataproc may set default 218 values, and values may change when clusters are updated. 219 labels: Optional. The labels to associate with this cluster. Label keys 220 must contain 1 to 63 characters, and must conform to RFC 1035 221 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, 222 if present, must contain 1 to 63 characters, and must conform to RFC 223 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can 224 be associated with a cluster. 225 metrics: Output only. Contains cluster daemon metrics such as HDFS and 226 YARN stats.Beta Feature: This report is available for testing purposes 227 only. It may be changed before final release. 228 projectId: Required. The Google Cloud Platform project ID that the cluster 229 belongs to. 230 status: Output only. Cluster status. 231 statusHistory: Output only. The previous cluster status. 232 """ 233 234 @encoding.MapUnrecognizedFields('additionalProperties') 235 class LabelsValue(_messages.Message): 236 r"""Optional. The labels to associate with this cluster. Label keys must 237 contain 1 to 63 characters, and must conform to RFC 1035 238 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if 239 present, must contain 1 to 63 characters, and must conform to RFC 1035 240 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 241 associated with a cluster. 242 243 Messages: 244 AdditionalProperty: An additional property for a LabelsValue object. 245 246 Fields: 247 additionalProperties: Additional properties of type LabelsValue 248 """ 249 250 class AdditionalProperty(_messages.Message): 251 r"""An additional property for a LabelsValue object. 252 253 Fields: 254 key: Name of the additional property. 255 value: A string attribute. 256 """ 257 258 key = _messages.StringField(1) 259 value = _messages.StringField(2) 260 261 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 262 263 clusterName = _messages.StringField(1) 264 clusterUuid = _messages.StringField(2) 265 config = _messages.MessageField('ClusterConfig', 3) 266 labels = _messages.MessageField('LabelsValue', 4) 267 metrics = _messages.MessageField('ClusterMetrics', 5) 268 projectId = _messages.StringField(6) 269 status = _messages.MessageField('ClusterStatus', 7) 270 statusHistory = _messages.MessageField('ClusterStatus', 8, repeated=True) 271 272 273class ClusterConfig(_messages.Message): 274 r"""The cluster config. 275 276 Fields: 277 autoscalingConfig: Optional. Autoscaling config for the policy associated 278 with the cluster. Cluster does not autoscale if this field is unset. 279 configBucket: Optional. A Cloud Storage bucket used to stage job 280 dependencies, config files, and job driver console output. If you do not 281 specify a staging bucket, Cloud Dataproc will determine a Cloud Storage 282 location (US, ASIA, or EU) for your cluster's staging bucket according 283 to the Compute Engine zone where your cluster is deployed, and then 284 create and manage this project-level, per-location bucket (see Dataproc 285 staging bucket 286 (https://cloud.google.com/dataproc/docs/concepts/configuring- 287 clusters/staging-bucket)). This field requires a Cloud Storage bucket 288 name, not a URI to a Cloud Storage bucket. 289 encryptionConfig: Optional. Encryption settings for the cluster. 290 endpointConfig: Optional. Port/endpoint configuration for this cluster 291 gceClusterConfig: Optional. The shared Compute Engine config settings for 292 all instances in a cluster. 293 gkeClusterConfig: Optional. The Kubernetes Engine config for Dataproc 294 clusters deployed to Kubernetes. Setting this is considered mutually 295 exclusive with Compute Engine-based options such as gce_cluster_config, 296 master_config, worker_config, secondary_worker_config, and 297 autoscaling_config. 298 initializationActions: Optional. Commands to execute on each node after 299 config is completed. By default, executables are run on master and all 300 worker nodes. You can test a node's role metadata to run an executable 301 on a master or worker node, as shown below using curl (you can also use 302 wget): ROLE=$(curl -H Metadata-Flavor:Google 303 http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc- 304 role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions 305 ... else ... worker specific actions ... fi 306 lifecycleConfig: Optional. The config setting for auto delete cluster 307 schedule. 308 masterConfig: Optional. The Compute Engine config settings for the master 309 instance in a cluster. 310 metastoreConfig: Optional. Metastore configuration. 311 secondaryWorkerConfig: Optional. The Compute Engine config settings for 312 additional worker instances in a cluster. 313 securityConfig: Optional. Security related configuration. 314 softwareConfig: Optional. The config settings for software inside the 315 cluster. 316 tempBucket: Optional. A Cloud Storage bucket used to store ephemeral 317 cluster and jobs data, such as Spark and MapReduce history files. If you 318 do not specify a temp bucket, Dataproc will determine a Cloud Storage 319 location (US, ASIA, or EU) for your cluster's temp bucket according to 320 the Compute Engine zone where your cluster is deployed, and then create 321 and manage this project-level, per-location bucket. The default bucket 322 has a TTL of 90 days, but you can use any TTL (or none) if you specify a 323 bucket. This field requires a Cloud Storage bucket name, not a URI to a 324 Cloud Storage bucket. 325 workerConfig: Optional. The Compute Engine config settings for worker 326 instances in a cluster. 327 """ 328 329 autoscalingConfig = _messages.MessageField('AutoscalingConfig', 1) 330 configBucket = _messages.StringField(2) 331 encryptionConfig = _messages.MessageField('EncryptionConfig', 3) 332 endpointConfig = _messages.MessageField('EndpointConfig', 4) 333 gceClusterConfig = _messages.MessageField('GceClusterConfig', 5) 334 gkeClusterConfig = _messages.MessageField('GkeClusterConfig', 6) 335 initializationActions = _messages.MessageField('NodeInitializationAction', 7, repeated=True) 336 lifecycleConfig = _messages.MessageField('LifecycleConfig', 8) 337 masterConfig = _messages.MessageField('InstanceGroupConfig', 9) 338 metastoreConfig = _messages.MessageField('MetastoreConfig', 10) 339 secondaryWorkerConfig = _messages.MessageField('InstanceGroupConfig', 11) 340 securityConfig = _messages.MessageField('SecurityConfig', 12) 341 softwareConfig = _messages.MessageField('SoftwareConfig', 13) 342 tempBucket = _messages.StringField(14) 343 workerConfig = _messages.MessageField('InstanceGroupConfig', 15) 344 345 346class ClusterMetrics(_messages.Message): 347 r"""Contains cluster daemon metrics, such as HDFS and YARN stats.Beta 348 Feature: This report is available for testing purposes only. It may be 349 changed before final release. 350 351 Messages: 352 HdfsMetricsValue: The HDFS metrics. 353 YarnMetricsValue: The YARN metrics. 354 355 Fields: 356 hdfsMetrics: The HDFS metrics. 357 yarnMetrics: The YARN metrics. 358 """ 359 360 @encoding.MapUnrecognizedFields('additionalProperties') 361 class HdfsMetricsValue(_messages.Message): 362 r"""The HDFS metrics. 363 364 Messages: 365 AdditionalProperty: An additional property for a HdfsMetricsValue 366 object. 367 368 Fields: 369 additionalProperties: Additional properties of type HdfsMetricsValue 370 """ 371 372 class AdditionalProperty(_messages.Message): 373 r"""An additional property for a HdfsMetricsValue object. 374 375 Fields: 376 key: Name of the additional property. 377 value: A string attribute. 378 """ 379 380 key = _messages.StringField(1) 381 value = _messages.IntegerField(2) 382 383 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 384 385 @encoding.MapUnrecognizedFields('additionalProperties') 386 class YarnMetricsValue(_messages.Message): 387 r"""The YARN metrics. 388 389 Messages: 390 AdditionalProperty: An additional property for a YarnMetricsValue 391 object. 392 393 Fields: 394 additionalProperties: Additional properties of type YarnMetricsValue 395 """ 396 397 class AdditionalProperty(_messages.Message): 398 r"""An additional property for a YarnMetricsValue object. 399 400 Fields: 401 key: Name of the additional property. 402 value: A string attribute. 403 """ 404 405 key = _messages.StringField(1) 406 value = _messages.IntegerField(2) 407 408 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 409 410 hdfsMetrics = _messages.MessageField('HdfsMetricsValue', 1) 411 yarnMetrics = _messages.MessageField('YarnMetricsValue', 2) 412 413 414class ClusterOperation(_messages.Message): 415 r"""The cluster operation triggered by a workflow. 416 417 Fields: 418 done: Output only. Indicates the operation is done. 419 error: Output only. Error, if operation failed. 420 operationId: Output only. The id of the cluster operation. 421 """ 422 423 done = _messages.BooleanField(1) 424 error = _messages.StringField(2) 425 operationId = _messages.StringField(3) 426 427 428class ClusterOperationMetadata(_messages.Message): 429 r"""Metadata describing the operation. 430 431 Messages: 432 LabelsValue: Output only. Labels associated with the operation 433 434 Fields: 435 clusterName: Output only. Name of the cluster for the operation. 436 clusterUuid: Output only. Cluster UUID for the operation. 437 description: Output only. Short description of operation. 438 labels: Output only. Labels associated with the operation 439 operationType: Output only. The operation type. 440 status: Output only. Current operation status. 441 statusHistory: Output only. The previous operation status. 442 warnings: Output only. Errors encountered during operation execution. 443 """ 444 445 @encoding.MapUnrecognizedFields('additionalProperties') 446 class LabelsValue(_messages.Message): 447 r"""Output only. Labels associated with the operation 448 449 Messages: 450 AdditionalProperty: An additional property for a LabelsValue object. 451 452 Fields: 453 additionalProperties: Additional properties of type LabelsValue 454 """ 455 456 class AdditionalProperty(_messages.Message): 457 r"""An additional property for a LabelsValue object. 458 459 Fields: 460 key: Name of the additional property. 461 value: A string attribute. 462 """ 463 464 key = _messages.StringField(1) 465 value = _messages.StringField(2) 466 467 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 468 469 clusterName = _messages.StringField(1) 470 clusterUuid = _messages.StringField(2) 471 description = _messages.StringField(3) 472 labels = _messages.MessageField('LabelsValue', 4) 473 operationType = _messages.StringField(5) 474 status = _messages.MessageField('ClusterOperationStatus', 6) 475 statusHistory = _messages.MessageField('ClusterOperationStatus', 7, repeated=True) 476 warnings = _messages.StringField(8, repeated=True) 477 478 479class ClusterOperationStatus(_messages.Message): 480 r"""The status of the operation. 481 482 Enums: 483 StateValueValuesEnum: Output only. A message containing the operation 484 state. 485 486 Fields: 487 details: Output only. A message containing any operation metadata details. 488 innerState: Output only. A message containing the detailed operation 489 state. 490 state: Output only. A message containing the operation state. 491 stateStartTime: Output only. The time this state was entered. 492 """ 493 494 class StateValueValuesEnum(_messages.Enum): 495 r"""Output only. A message containing the operation state. 496 497 Values: 498 UNKNOWN: Unused. 499 PENDING: The operation has been created. 500 RUNNING: The operation is running. 501 DONE: The operation is done; either cancelled or completed. 502 """ 503 UNKNOWN = 0 504 PENDING = 1 505 RUNNING = 2 506 DONE = 3 507 508 details = _messages.StringField(1) 509 innerState = _messages.StringField(2) 510 state = _messages.EnumField('StateValueValuesEnum', 3) 511 stateStartTime = _messages.StringField(4) 512 513 514class ClusterSelector(_messages.Message): 515 r"""A selector that chooses target cluster for jobs based on metadata. 516 517 Messages: 518 ClusterLabelsValue: Required. The cluster labels. Cluster must have all 519 labels to match. 520 521 Fields: 522 clusterLabels: Required. The cluster labels. Cluster must have all labels 523 to match. 524 zone: Optional. The zone where workflow process executes. This parameter 525 does not affect the selection of the cluster.If unspecified, the zone of 526 the first cluster matching the selector is used. 527 """ 528 529 @encoding.MapUnrecognizedFields('additionalProperties') 530 class ClusterLabelsValue(_messages.Message): 531 r"""Required. The cluster labels. Cluster must have all labels to match. 532 533 Messages: 534 AdditionalProperty: An additional property for a ClusterLabelsValue 535 object. 536 537 Fields: 538 additionalProperties: Additional properties of type ClusterLabelsValue 539 """ 540 541 class AdditionalProperty(_messages.Message): 542 r"""An additional property for a ClusterLabelsValue object. 543 544 Fields: 545 key: Name of the additional property. 546 value: A string attribute. 547 """ 548 549 key = _messages.StringField(1) 550 value = _messages.StringField(2) 551 552 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 553 554 clusterLabels = _messages.MessageField('ClusterLabelsValue', 1) 555 zone = _messages.StringField(2) 556 557 558class ClusterStatus(_messages.Message): 559 r"""The status of a cluster and its instances. 560 561 Enums: 562 StateValueValuesEnum: Output only. The cluster's state. 563 SubstateValueValuesEnum: Output only. Additional state information that 564 includes status reported by the agent. 565 566 Fields: 567 detail: Output only. Optional details of cluster's state. 568 state: Output only. The cluster's state. 569 stateStartTime: Output only. Time when this state was entered (see JSON 570 representation of Timestamp (https://developers.google.com/protocol- 571 buffers/docs/proto3#json)). 572 substate: Output only. Additional state information that includes status 573 reported by the agent. 574 """ 575 576 class StateValueValuesEnum(_messages.Enum): 577 r"""Output only. The cluster's state. 578 579 Values: 580 UNKNOWN: The cluster state is unknown. 581 CREATING: The cluster is being created and set up. It is not ready for 582 use. 583 RUNNING: The cluster is currently running and healthy. It is ready for 584 use. 585 ERROR: The cluster encountered an error. It is not ready for use. 586 DELETING: The cluster is being deleted. It cannot be used. 587 UPDATING: The cluster is being updated. It continues to accept and 588 process jobs. 589 STOPPING: The cluster is being stopped. It cannot be used. 590 STOPPED: The cluster is currently stopped. It is not ready for use. 591 STARTING: The cluster is being started. It is not ready for use. 592 """ 593 UNKNOWN = 0 594 CREATING = 1 595 RUNNING = 2 596 ERROR = 3 597 DELETING = 4 598 UPDATING = 5 599 STOPPING = 6 600 STOPPED = 7 601 STARTING = 8 602 603 class SubstateValueValuesEnum(_messages.Enum): 604 r"""Output only. Additional state information that includes status 605 reported by the agent. 606 607 Values: 608 UNSPECIFIED: The cluster substate is unknown. 609 UNHEALTHY: The cluster is known to be in an unhealthy state (for 610 example, critical daemons are not running or HDFS capacity is 611 exhausted).Applies to RUNNING state. 612 STALE_STATUS: The agent-reported status is out of date (may occur if 613 Dataproc loses communication with Agent).Applies to RUNNING state. 614 """ 615 UNSPECIFIED = 0 616 UNHEALTHY = 1 617 STALE_STATUS = 2 618 619 detail = _messages.StringField(1) 620 state = _messages.EnumField('StateValueValuesEnum', 2) 621 stateStartTime = _messages.StringField(3) 622 substate = _messages.EnumField('SubstateValueValuesEnum', 4) 623 624 625class DataprocProjectsLocationsAutoscalingPoliciesCreateRequest(_messages.Message): 626 r"""A DataprocProjectsLocationsAutoscalingPoliciesCreateRequest object. 627 628 Fields: 629 autoscalingPolicy: A AutoscalingPolicy resource to be passed as the 630 request body. 631 parent: Required. The "resource name" of the region or location, as 632 described in https://cloud.google.com/apis/design/resource_names. For 633 projects.regions.autoscalingPolicies.create, the resource name has the 634 following format: projects/{project_id}/regions/{region} For 635 projects.locations.autoscalingPolicies.create, the resource name has the 636 following format: projects/{project_id}/locations/{location} 637 """ 638 639 autoscalingPolicy = _messages.MessageField('AutoscalingPolicy', 1) 640 parent = _messages.StringField(2, required=True) 641 642 643class DataprocProjectsLocationsAutoscalingPoliciesDeleteRequest(_messages.Message): 644 r"""A DataprocProjectsLocationsAutoscalingPoliciesDeleteRequest object. 645 646 Fields: 647 name: Required. The "resource name" of the autoscaling policy, as 648 described in https://cloud.google.com/apis/design/resource_names. For 649 projects.regions.autoscalingPolicies.delete, the resource name of the 650 policy has the following format: 651 projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} 652 For projects.locations.autoscalingPolicies.delete, the resource name of 653 the policy has the following format: projects/{project_id}/locations/{lo 654 cation}/autoscalingPolicies/{policy_id} 655 """ 656 657 name = _messages.StringField(1, required=True) 658 659 660class DataprocProjectsLocationsAutoscalingPoliciesGetIamPolicyRequest(_messages.Message): 661 r"""A DataprocProjectsLocationsAutoscalingPoliciesGetIamPolicyRequest 662 object. 663 664 Fields: 665 options_requestedPolicyVersion: Optional. The policy format version to be 666 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 667 value will be rejected.Requests for policies with any conditional 668 bindings must specify version 3. Policies without any conditional 669 bindings may specify any valid value or leave the field unset.To learn 670 which resources support conditions in their IAM policies, see the IAM 671 documentation (https://cloud.google.com/iam/help/conditions/resource- 672 policies). 673 resource: REQUIRED: The resource for which the policy is being requested. 674 See the operation documentation for the appropriate value for this 675 field. 676 """ 677 678 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 679 resource = _messages.StringField(2, required=True) 680 681 682class DataprocProjectsLocationsAutoscalingPoliciesGetRequest(_messages.Message): 683 r"""A DataprocProjectsLocationsAutoscalingPoliciesGetRequest object. 684 685 Fields: 686 name: Required. The "resource name" of the autoscaling policy, as 687 described in https://cloud.google.com/apis/design/resource_names. For 688 projects.regions.autoscalingPolicies.get, the resource name of the 689 policy has the following format: 690 projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} 691 For projects.locations.autoscalingPolicies.get, the resource name of the 692 policy has the following format: projects/{project_id}/locations/{locati 693 on}/autoscalingPolicies/{policy_id} 694 """ 695 696 name = _messages.StringField(1, required=True) 697 698 699class DataprocProjectsLocationsAutoscalingPoliciesListRequest(_messages.Message): 700 r"""A DataprocProjectsLocationsAutoscalingPoliciesListRequest object. 701 702 Fields: 703 pageSize: Optional. The maximum number of results to return in each 704 response. Must be less than or equal to 1000. Defaults to 100. 705 pageToken: Optional. The page token, returned by a previous call, to 706 request the next page of results. 707 parent: Required. The "resource name" of the region or location, as 708 described in https://cloud.google.com/apis/design/resource_names. For 709 projects.regions.autoscalingPolicies.list, the resource name of the 710 region has the following format: projects/{project_id}/regions/{region} 711 For projects.locations.autoscalingPolicies.list, the resource name of 712 the location has the following format: 713 projects/{project_id}/locations/{location} 714 """ 715 716 pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) 717 pageToken = _messages.StringField(2) 718 parent = _messages.StringField(3, required=True) 719 720 721class DataprocProjectsLocationsAutoscalingPoliciesSetIamPolicyRequest(_messages.Message): 722 r"""A DataprocProjectsLocationsAutoscalingPoliciesSetIamPolicyRequest 723 object. 724 725 Fields: 726 resource: REQUIRED: The resource for which the policy is being specified. 727 See the operation documentation for the appropriate value for this 728 field. 729 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 730 request body. 731 """ 732 733 resource = _messages.StringField(1, required=True) 734 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 735 736 737class DataprocProjectsLocationsAutoscalingPoliciesTestIamPermissionsRequest(_messages.Message): 738 r"""A DataprocProjectsLocationsAutoscalingPoliciesTestIamPermissionsRequest 739 object. 740 741 Fields: 742 resource: REQUIRED: The resource for which the policy detail is being 743 requested. See the operation documentation for the appropriate value for 744 this field. 745 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 746 passed as the request body. 747 """ 748 749 resource = _messages.StringField(1, required=True) 750 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 751 752 753class DataprocProjectsLocationsWorkflowTemplatesCreateRequest(_messages.Message): 754 r"""A DataprocProjectsLocationsWorkflowTemplatesCreateRequest object. 755 756 Fields: 757 parent: Required. The resource name of the region or location, as 758 described in https://cloud.google.com/apis/design/resource_names. For 759 projects.regions.workflowTemplates,create, the resource name of the 760 region has the following format: projects/{project_id}/regions/{region} 761 For projects.locations.workflowTemplates.create, the resource name of 762 the location has the following format: 763 projects/{project_id}/locations/{location} 764 workflowTemplate: A WorkflowTemplate resource to be passed as the request 765 body. 766 """ 767 768 parent = _messages.StringField(1, required=True) 769 workflowTemplate = _messages.MessageField('WorkflowTemplate', 2) 770 771 772class DataprocProjectsLocationsWorkflowTemplatesDeleteRequest(_messages.Message): 773 r"""A DataprocProjectsLocationsWorkflowTemplatesDeleteRequest object. 774 775 Fields: 776 name: Required. The resource name of the workflow template, as described 777 in https://cloud.google.com/apis/design/resource_names. For 778 projects.regions.workflowTemplates.delete, the resource name of the 779 template has the following format: 780 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 781 For projects.locations.workflowTemplates.instantiate, the resource name 782 of the template has the following format: projects/{project_id}/location 783 s/{location}/workflowTemplates/{template_id} 784 version: Optional. The version of workflow template to delete. If 785 specified, will only delete the template if the current server version 786 matches specified version. 787 """ 788 789 name = _messages.StringField(1, required=True) 790 version = _messages.IntegerField(2, variant=_messages.Variant.INT32) 791 792 793class DataprocProjectsLocationsWorkflowTemplatesGetIamPolicyRequest(_messages.Message): 794 r"""A DataprocProjectsLocationsWorkflowTemplatesGetIamPolicyRequest object. 795 796 Fields: 797 options_requestedPolicyVersion: Optional. The policy format version to be 798 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 799 value will be rejected.Requests for policies with any conditional 800 bindings must specify version 3. Policies without any conditional 801 bindings may specify any valid value or leave the field unset.To learn 802 which resources support conditions in their IAM policies, see the IAM 803 documentation (https://cloud.google.com/iam/help/conditions/resource- 804 policies). 805 resource: REQUIRED: The resource for which the policy is being requested. 806 See the operation documentation for the appropriate value for this 807 field. 808 """ 809 810 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 811 resource = _messages.StringField(2, required=True) 812 813 814class DataprocProjectsLocationsWorkflowTemplatesGetRequest(_messages.Message): 815 r"""A DataprocProjectsLocationsWorkflowTemplatesGetRequest object. 816 817 Fields: 818 name: Required. The resource name of the workflow template, as described 819 in https://cloud.google.com/apis/design/resource_names. For 820 projects.regions.workflowTemplates.get, the resource name of the 821 template has the following format: 822 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 823 For projects.locations.workflowTemplates.get, the resource name of the 824 template has the following format: projects/{project_id}/locations/{loca 825 tion}/workflowTemplates/{template_id} 826 version: Optional. The version of workflow template to retrieve. Only 827 previously instantiated versions can be retrieved.If unspecified, 828 retrieves the current version. 829 """ 830 831 name = _messages.StringField(1, required=True) 832 version = _messages.IntegerField(2, variant=_messages.Variant.INT32) 833 834 835class DataprocProjectsLocationsWorkflowTemplatesInstantiateInlineRequest(_messages.Message): 836 r"""A DataprocProjectsLocationsWorkflowTemplatesInstantiateInlineRequest 837 object. 838 839 Fields: 840 instanceId: Deprecated. Please use request_id field instead. 841 parent: Required. The resource name of the region or location, as 842 described in https://cloud.google.com/apis/design/resource_names. For 843 projects.regions.workflowTemplates,instantiateinline, the resource name 844 of the region has the following format: 845 projects/{project_id}/regions/{region} For 846 projects.locations.workflowTemplates.instantiateinline, the resource 847 name of the location has the following format: 848 projects/{project_id}/locations/{location} 849 requestId: Optional. A tag that prevents multiple concurrent workflow 850 instances with the same tag from running. This mitigates risk of 851 concurrent instances started due to retries.It is recommended to always 852 set this value to a UUID 853 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag 854 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 855 and hyphens (-). The maximum length is 40 characters. 856 workflowTemplate: A WorkflowTemplate resource to be passed as the request 857 body. 858 """ 859 860 instanceId = _messages.StringField(1) 861 parent = _messages.StringField(2, required=True) 862 requestId = _messages.StringField(3) 863 workflowTemplate = _messages.MessageField('WorkflowTemplate', 4) 864 865 866class DataprocProjectsLocationsWorkflowTemplatesInstantiateRequest(_messages.Message): 867 r"""A DataprocProjectsLocationsWorkflowTemplatesInstantiateRequest object. 868 869 Fields: 870 instantiateWorkflowTemplateRequest: A InstantiateWorkflowTemplateRequest 871 resource to be passed as the request body. 872 name: Required. The resource name of the workflow template, as described 873 in https://cloud.google.com/apis/design/resource_names. For 874 projects.regions.workflowTemplates.instantiate, the resource name of the 875 template has the following format: 876 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 877 For projects.locations.workflowTemplates.instantiate, the resource name 878 of the template has the following format: projects/{project_id}/location 879 s/{location}/workflowTemplates/{template_id} 880 """ 881 882 instantiateWorkflowTemplateRequest = _messages.MessageField('InstantiateWorkflowTemplateRequest', 1) 883 name = _messages.StringField(2, required=True) 884 885 886class DataprocProjectsLocationsWorkflowTemplatesListRequest(_messages.Message): 887 r"""A DataprocProjectsLocationsWorkflowTemplatesListRequest object. 888 889 Fields: 890 pageSize: Optional. The maximum number of results to return in each 891 response. 892 pageToken: Optional. The page token, returned by a previous call, to 893 request the next page of results. 894 parent: Required. The resource name of the region or location, as 895 described in https://cloud.google.com/apis/design/resource_names. For 896 projects.regions.workflowTemplates,list, the resource name of the region 897 has the following format: projects/{project_id}/regions/{region} For 898 projects.locations.workflowTemplates.list, the resource name of the 899 location has the following format: 900 projects/{project_id}/locations/{location} 901 """ 902 903 pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) 904 pageToken = _messages.StringField(2) 905 parent = _messages.StringField(3, required=True) 906 907 908class DataprocProjectsLocationsWorkflowTemplatesSetIamPolicyRequest(_messages.Message): 909 r"""A DataprocProjectsLocationsWorkflowTemplatesSetIamPolicyRequest object. 910 911 Fields: 912 resource: REQUIRED: The resource for which the policy is being specified. 913 See the operation documentation for the appropriate value for this 914 field. 915 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 916 request body. 917 """ 918 919 resource = _messages.StringField(1, required=True) 920 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 921 922 923class DataprocProjectsLocationsWorkflowTemplatesTestIamPermissionsRequest(_messages.Message): 924 r"""A DataprocProjectsLocationsWorkflowTemplatesTestIamPermissionsRequest 925 object. 926 927 Fields: 928 resource: REQUIRED: The resource for which the policy detail is being 929 requested. See the operation documentation for the appropriate value for 930 this field. 931 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 932 passed as the request body. 933 """ 934 935 resource = _messages.StringField(1, required=True) 936 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 937 938 939class DataprocProjectsRegionsAutoscalingPoliciesCreateRequest(_messages.Message): 940 r"""A DataprocProjectsRegionsAutoscalingPoliciesCreateRequest object. 941 942 Fields: 943 autoscalingPolicy: A AutoscalingPolicy resource to be passed as the 944 request body. 945 parent: Required. The "resource name" of the region or location, as 946 described in https://cloud.google.com/apis/design/resource_names. For 947 projects.regions.autoscalingPolicies.create, the resource name has the 948 following format: projects/{project_id}/regions/{region} For 949 projects.locations.autoscalingPolicies.create, the resource name has the 950 following format: projects/{project_id}/locations/{location} 951 """ 952 953 autoscalingPolicy = _messages.MessageField('AutoscalingPolicy', 1) 954 parent = _messages.StringField(2, required=True) 955 956 957class DataprocProjectsRegionsAutoscalingPoliciesDeleteRequest(_messages.Message): 958 r"""A DataprocProjectsRegionsAutoscalingPoliciesDeleteRequest object. 959 960 Fields: 961 name: Required. The "resource name" of the autoscaling policy, as 962 described in https://cloud.google.com/apis/design/resource_names. For 963 projects.regions.autoscalingPolicies.delete, the resource name of the 964 policy has the following format: 965 projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} 966 For projects.locations.autoscalingPolicies.delete, the resource name of 967 the policy has the following format: projects/{project_id}/locations/{lo 968 cation}/autoscalingPolicies/{policy_id} 969 """ 970 971 name = _messages.StringField(1, required=True) 972 973 974class DataprocProjectsRegionsAutoscalingPoliciesGetIamPolicyRequest(_messages.Message): 975 r"""A DataprocProjectsRegionsAutoscalingPoliciesGetIamPolicyRequest object. 976 977 Fields: 978 options_requestedPolicyVersion: Optional. The policy format version to be 979 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 980 value will be rejected.Requests for policies with any conditional 981 bindings must specify version 3. Policies without any conditional 982 bindings may specify any valid value or leave the field unset.To learn 983 which resources support conditions in their IAM policies, see the IAM 984 documentation (https://cloud.google.com/iam/help/conditions/resource- 985 policies). 986 resource: REQUIRED: The resource for which the policy is being requested. 987 See the operation documentation for the appropriate value for this 988 field. 989 """ 990 991 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 992 resource = _messages.StringField(2, required=True) 993 994 995class DataprocProjectsRegionsAutoscalingPoliciesGetRequest(_messages.Message): 996 r"""A DataprocProjectsRegionsAutoscalingPoliciesGetRequest object. 997 998 Fields: 999 name: Required. The "resource name" of the autoscaling policy, as 1000 described in https://cloud.google.com/apis/design/resource_names. For 1001 projects.regions.autoscalingPolicies.get, the resource name of the 1002 policy has the following format: 1003 projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} 1004 For projects.locations.autoscalingPolicies.get, the resource name of the 1005 policy has the following format: projects/{project_id}/locations/{locati 1006 on}/autoscalingPolicies/{policy_id} 1007 """ 1008 1009 name = _messages.StringField(1, required=True) 1010 1011 1012class DataprocProjectsRegionsAutoscalingPoliciesListRequest(_messages.Message): 1013 r"""A DataprocProjectsRegionsAutoscalingPoliciesListRequest object. 1014 1015 Fields: 1016 pageSize: Optional. The maximum number of results to return in each 1017 response. Must be less than or equal to 1000. Defaults to 100. 1018 pageToken: Optional. The page token, returned by a previous call, to 1019 request the next page of results. 1020 parent: Required. The "resource name" of the region or location, as 1021 described in https://cloud.google.com/apis/design/resource_names. For 1022 projects.regions.autoscalingPolicies.list, the resource name of the 1023 region has the following format: projects/{project_id}/regions/{region} 1024 For projects.locations.autoscalingPolicies.list, the resource name of 1025 the location has the following format: 1026 projects/{project_id}/locations/{location} 1027 """ 1028 1029 pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1030 pageToken = _messages.StringField(2) 1031 parent = _messages.StringField(3, required=True) 1032 1033 1034class DataprocProjectsRegionsAutoscalingPoliciesSetIamPolicyRequest(_messages.Message): 1035 r"""A DataprocProjectsRegionsAutoscalingPoliciesSetIamPolicyRequest object. 1036 1037 Fields: 1038 resource: REQUIRED: The resource for which the policy is being specified. 1039 See the operation documentation for the appropriate value for this 1040 field. 1041 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 1042 request body. 1043 """ 1044 1045 resource = _messages.StringField(1, required=True) 1046 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 1047 1048 1049class DataprocProjectsRegionsAutoscalingPoliciesTestIamPermissionsRequest(_messages.Message): 1050 r"""A DataprocProjectsRegionsAutoscalingPoliciesTestIamPermissionsRequest 1051 object. 1052 1053 Fields: 1054 resource: REQUIRED: The resource for which the policy detail is being 1055 requested. See the operation documentation for the appropriate value for 1056 this field. 1057 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 1058 passed as the request body. 1059 """ 1060 1061 resource = _messages.StringField(1, required=True) 1062 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 1063 1064 1065class DataprocProjectsRegionsClustersCreateRequest(_messages.Message): 1066 r"""A DataprocProjectsRegionsClustersCreateRequest object. 1067 1068 Enums: 1069 DeleteOnFailureValueValuesEnum: Optional. The target to delete on cluster 1070 creation failure. 1071 DiagnoseOnFailureValueValuesEnum: Optional. The diagnose action to run on 1072 cluster creation failure. 1073 1074 Fields: 1075 cluster: A Cluster resource to be passed as the request body. 1076 deleteOnFailure: Optional. The target to delete on cluster creation 1077 failure. 1078 diagnoseOnFailure: Optional. The diagnose action to run on cluster 1079 creation failure. 1080 projectId: Required. The ID of the Google Cloud Platform project that the 1081 cluster belongs to. 1082 region: Required. The Dataproc region in which to handle the request. 1083 requestId: Optional. A unique id used to identify the request. If the 1084 server receives two CreateClusterRequest (https://cloud.google.com/datap 1085 roc/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.datapr 1086 oc.v1beta2.CreateClusterRequest)s with the same id, then the second 1087 request will be ignored and the first google.longrunning.Operation 1088 created and stored in the backend is returned.It is recommended to 1089 always set this value to a UUID 1090 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id 1091 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 1092 and hyphens (-). The maximum length is 40 characters. 1093 """ 1094 1095 class DeleteOnFailureValueValuesEnum(_messages.Enum): 1096 r"""Optional. The target to delete on cluster creation failure. 1097 1098 Values: 1099 DELETE_TARGET_UNSPECIFIED: The default option meaning no target was 1100 specified. 1101 NOTHING: The option to explicitly not delete anything on creation 1102 failure. 1103 RESOURCES: The option to only delete cluster resources (such as GCE VMs) 1104 on creation failure. 1105 CLUSTER: The option to delete the whole cluster including its resources 1106 on creation failure. 1107 """ 1108 DELETE_TARGET_UNSPECIFIED = 0 1109 NOTHING = 1 1110 RESOURCES = 2 1111 CLUSTER = 3 1112 1113 class DiagnoseOnFailureValueValuesEnum(_messages.Enum): 1114 r"""Optional. The diagnose action to run on cluster creation failure. 1115 1116 Values: 1117 DIAGNOSE_ACTION_UNSPECIFIED: The default option meaning no action was 1118 specified. 1119 NONE: The option to explicitly not run cluster diagnose on creation 1120 failure. 1121 DIAGNOSE_CLUSTER: The option to run cluster diagnose on creation 1122 failure. 1123 """ 1124 DIAGNOSE_ACTION_UNSPECIFIED = 0 1125 NONE = 1 1126 DIAGNOSE_CLUSTER = 2 1127 1128 cluster = _messages.MessageField('Cluster', 1) 1129 deleteOnFailure = _messages.EnumField('DeleteOnFailureValueValuesEnum', 2) 1130 diagnoseOnFailure = _messages.EnumField('DiagnoseOnFailureValueValuesEnum', 3) 1131 projectId = _messages.StringField(4, required=True) 1132 region = _messages.StringField(5, required=True) 1133 requestId = _messages.StringField(6) 1134 1135 1136class DataprocProjectsRegionsClustersDeleteRequest(_messages.Message): 1137 r"""A DataprocProjectsRegionsClustersDeleteRequest object. 1138 1139 Fields: 1140 clusterName: Required. The cluster name. 1141 clusterUuid: Optional. Specifying the cluster_uuid means the RPC should 1142 fail (with error NOT_FOUND) if cluster with specified UUID does not 1143 exist. 1144 projectId: Required. The ID of the Google Cloud Platform project that the 1145 cluster belongs to. 1146 region: Required. The Dataproc region in which to handle the request. 1147 requestId: Optional. A unique id used to identify the request. If the 1148 server receives two DeleteClusterRequest (https://cloud.google.com/datap 1149 roc/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.datapr 1150 oc.v1beta2.DeleteClusterRequest)s with the same id, then the second 1151 request will be ignored and the first google.longrunning.Operation 1152 created and stored in the backend is returned.It is recommended to 1153 always set this value to a UUID 1154 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id 1155 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 1156 and hyphens (-). The maximum length is 40 characters. 1157 """ 1158 1159 clusterName = _messages.StringField(1, required=True) 1160 clusterUuid = _messages.StringField(2) 1161 projectId = _messages.StringField(3, required=True) 1162 region = _messages.StringField(4, required=True) 1163 requestId = _messages.StringField(5) 1164 1165 1166class DataprocProjectsRegionsClustersDiagnoseRequest(_messages.Message): 1167 r"""A DataprocProjectsRegionsClustersDiagnoseRequest object. 1168 1169 Fields: 1170 clusterName: Required. The cluster name. 1171 diagnoseClusterRequest: A DiagnoseClusterRequest resource to be passed as 1172 the request body. 1173 projectId: Required. The ID of the Google Cloud Platform project that the 1174 cluster belongs to. 1175 region: Required. The Dataproc region in which to handle the request. 1176 """ 1177 1178 clusterName = _messages.StringField(1, required=True) 1179 diagnoseClusterRequest = _messages.MessageField('DiagnoseClusterRequest', 2) 1180 projectId = _messages.StringField(3, required=True) 1181 region = _messages.StringField(4, required=True) 1182 1183 1184class DataprocProjectsRegionsClustersGetClusterAsTemplateRequest(_messages.Message): 1185 r"""A DataprocProjectsRegionsClustersGetClusterAsTemplateRequest object. 1186 1187 Fields: 1188 clusterName: Required. The cluster name. 1189 projectId: Required. The ID of the Google Cloud Platform project that the 1190 cluster belongs to. 1191 region: Required. The Dataproc region in which to handle the request. 1192 """ 1193 1194 clusterName = _messages.StringField(1, required=True) 1195 projectId = _messages.StringField(2, required=True) 1196 region = _messages.StringField(3, required=True) 1197 1198 1199class DataprocProjectsRegionsClustersGetIamPolicyRequest(_messages.Message): 1200 r"""A DataprocProjectsRegionsClustersGetIamPolicyRequest object. 1201 1202 Fields: 1203 options_requestedPolicyVersion: Optional. The policy format version to be 1204 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 1205 value will be rejected.Requests for policies with any conditional 1206 bindings must specify version 3. Policies without any conditional 1207 bindings may specify any valid value or leave the field unset.To learn 1208 which resources support conditions in their IAM policies, see the IAM 1209 documentation (https://cloud.google.com/iam/help/conditions/resource- 1210 policies). 1211 resource: REQUIRED: The resource for which the policy is being requested. 1212 See the operation documentation for the appropriate value for this 1213 field. 1214 """ 1215 1216 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1217 resource = _messages.StringField(2, required=True) 1218 1219 1220class DataprocProjectsRegionsClustersGetRequest(_messages.Message): 1221 r"""A DataprocProjectsRegionsClustersGetRequest object. 1222 1223 Fields: 1224 clusterName: Required. The cluster name. 1225 projectId: Required. The ID of the Google Cloud Platform project that the 1226 cluster belongs to. 1227 region: Required. The Dataproc region in which to handle the request. 1228 """ 1229 1230 clusterName = _messages.StringField(1, required=True) 1231 projectId = _messages.StringField(2, required=True) 1232 region = _messages.StringField(3, required=True) 1233 1234 1235class DataprocProjectsRegionsClustersInjectCredentialsRequest(_messages.Message): 1236 r"""A DataprocProjectsRegionsClustersInjectCredentialsRequest object. 1237 1238 Fields: 1239 cluster: Required. The cluster, in the form clusters/. 1240 injectCredentialsRequest: A InjectCredentialsRequest resource to be passed 1241 as the request body. 1242 project: Required. The ID of the Google Cloud Platform project the cluster 1243 belongs to, of the form projects/. 1244 region: Required. The region containing the cluster, of the form regions/. 1245 """ 1246 1247 cluster = _messages.StringField(1, required=True) 1248 injectCredentialsRequest = _messages.MessageField('InjectCredentialsRequest', 2) 1249 project = _messages.StringField(3, required=True) 1250 region = _messages.StringField(4, required=True) 1251 1252 1253class DataprocProjectsRegionsClustersListRequest(_messages.Message): 1254 r"""A DataprocProjectsRegionsClustersListRequest object. 1255 1256 Fields: 1257 filter: Optional. A filter constraining the clusters to list. Filters are 1258 case-sensitive and have the following syntax:field = value AND field = 1259 value ...where field is one of status.state, clusterName, or 1260 labels.[KEY], and [KEY] is a label key. value can be * to match all 1261 values. status.state can be one of the following: ACTIVE, INACTIVE, 1262 CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the 1263 CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING 1264 and ERROR states. clusterName is the name of the cluster provided at 1265 creation time. Only the logical AND operator is supported; space- 1266 separated items are treated as having an implicit AND operator.Example 1267 filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env 1268 = staging AND labels.starred = * 1269 pageSize: Optional. The standard List page size. 1270 pageToken: Optional. The standard List page token. 1271 projectId: Required. The ID of the Google Cloud Platform project that the 1272 cluster belongs to. 1273 region: Required. The Dataproc region in which to handle the request. 1274 """ 1275 1276 filter = _messages.StringField(1) 1277 pageSize = _messages.IntegerField(2, variant=_messages.Variant.INT32) 1278 pageToken = _messages.StringField(3) 1279 projectId = _messages.StringField(4, required=True) 1280 region = _messages.StringField(5, required=True) 1281 1282 1283class DataprocProjectsRegionsClustersPatchRequest(_messages.Message): 1284 r"""A DataprocProjectsRegionsClustersPatchRequest object. 1285 1286 Fields: 1287 cluster: A Cluster resource to be passed as the request body. 1288 clusterName: Required. The cluster name. 1289 gracefulDecommissionTimeout: Optional. Timeout for graceful YARN 1290 decomissioning. Graceful decommissioning allows removing nodes from the 1291 cluster without interrupting jobs in progress. Timeout specifies how 1292 long to wait for jobs in progress to finish before forcefully removing 1293 nodes (and potentially interrupting jobs). Default timeout is 0 (for 1294 forceful decommission), and the maximum allowed timeout is 1 day (see 1295 JSON representation of Duration (https://developers.google.com/protocol- 1296 buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 1297 and higher. 1298 projectId: Required. The ID of the Google Cloud Platform project the 1299 cluster belongs to. 1300 region: Required. The Dataproc region in which to handle the request. 1301 requestId: Optional. A unique id used to identify the request. If the 1302 server receives two UpdateClusterRequest (https://cloud.google.com/datap 1303 roc/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.datapr 1304 oc.v1beta2.UpdateClusterRequest)s with the same id, then the second 1305 request will be ignored and the first google.longrunning.Operation 1306 created and stored in the backend is returned.It is recommended to 1307 always set this value to a UUID 1308 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id 1309 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 1310 and hyphens (-). The maximum length is 40 characters. 1311 updateMask: Required. Specifies the path, relative to Cluster, of the 1312 field to update. For example, to change the number of workers in a 1313 cluster to 5, the update_mask parameter would be specified as 1314 config.worker_config.num_instances, and the PATCH request body would 1315 specify the new value, as follows: { "config":{ "workerConfig":{ 1316 "numInstances":"5" } } } Similarly, to change the number of preemptible 1317 workers in a cluster to 5, the update_mask parameter would be 1318 config.secondary_worker_config.num_instances, and the PATCH request body 1319 would be set as follows: { "config":{ "secondaryWorkerConfig":{ 1320 "numInstances":"5" } } } *Note:* currently only the following fields can 1321 be updated: *Mask* *Purpose* labels Updates labels 1322 config.worker_config.num_instances Resize primary worker group 1323 config.secondary_worker_config.num_instances Resize secondary worker 1324 group config.lifecycle_config.auto_delete_ttl Reset MAX TTL duration 1325 config.lifecycle_config.auto_delete_time Update MAX TTL deletion 1326 timestamp config.lifecycle_config.idle_delete_ttl Update Idle TTL 1327 duration config.autoscaling_config.policy_uri Use, stop using, or change 1328 autoscaling policies 1329 """ 1330 1331 cluster = _messages.MessageField('Cluster', 1) 1332 clusterName = _messages.StringField(2, required=True) 1333 gracefulDecommissionTimeout = _messages.StringField(3) 1334 projectId = _messages.StringField(4, required=True) 1335 region = _messages.StringField(5, required=True) 1336 requestId = _messages.StringField(6) 1337 updateMask = _messages.StringField(7) 1338 1339 1340class DataprocProjectsRegionsClustersSetIamPolicyRequest(_messages.Message): 1341 r"""A DataprocProjectsRegionsClustersSetIamPolicyRequest object. 1342 1343 Fields: 1344 resource: REQUIRED: The resource for which the policy is being specified. 1345 See the operation documentation for the appropriate value for this 1346 field. 1347 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 1348 request body. 1349 """ 1350 1351 resource = _messages.StringField(1, required=True) 1352 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 1353 1354 1355class DataprocProjectsRegionsClustersStartRequest(_messages.Message): 1356 r"""A DataprocProjectsRegionsClustersStartRequest object. 1357 1358 Fields: 1359 clusterName: Required. The cluster name. 1360 projectId: Required. The ID of the Google Cloud Platform project the 1361 cluster belongs to. 1362 region: Required. The Dataproc region in which to handle the request. 1363 startClusterRequest: A StartClusterRequest resource to be passed as the 1364 request body. 1365 """ 1366 1367 clusterName = _messages.StringField(1, required=True) 1368 projectId = _messages.StringField(2, required=True) 1369 region = _messages.StringField(3, required=True) 1370 startClusterRequest = _messages.MessageField('StartClusterRequest', 4) 1371 1372 1373class DataprocProjectsRegionsClustersStopRequest(_messages.Message): 1374 r"""A DataprocProjectsRegionsClustersStopRequest object. 1375 1376 Fields: 1377 clusterName: Required. The cluster name. 1378 projectId: Required. The ID of the Google Cloud Platform project the 1379 cluster belongs to. 1380 region: Required. The Dataproc region in which to handle the request. 1381 stopClusterRequest: A StopClusterRequest resource to be passed as the 1382 request body. 1383 """ 1384 1385 clusterName = _messages.StringField(1, required=True) 1386 projectId = _messages.StringField(2, required=True) 1387 region = _messages.StringField(3, required=True) 1388 stopClusterRequest = _messages.MessageField('StopClusterRequest', 4) 1389 1390 1391class DataprocProjectsRegionsClustersTestIamPermissionsRequest(_messages.Message): 1392 r"""A DataprocProjectsRegionsClustersTestIamPermissionsRequest object. 1393 1394 Fields: 1395 resource: REQUIRED: The resource for which the policy detail is being 1396 requested. See the operation documentation for the appropriate value for 1397 this field. 1398 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 1399 passed as the request body. 1400 """ 1401 1402 resource = _messages.StringField(1, required=True) 1403 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 1404 1405 1406class DataprocProjectsRegionsJobsCancelRequest(_messages.Message): 1407 r"""A DataprocProjectsRegionsJobsCancelRequest object. 1408 1409 Fields: 1410 cancelJobRequest: A CancelJobRequest resource to be passed as the request 1411 body. 1412 jobId: Required. The job ID. 1413 projectId: Required. The ID of the Google Cloud Platform project that the 1414 job belongs to. 1415 region: Required. The Dataproc region in which to handle the request. 1416 """ 1417 1418 cancelJobRequest = _messages.MessageField('CancelJobRequest', 1) 1419 jobId = _messages.StringField(2, required=True) 1420 projectId = _messages.StringField(3, required=True) 1421 region = _messages.StringField(4, required=True) 1422 1423 1424class DataprocProjectsRegionsJobsDeleteRequest(_messages.Message): 1425 r"""A DataprocProjectsRegionsJobsDeleteRequest object. 1426 1427 Fields: 1428 jobId: Required. The job ID. 1429 projectId: Required. The ID of the Google Cloud Platform project that the 1430 job belongs to. 1431 region: Required. The Dataproc region in which to handle the request. 1432 """ 1433 1434 jobId = _messages.StringField(1, required=True) 1435 projectId = _messages.StringField(2, required=True) 1436 region = _messages.StringField(3, required=True) 1437 1438 1439class DataprocProjectsRegionsJobsGetIamPolicyRequest(_messages.Message): 1440 r"""A DataprocProjectsRegionsJobsGetIamPolicyRequest object. 1441 1442 Fields: 1443 options_requestedPolicyVersion: Optional. The policy format version to be 1444 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 1445 value will be rejected.Requests for policies with any conditional 1446 bindings must specify version 3. Policies without any conditional 1447 bindings may specify any valid value or leave the field unset.To learn 1448 which resources support conditions in their IAM policies, see the IAM 1449 documentation (https://cloud.google.com/iam/help/conditions/resource- 1450 policies). 1451 resource: REQUIRED: The resource for which the policy is being requested. 1452 See the operation documentation for the appropriate value for this 1453 field. 1454 """ 1455 1456 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1457 resource = _messages.StringField(2, required=True) 1458 1459 1460class DataprocProjectsRegionsJobsGetJobAsTemplateRequest(_messages.Message): 1461 r"""A DataprocProjectsRegionsJobsGetJobAsTemplateRequest object. 1462 1463 Fields: 1464 jobId: Required. The job ID. 1465 projectId: Required. The ID of the Google Cloud Platform project that the 1466 job belongs to. 1467 region: Required. The Dataproc region in which to handle the request. 1468 """ 1469 1470 jobId = _messages.StringField(1, required=True) 1471 projectId = _messages.StringField(2, required=True) 1472 region = _messages.StringField(3, required=True) 1473 1474 1475class DataprocProjectsRegionsJobsGetRequest(_messages.Message): 1476 r"""A DataprocProjectsRegionsJobsGetRequest object. 1477 1478 Fields: 1479 jobId: Required. The job ID. 1480 projectId: Required. The ID of the Google Cloud Platform project that the 1481 job belongs to. 1482 region: Required. The Dataproc region in which to handle the request. 1483 """ 1484 1485 jobId = _messages.StringField(1, required=True) 1486 projectId = _messages.StringField(2, required=True) 1487 region = _messages.StringField(3, required=True) 1488 1489 1490class DataprocProjectsRegionsJobsListRequest(_messages.Message): 1491 r"""A DataprocProjectsRegionsJobsListRequest object. 1492 1493 Enums: 1494 JobStateMatcherValueValuesEnum: Optional. Specifies enumerated categories 1495 of jobs to list. (default = match ALL jobs).If filter is provided, 1496 jobStateMatcher will be ignored. 1497 1498 Fields: 1499 clusterName: Optional. If set, the returned jobs list includes only jobs 1500 that were submitted to the named cluster. 1501 filter: Optional. A filter constraining the jobs to list. Filters are 1502 case-sensitive and have the following syntax:field = value AND field = 1503 value ...where field is status.state or labels.[KEY], and [KEY] is a 1504 label key. value can be * to match all values. status.state can be 1505 either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; 1506 space-separated items are treated as having an implicit AND 1507 operator.Example filter:status.state = ACTIVE AND labels.env = staging 1508 AND labels.starred = * 1509 jobStateMatcher: Optional. Specifies enumerated categories of jobs to 1510 list. (default = match ALL jobs).If filter is provided, jobStateMatcher 1511 will be ignored. 1512 pageSize: Optional. The number of results to return in each response. 1513 pageToken: Optional. The page token, returned by a previous call, to 1514 request the next page of results. 1515 projectId: Required. The ID of the Google Cloud Platform project that the 1516 job belongs to. 1517 region: Required. The Dataproc region in which to handle the request. 1518 """ 1519 1520 class JobStateMatcherValueValuesEnum(_messages.Enum): 1521 r"""Optional. Specifies enumerated categories of jobs to list. (default = 1522 match ALL jobs).If filter is provided, jobStateMatcher will be ignored. 1523 1524 Values: 1525 ALL: Match all jobs, regardless of state. 1526 ACTIVE: Only match jobs in non-terminal states: PENDING, RUNNING, or 1527 CANCEL_PENDING. 1528 NON_ACTIVE: Only match jobs in terminal states: CANCELLED, DONE, or 1529 ERROR. 1530 """ 1531 ALL = 0 1532 ACTIVE = 1 1533 NON_ACTIVE = 2 1534 1535 clusterName = _messages.StringField(1) 1536 filter = _messages.StringField(2) 1537 jobStateMatcher = _messages.EnumField('JobStateMatcherValueValuesEnum', 3) 1538 pageSize = _messages.IntegerField(4, variant=_messages.Variant.INT32) 1539 pageToken = _messages.StringField(5) 1540 projectId = _messages.StringField(6, required=True) 1541 region = _messages.StringField(7, required=True) 1542 1543 1544class DataprocProjectsRegionsJobsPatchRequest(_messages.Message): 1545 r"""A DataprocProjectsRegionsJobsPatchRequest object. 1546 1547 Fields: 1548 job: A Job resource to be passed as the request body. 1549 jobId: Required. The job ID. 1550 projectId: Required. The ID of the Google Cloud Platform project that the 1551 job belongs to. 1552 region: Required. The Dataproc region in which to handle the request. 1553 updateMask: Required. Specifies the path, relative to Job, of the field to 1554 update. For example, to update the labels of a Job the update_mask 1555 parameter would be specified as labels, and the PATCH request body would 1556 specify the new value. *Note:* Currently, labels is the only field that 1557 can be updated. 1558 """ 1559 1560 job = _messages.MessageField('Job', 1) 1561 jobId = _messages.StringField(2, required=True) 1562 projectId = _messages.StringField(3, required=True) 1563 region = _messages.StringField(4, required=True) 1564 updateMask = _messages.StringField(5) 1565 1566 1567class DataprocProjectsRegionsJobsSetIamPolicyRequest(_messages.Message): 1568 r"""A DataprocProjectsRegionsJobsSetIamPolicyRequest object. 1569 1570 Fields: 1571 resource: REQUIRED: The resource for which the policy is being specified. 1572 See the operation documentation for the appropriate value for this 1573 field. 1574 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 1575 request body. 1576 """ 1577 1578 resource = _messages.StringField(1, required=True) 1579 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 1580 1581 1582class DataprocProjectsRegionsJobsSubmitAsOperationRequest(_messages.Message): 1583 r"""A DataprocProjectsRegionsJobsSubmitAsOperationRequest object. 1584 1585 Fields: 1586 projectId: Required. The ID of the Google Cloud Platform project that the 1587 job belongs to. 1588 region: Required. The Dataproc region in which to handle the request. 1589 submitJobRequest: A SubmitJobRequest resource to be passed as the request 1590 body. 1591 """ 1592 1593 projectId = _messages.StringField(1, required=True) 1594 region = _messages.StringField(2, required=True) 1595 submitJobRequest = _messages.MessageField('SubmitJobRequest', 3) 1596 1597 1598class DataprocProjectsRegionsJobsSubmitRequest(_messages.Message): 1599 r"""A DataprocProjectsRegionsJobsSubmitRequest object. 1600 1601 Fields: 1602 projectId: Required. The ID of the Google Cloud Platform project that the 1603 job belongs to. 1604 region: Required. The Dataproc region in which to handle the request. 1605 submitJobRequest: A SubmitJobRequest resource to be passed as the request 1606 body. 1607 """ 1608 1609 projectId = _messages.StringField(1, required=True) 1610 region = _messages.StringField(2, required=True) 1611 submitJobRequest = _messages.MessageField('SubmitJobRequest', 3) 1612 1613 1614class DataprocProjectsRegionsJobsTestIamPermissionsRequest(_messages.Message): 1615 r"""A DataprocProjectsRegionsJobsTestIamPermissionsRequest object. 1616 1617 Fields: 1618 resource: REQUIRED: The resource for which the policy detail is being 1619 requested. See the operation documentation for the appropriate value for 1620 this field. 1621 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 1622 passed as the request body. 1623 """ 1624 1625 resource = _messages.StringField(1, required=True) 1626 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 1627 1628 1629class DataprocProjectsRegionsOperationsCancelRequest(_messages.Message): 1630 r"""A DataprocProjectsRegionsOperationsCancelRequest object. 1631 1632 Fields: 1633 name: The name of the operation resource to be cancelled. 1634 """ 1635 1636 name = _messages.StringField(1, required=True) 1637 1638 1639class DataprocProjectsRegionsOperationsDeleteRequest(_messages.Message): 1640 r"""A DataprocProjectsRegionsOperationsDeleteRequest object. 1641 1642 Fields: 1643 name: The name of the operation resource to be deleted. 1644 """ 1645 1646 name = _messages.StringField(1, required=True) 1647 1648 1649class DataprocProjectsRegionsOperationsGetIamPolicyRequest(_messages.Message): 1650 r"""A DataprocProjectsRegionsOperationsGetIamPolicyRequest object. 1651 1652 Fields: 1653 options_requestedPolicyVersion: Optional. The policy format version to be 1654 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 1655 value will be rejected.Requests for policies with any conditional 1656 bindings must specify version 3. Policies without any conditional 1657 bindings may specify any valid value or leave the field unset.To learn 1658 which resources support conditions in their IAM policies, see the IAM 1659 documentation (https://cloud.google.com/iam/help/conditions/resource- 1660 policies). 1661 resource: REQUIRED: The resource for which the policy is being requested. 1662 See the operation documentation for the appropriate value for this 1663 field. 1664 """ 1665 1666 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1667 resource = _messages.StringField(2, required=True) 1668 1669 1670class DataprocProjectsRegionsOperationsGetRequest(_messages.Message): 1671 r"""A DataprocProjectsRegionsOperationsGetRequest object. 1672 1673 Fields: 1674 name: The name of the operation resource. 1675 """ 1676 1677 name = _messages.StringField(1, required=True) 1678 1679 1680class DataprocProjectsRegionsOperationsListRequest(_messages.Message): 1681 r"""A DataprocProjectsRegionsOperationsListRequest object. 1682 1683 Fields: 1684 filter: The standard list filter. 1685 name: The name of the operation's parent resource. 1686 pageSize: The standard list page size. 1687 pageToken: The standard list page token. 1688 """ 1689 1690 filter = _messages.StringField(1) 1691 name = _messages.StringField(2, required=True) 1692 pageSize = _messages.IntegerField(3, variant=_messages.Variant.INT32) 1693 pageToken = _messages.StringField(4) 1694 1695 1696class DataprocProjectsRegionsOperationsSetIamPolicyRequest(_messages.Message): 1697 r"""A DataprocProjectsRegionsOperationsSetIamPolicyRequest object. 1698 1699 Fields: 1700 resource: REQUIRED: The resource for which the policy is being specified. 1701 See the operation documentation for the appropriate value for this 1702 field. 1703 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 1704 request body. 1705 """ 1706 1707 resource = _messages.StringField(1, required=True) 1708 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 1709 1710 1711class DataprocProjectsRegionsOperationsTestIamPermissionsRequest(_messages.Message): 1712 r"""A DataprocProjectsRegionsOperationsTestIamPermissionsRequest object. 1713 1714 Fields: 1715 resource: REQUIRED: The resource for which the policy detail is being 1716 requested. See the operation documentation for the appropriate value for 1717 this field. 1718 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 1719 passed as the request body. 1720 """ 1721 1722 resource = _messages.StringField(1, required=True) 1723 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 1724 1725 1726class DataprocProjectsRegionsWorkflowTemplatesCreateRequest(_messages.Message): 1727 r"""A DataprocProjectsRegionsWorkflowTemplatesCreateRequest object. 1728 1729 Fields: 1730 parent: Required. The resource name of the region or location, as 1731 described in https://cloud.google.com/apis/design/resource_names. For 1732 projects.regions.workflowTemplates,create, the resource name of the 1733 region has the following format: projects/{project_id}/regions/{region} 1734 For projects.locations.workflowTemplates.create, the resource name of 1735 the location has the following format: 1736 projects/{project_id}/locations/{location} 1737 workflowTemplate: A WorkflowTemplate resource to be passed as the request 1738 body. 1739 """ 1740 1741 parent = _messages.StringField(1, required=True) 1742 workflowTemplate = _messages.MessageField('WorkflowTemplate', 2) 1743 1744 1745class DataprocProjectsRegionsWorkflowTemplatesDeleteRequest(_messages.Message): 1746 r"""A DataprocProjectsRegionsWorkflowTemplatesDeleteRequest object. 1747 1748 Fields: 1749 name: Required. The resource name of the workflow template, as described 1750 in https://cloud.google.com/apis/design/resource_names. For 1751 projects.regions.workflowTemplates.delete, the resource name of the 1752 template has the following format: 1753 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 1754 For projects.locations.workflowTemplates.instantiate, the resource name 1755 of the template has the following format: projects/{project_id}/location 1756 s/{location}/workflowTemplates/{template_id} 1757 version: Optional. The version of workflow template to delete. If 1758 specified, will only delete the template if the current server version 1759 matches specified version. 1760 """ 1761 1762 name = _messages.StringField(1, required=True) 1763 version = _messages.IntegerField(2, variant=_messages.Variant.INT32) 1764 1765 1766class DataprocProjectsRegionsWorkflowTemplatesGetIamPolicyRequest(_messages.Message): 1767 r"""A DataprocProjectsRegionsWorkflowTemplatesGetIamPolicyRequest object. 1768 1769 Fields: 1770 options_requestedPolicyVersion: Optional. The policy format version to be 1771 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 1772 value will be rejected.Requests for policies with any conditional 1773 bindings must specify version 3. Policies without any conditional 1774 bindings may specify any valid value or leave the field unset.To learn 1775 which resources support conditions in their IAM policies, see the IAM 1776 documentation (https://cloud.google.com/iam/help/conditions/resource- 1777 policies). 1778 resource: REQUIRED: The resource for which the policy is being requested. 1779 See the operation documentation for the appropriate value for this 1780 field. 1781 """ 1782 1783 options_requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1784 resource = _messages.StringField(2, required=True) 1785 1786 1787class DataprocProjectsRegionsWorkflowTemplatesGetRequest(_messages.Message): 1788 r"""A DataprocProjectsRegionsWorkflowTemplatesGetRequest object. 1789 1790 Fields: 1791 name: Required. The resource name of the workflow template, as described 1792 in https://cloud.google.com/apis/design/resource_names. For 1793 projects.regions.workflowTemplates.get, the resource name of the 1794 template has the following format: 1795 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 1796 For projects.locations.workflowTemplates.get, the resource name of the 1797 template has the following format: projects/{project_id}/locations/{loca 1798 tion}/workflowTemplates/{template_id} 1799 version: Optional. The version of workflow template to retrieve. Only 1800 previously instantiated versions can be retrieved.If unspecified, 1801 retrieves the current version. 1802 """ 1803 1804 name = _messages.StringField(1, required=True) 1805 version = _messages.IntegerField(2, variant=_messages.Variant.INT32) 1806 1807 1808class DataprocProjectsRegionsWorkflowTemplatesInstantiateInlineRequest(_messages.Message): 1809 r"""A DataprocProjectsRegionsWorkflowTemplatesInstantiateInlineRequest 1810 object. 1811 1812 Fields: 1813 instanceId: Deprecated. Please use request_id field instead. 1814 parent: Required. The resource name of the region or location, as 1815 described in https://cloud.google.com/apis/design/resource_names. For 1816 projects.regions.workflowTemplates,instantiateinline, the resource name 1817 of the region has the following format: 1818 projects/{project_id}/regions/{region} For 1819 projects.locations.workflowTemplates.instantiateinline, the resource 1820 name of the location has the following format: 1821 projects/{project_id}/locations/{location} 1822 requestId: Optional. A tag that prevents multiple concurrent workflow 1823 instances with the same tag from running. This mitigates risk of 1824 concurrent instances started due to retries.It is recommended to always 1825 set this value to a UUID 1826 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag 1827 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 1828 and hyphens (-). The maximum length is 40 characters. 1829 workflowTemplate: A WorkflowTemplate resource to be passed as the request 1830 body. 1831 """ 1832 1833 instanceId = _messages.StringField(1) 1834 parent = _messages.StringField(2, required=True) 1835 requestId = _messages.StringField(3) 1836 workflowTemplate = _messages.MessageField('WorkflowTemplate', 4) 1837 1838 1839class DataprocProjectsRegionsWorkflowTemplatesInstantiateRequest(_messages.Message): 1840 r"""A DataprocProjectsRegionsWorkflowTemplatesInstantiateRequest object. 1841 1842 Fields: 1843 instantiateWorkflowTemplateRequest: A InstantiateWorkflowTemplateRequest 1844 resource to be passed as the request body. 1845 name: Required. The resource name of the workflow template, as described 1846 in https://cloud.google.com/apis/design/resource_names. For 1847 projects.regions.workflowTemplates.instantiate, the resource name of the 1848 template has the following format: 1849 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 1850 For projects.locations.workflowTemplates.instantiate, the resource name 1851 of the template has the following format: projects/{project_id}/location 1852 s/{location}/workflowTemplates/{template_id} 1853 """ 1854 1855 instantiateWorkflowTemplateRequest = _messages.MessageField('InstantiateWorkflowTemplateRequest', 1) 1856 name = _messages.StringField(2, required=True) 1857 1858 1859class DataprocProjectsRegionsWorkflowTemplatesListRequest(_messages.Message): 1860 r"""A DataprocProjectsRegionsWorkflowTemplatesListRequest object. 1861 1862 Fields: 1863 pageSize: Optional. The maximum number of results to return in each 1864 response. 1865 pageToken: Optional. The page token, returned by a previous call, to 1866 request the next page of results. 1867 parent: Required. The resource name of the region or location, as 1868 described in https://cloud.google.com/apis/design/resource_names. For 1869 projects.regions.workflowTemplates,list, the resource name of the region 1870 has the following format: projects/{project_id}/regions/{region} For 1871 projects.locations.workflowTemplates.list, the resource name of the 1872 location has the following format: 1873 projects/{project_id}/locations/{location} 1874 """ 1875 1876 pageSize = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1877 pageToken = _messages.StringField(2) 1878 parent = _messages.StringField(3, required=True) 1879 1880 1881class DataprocProjectsRegionsWorkflowTemplatesSetIamPolicyRequest(_messages.Message): 1882 r"""A DataprocProjectsRegionsWorkflowTemplatesSetIamPolicyRequest object. 1883 1884 Fields: 1885 resource: REQUIRED: The resource for which the policy is being specified. 1886 See the operation documentation for the appropriate value for this 1887 field. 1888 setIamPolicyRequest: A SetIamPolicyRequest resource to be passed as the 1889 request body. 1890 """ 1891 1892 resource = _messages.StringField(1, required=True) 1893 setIamPolicyRequest = _messages.MessageField('SetIamPolicyRequest', 2) 1894 1895 1896class DataprocProjectsRegionsWorkflowTemplatesTestIamPermissionsRequest(_messages.Message): 1897 r"""A DataprocProjectsRegionsWorkflowTemplatesTestIamPermissionsRequest 1898 object. 1899 1900 Fields: 1901 resource: REQUIRED: The resource for which the policy detail is being 1902 requested. See the operation documentation for the appropriate value for 1903 this field. 1904 testIamPermissionsRequest: A TestIamPermissionsRequest resource to be 1905 passed as the request body. 1906 """ 1907 1908 resource = _messages.StringField(1, required=True) 1909 testIamPermissionsRequest = _messages.MessageField('TestIamPermissionsRequest', 2) 1910 1911 1912class DiagnoseClusterRequest(_messages.Message): 1913 r"""A request to collect cluster diagnostic information.""" 1914 1915 1916class DiagnoseClusterResults(_messages.Message): 1917 r"""The location of diagnostic output. 1918 1919 Fields: 1920 outputUri: Output only. The Cloud Storage URI of the diagnostic output. 1921 The output report is a plain text file with a summary of collected 1922 diagnostics. 1923 """ 1924 1925 outputUri = _messages.StringField(1) 1926 1927 1928class DiskConfig(_messages.Message): 1929 r"""Specifies the config of disk options for a group of VM instances. 1930 1931 Fields: 1932 bootDiskSizeGb: Optional. Size in GB of the boot disk (default is 500GB). 1933 bootDiskType: Optional. Type of the boot disk (default is "pd-standard"). 1934 Valid values: "pd-balanced" (Persistent Disk Balanced Solid State 1935 Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" 1936 (Persistent Disk Hard Disk Drive). See Disk types 1937 (https://cloud.google.com/compute/docs/disks#disk-types). 1938 numLocalSsds: Number of attached SSDs, from 0 to 4 (default is 0). If SSDs 1939 are not attached, the boot disk is used to store runtime logs and HDFS 1940 (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If 1941 one or more SSDs are attached, this runtime bulk data is spread across 1942 them, and the boot disk contains only basic config and installed 1943 binaries. 1944 """ 1945 1946 bootDiskSizeGb = _messages.IntegerField(1, variant=_messages.Variant.INT32) 1947 bootDiskType = _messages.StringField(2) 1948 numLocalSsds = _messages.IntegerField(3, variant=_messages.Variant.INT32) 1949 1950 1951class DriverRunner(_messages.Message): 1952 r"""Configurations for the driver runner 1953 1954 Fields: 1955 masterDriverRunner: Optional. (default) Run driver on master node 1956 yarnDriverRunner: Optional. Configuration for running the driver on 1957 workers using YARN 1958 """ 1959 1960 masterDriverRunner = _messages.MessageField('MasterDriverRunner', 1) 1961 yarnDriverRunner = _messages.MessageField('YarnDriverRunner', 2) 1962 1963 1964class Empty(_messages.Message): 1965 r"""A generic empty message that you can re-use to avoid defining duplicated 1966 empty messages in your APIs. A typical example is to use it as the request 1967 or the response type of an API method. For instance: service Foo { rpc 1968 Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON 1969 representation for Empty is empty JSON object {}. 1970 """ 1971 1972 1973 1974class EncryptionConfig(_messages.Message): 1975 r"""Encryption settings for the cluster. 1976 1977 Fields: 1978 gcePdKmsKeyName: Optional. The Cloud KMS key name to use for PD disk 1979 encryption for all instances in the cluster. 1980 """ 1981 1982 gcePdKmsKeyName = _messages.StringField(1) 1983 1984 1985class EndpointConfig(_messages.Message): 1986 r"""Endpoint config for this cluster 1987 1988 Messages: 1989 HttpPortsValue: Output only. The map of port descriptions to URLs. Will 1990 only be populated if enable_http_port_access is true. 1991 1992 Fields: 1993 enableHttpPortAccess: Optional. If true, enable http access to specific 1994 ports on the cluster from external sources. Defaults to false. 1995 httpPorts: Output only. The map of port descriptions to URLs. Will only be 1996 populated if enable_http_port_access is true. 1997 """ 1998 1999 @encoding.MapUnrecognizedFields('additionalProperties') 2000 class HttpPortsValue(_messages.Message): 2001 r"""Output only. The map of port descriptions to URLs. Will only be 2002 populated if enable_http_port_access is true. 2003 2004 Messages: 2005 AdditionalProperty: An additional property for a HttpPortsValue object. 2006 2007 Fields: 2008 additionalProperties: Additional properties of type HttpPortsValue 2009 """ 2010 2011 class AdditionalProperty(_messages.Message): 2012 r"""An additional property for a HttpPortsValue object. 2013 2014 Fields: 2015 key: Name of the additional property. 2016 value: A string attribute. 2017 """ 2018 2019 key = _messages.StringField(1) 2020 value = _messages.StringField(2) 2021 2022 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2023 2024 enableHttpPortAccess = _messages.BooleanField(1) 2025 httpPorts = _messages.MessageField('HttpPortsValue', 2) 2026 2027 2028class Expr(_messages.Message): 2029 r"""Represents a textual expression in the Common Expression Language (CEL) 2030 syntax. CEL is a C-like expression language. The syntax and semantics of CEL 2031 are documented at https://github.com/google/cel-spec.Example (Comparison): 2032 title: "Summary size limit" description: "Determines if a summary is less 2033 than 100 chars" expression: "document.summary.size() < 100" Example 2034 (Equality): title: "Requestor is owner" description: "Determines if 2035 requestor is the document owner" expression: "document.owner == 2036 request.auth.claims.email" Example (Logic): title: "Public documents" 2037 description: "Determine whether the document should be publicly visible" 2038 expression: "document.type != 'private' && document.type != 'internal'" 2039 Example (Data Manipulation): title: "Notification string" description: 2040 "Create a notification string with a timestamp." expression: "'New message 2041 received at ' + string(document.create_time)" The exact variables and 2042 functions that may be referenced within an expression are determined by the 2043 service that evaluates it. See the service documentation for additional 2044 information. 2045 2046 Fields: 2047 description: Optional. Description of the expression. This is a longer 2048 text which describes the expression, e.g. when hovered over it in a UI. 2049 expression: Textual representation of an expression in Common Expression 2050 Language syntax. 2051 location: Optional. String indicating the location of the expression for 2052 error reporting, e.g. a file name and a position in the file. 2053 title: Optional. Title for the expression, i.e. a short string describing 2054 its purpose. This can be used e.g. in UIs which allow to enter the 2055 expression. 2056 """ 2057 2058 description = _messages.StringField(1) 2059 expression = _messages.StringField(2) 2060 location = _messages.StringField(3) 2061 title = _messages.StringField(4) 2062 2063 2064class GceClusterConfig(_messages.Message): 2065 r"""Common config settings for resources of Compute Engine cluster 2066 instances, applicable to all instances in the cluster. 2067 2068 Enums: 2069 PrivateIpv6GoogleAccessValueValuesEnum: Optional. The type of IPv6 access 2070 for a cluster. 2071 2072 Messages: 2073 MetadataValue: The Compute Engine metadata entries to add to all instances 2074 (see Project and instance metadata 2075 (https://cloud.google.com/compute/docs/storing-retrieving- 2076 metadata#project_and_instance_metadata)). 2077 2078 Fields: 2079 internalIpOnly: Optional. If true, all instances in the cluster will only 2080 have internal IP addresses. By default, clusters are not restricted to 2081 internal IP addresses, and will have ephemeral external IP addresses 2082 assigned to each instance. This internal_ip_only restriction can only be 2083 enabled for subnetwork enabled networks, and all off-cluster 2084 dependencies must be configured to be accessible without external IP 2085 addresses. 2086 metadata: The Compute Engine metadata entries to add to all instances (see 2087 Project and instance metadata 2088 (https://cloud.google.com/compute/docs/storing-retrieving- 2089 metadata#project_and_instance_metadata)). 2090 networkUri: Optional. The Compute Engine network to be used for machine 2091 communications. Cannot be specified with subnetwork_uri. If neither 2092 network_uri nor subnetwork_uri is specified, the "default" network of 2093 the project is used, if it exists. Cannot be a "Custom Subnet Network" 2094 (see Using Subnetworks 2095 (https://cloud.google.com/compute/docs/subnetworks) for more 2096 information).A full URL, partial URI, or short name are valid. Examples: 2097 https://www.googleapis.com/compute/v1/projects/[project_id]/regions/glob 2098 al/default projects/[project_id]/regions/global/default default 2099 nodeGroupAffinity: Optional. Node Group Affinity for sole-tenant clusters. 2100 privateIpv6GoogleAccess: Optional. The type of IPv6 access for a cluster. 2101 reservationAffinity: Optional. Reservation Affinity for consuming Zonal 2102 reservation. 2103 serviceAccount: Optional. The Dataproc service account 2104 (https://cloud.google.com/dataproc/docs/concepts/configuring- 2105 clusters/service-accounts#service_accounts_in_dataproc) (also see VM 2106 Data Plane identity 2107 (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc- 2108 principals#vm_service_account_data_plane_identity)) used by Dataproc 2109 cluster VM instances to access Google Cloud Platform services.If not 2110 specified, the Compute Engine default service account 2111 (https://cloud.google.com/compute/docs/access/service- 2112 accounts#default_service_account) is used. 2113 serviceAccountScopes: Optional. The URIs of service account scopes to be 2114 included in Compute Engine instances. The following base set of scopes 2115 is always included: 2116 https://www.googleapis.com/auth/cloud.useraccounts.readonly 2117 https://www.googleapis.com/auth/devstorage.read_write 2118 https://www.googleapis.com/auth/logging.writeIf no scopes are specified, 2119 the following defaults are also provided: 2120 https://www.googleapis.com/auth/bigquery 2121 https://www.googleapis.com/auth/bigtable.admin.table 2122 https://www.googleapis.com/auth/bigtable.data 2123 https://www.googleapis.com/auth/devstorage.full_control 2124 shieldedInstanceConfig: Optional. Shielded Instance Config for clusters 2125 using Compute Engine Shielded VMs 2126 (https://cloud.google.com/security/shielded-cloud/shielded-vm). 2127 subnetworkUri: Optional. The Compute Engine subnetwork to be used for 2128 machine communications. Cannot be specified with network_uri.A full URL, 2129 partial URI, or short name are valid. Examples: 2130 https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us- 2131 east1/subnetworks/sub0 projects/[project_id]/regions/us- 2132 east1/subnetworks/sub0 sub0 2133 tags: The Compute Engine tags to add to all instances (see Tagging 2134 instances (https://cloud.google.com/compute/docs/label-or-tag- 2135 resources#tags)). 2136 zoneUri: Optional. The zone where the Compute Engine cluster will be 2137 located. On a create request, it is required in the "global" region. If 2138 omitted in a non-global Dataproc region, the service will pick a zone in 2139 the corresponding Compute Engine region. On a get request, zone will 2140 always be present.A full URL, partial URI, or short name are valid. 2141 Examples: 2142 https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone] 2143 projects/[project_id]/zones/[zone] us-central1-f 2144 """ 2145 2146 class PrivateIpv6GoogleAccessValueValuesEnum(_messages.Enum): 2147 r"""Optional. The type of IPv6 access for a cluster. 2148 2149 Values: 2150 PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED: If unspecified, Compute Engine 2151 default behavior will apply, which is the same as 2152 INHERIT_FROM_SUBNETWORK. 2153 INHERIT_FROM_SUBNETWORK: Private access to and from Google Services 2154 configuration inherited from the subnetwork configuration. This is the 2155 default Compute Engine behavior. 2156 OUTBOUND: Enables outbound private IPv6 access to Google Services from 2157 the Dataproc cluster. 2158 BIDIRECTIONAL: Enables bidirectional private IPv6 access between Google 2159 Services and the Dataproc cluster. 2160 """ 2161 PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED = 0 2162 INHERIT_FROM_SUBNETWORK = 1 2163 OUTBOUND = 2 2164 BIDIRECTIONAL = 3 2165 2166 @encoding.MapUnrecognizedFields('additionalProperties') 2167 class MetadataValue(_messages.Message): 2168 r"""The Compute Engine metadata entries to add to all instances (see 2169 Project and instance metadata 2170 (https://cloud.google.com/compute/docs/storing-retrieving- 2171 metadata#project_and_instance_metadata)). 2172 2173 Messages: 2174 AdditionalProperty: An additional property for a MetadataValue object. 2175 2176 Fields: 2177 additionalProperties: Additional properties of type MetadataValue 2178 """ 2179 2180 class AdditionalProperty(_messages.Message): 2181 r"""An additional property for a MetadataValue object. 2182 2183 Fields: 2184 key: Name of the additional property. 2185 value: A string attribute. 2186 """ 2187 2188 key = _messages.StringField(1) 2189 value = _messages.StringField(2) 2190 2191 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2192 2193 internalIpOnly = _messages.BooleanField(1) 2194 metadata = _messages.MessageField('MetadataValue', 2) 2195 networkUri = _messages.StringField(3) 2196 nodeGroupAffinity = _messages.MessageField('NodeGroupAffinity', 4) 2197 privateIpv6GoogleAccess = _messages.EnumField('PrivateIpv6GoogleAccessValueValuesEnum', 5) 2198 reservationAffinity = _messages.MessageField('ReservationAffinity', 6) 2199 serviceAccount = _messages.StringField(7) 2200 serviceAccountScopes = _messages.StringField(8, repeated=True) 2201 shieldedInstanceConfig = _messages.MessageField('ShieldedInstanceConfig', 9) 2202 subnetworkUri = _messages.StringField(10) 2203 tags = _messages.StringField(11, repeated=True) 2204 zoneUri = _messages.StringField(12) 2205 2206 2207class GetIamPolicyRequest(_messages.Message): 2208 r"""Request message for GetIamPolicy method. 2209 2210 Fields: 2211 options: OPTIONAL: A GetPolicyOptions object for specifying options to 2212 GetIamPolicy. 2213 """ 2214 2215 options = _messages.MessageField('GetPolicyOptions', 1) 2216 2217 2218class GetPolicyOptions(_messages.Message): 2219 r"""Encapsulates settings provided to GetIamPolicy. 2220 2221 Fields: 2222 requestedPolicyVersion: Optional. The policy format version to be 2223 returned.Valid values are 0, 1, and 3. Requests specifying an invalid 2224 value will be rejected.Requests for policies with any conditional 2225 bindings must specify version 3. Policies without any conditional 2226 bindings may specify any valid value or leave the field unset.To learn 2227 which resources support conditions in their IAM policies, see the IAM 2228 documentation (https://cloud.google.com/iam/help/conditions/resource- 2229 policies). 2230 """ 2231 2232 requestedPolicyVersion = _messages.IntegerField(1, variant=_messages.Variant.INT32) 2233 2234 2235class GkeClusterConfig(_messages.Message): 2236 r"""The GKE config for this cluster. 2237 2238 Fields: 2239 namespacedGkeDeploymentTarget: Optional. A target for the deployment. 2240 """ 2241 2242 namespacedGkeDeploymentTarget = _messages.MessageField('NamespacedGkeDeploymentTarget', 1) 2243 2244 2245class HadoopJob(_messages.Message): 2246 r"""A Dataproc job for running Apache Hadoop MapReduce 2247 (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop- 2248 mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN 2249 (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn- 2250 site/YARN.html). 2251 2252 Messages: 2253 PropertiesValue: Optional. A mapping of property names to values, used to 2254 configure Hadoop. Properties that conflict with values set by the 2255 Dataproc API may be overwritten. Can include properties set in 2256 /etc/hadoop/conf/*-site and classes in user code. 2257 2258 Fields: 2259 archiveUris: Optional. HCFS URIs of archives to be extracted in the 2260 working directory of Hadoop drivers and tasks. Supported file types: 2261 .jar, .tar, .tar.gz, .tgz, or .zip. 2262 args: Optional. The arguments to pass to the driver. Do not include 2263 arguments, such as -libjars or -Dfoo=bar, that can be set as job 2264 properties, since a collision may occur that causes an incorrect job 2265 submission. 2266 fileUris: Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to 2267 be copied to the working directory of Hadoop drivers and distributed 2268 tasks. Useful for naively parallel tasks. 2269 jarFileUris: Optional. Jar file URIs to add to the CLASSPATHs of the 2270 Hadoop driver and tasks. 2271 loggingConfig: Optional. The runtime log config for job execution. 2272 mainClass: The name of the driver's main class. The jar file containing 2273 the class must be in the default CLASSPATH or specified in 2274 jar_file_uris. 2275 mainJarFileUri: The HCFS URI of the jar file containing the main class. 2276 Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics- 2277 mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 2278 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar' 2279 properties: Optional. A mapping of property names to values, used to 2280 configure Hadoop. Properties that conflict with values set by the 2281 Dataproc API may be overwritten. Can include properties set in 2282 /etc/hadoop/conf/*-site and classes in user code. 2283 """ 2284 2285 @encoding.MapUnrecognizedFields('additionalProperties') 2286 class PropertiesValue(_messages.Message): 2287 r"""Optional. A mapping of property names to values, used to configure 2288 Hadoop. Properties that conflict with values set by the Dataproc API may 2289 be overwritten. Can include properties set in /etc/hadoop/conf/*-site and 2290 classes in user code. 2291 2292 Messages: 2293 AdditionalProperty: An additional property for a PropertiesValue object. 2294 2295 Fields: 2296 additionalProperties: Additional properties of type PropertiesValue 2297 """ 2298 2299 class AdditionalProperty(_messages.Message): 2300 r"""An additional property for a PropertiesValue object. 2301 2302 Fields: 2303 key: Name of the additional property. 2304 value: A string attribute. 2305 """ 2306 2307 key = _messages.StringField(1) 2308 value = _messages.StringField(2) 2309 2310 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2311 2312 archiveUris = _messages.StringField(1, repeated=True) 2313 args = _messages.StringField(2, repeated=True) 2314 fileUris = _messages.StringField(3, repeated=True) 2315 jarFileUris = _messages.StringField(4, repeated=True) 2316 loggingConfig = _messages.MessageField('LoggingConfig', 5) 2317 mainClass = _messages.StringField(6) 2318 mainJarFileUri = _messages.StringField(7) 2319 properties = _messages.MessageField('PropertiesValue', 8) 2320 2321 2322class HiveJob(_messages.Message): 2323 r"""A Dataproc job for running Apache Hive (https://hive.apache.org/) 2324 queries on YARN. 2325 2326 Messages: 2327 PropertiesValue: Optional. A mapping of property names and values, used to 2328 configure Hive. Properties that conflict with values set by the Dataproc 2329 API may be overwritten. Can include properties set in 2330 /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes 2331 in user code. 2332 ScriptVariablesValue: Optional. Mapping of query variable names to values 2333 (equivalent to the Hive command: SET name="value";). 2334 2335 Fields: 2336 continueOnFailure: Optional. Whether to continue executing queries if a 2337 query fails. The default value is false. Setting to true can be useful 2338 when executing independent parallel queries. 2339 jarFileUris: Optional. HCFS URIs of jar files to add to the CLASSPATH of 2340 the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes 2341 and UDFs. 2342 properties: Optional. A mapping of property names and values, used to 2343 configure Hive. Properties that conflict with values set by the Dataproc 2344 API may be overwritten. Can include properties set in 2345 /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes 2346 in user code. 2347 queryFileUri: The HCFS URI of the script that contains Hive queries. 2348 queryList: A list of queries. 2349 scriptVariables: Optional. Mapping of query variable names to values 2350 (equivalent to the Hive command: SET name="value";). 2351 """ 2352 2353 @encoding.MapUnrecognizedFields('additionalProperties') 2354 class PropertiesValue(_messages.Message): 2355 r"""Optional. A mapping of property names and values, used to configure 2356 Hive. Properties that conflict with values set by the Dataproc API may be 2357 overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 2358 /etc/hive/conf/hive-site.xml, and classes in user code. 2359 2360 Messages: 2361 AdditionalProperty: An additional property for a PropertiesValue object. 2362 2363 Fields: 2364 additionalProperties: Additional properties of type PropertiesValue 2365 """ 2366 2367 class AdditionalProperty(_messages.Message): 2368 r"""An additional property for a PropertiesValue object. 2369 2370 Fields: 2371 key: Name of the additional property. 2372 value: A string attribute. 2373 """ 2374 2375 key = _messages.StringField(1) 2376 value = _messages.StringField(2) 2377 2378 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2379 2380 @encoding.MapUnrecognizedFields('additionalProperties') 2381 class ScriptVariablesValue(_messages.Message): 2382 r"""Optional. Mapping of query variable names to values (equivalent to the 2383 Hive command: SET name="value";). 2384 2385 Messages: 2386 AdditionalProperty: An additional property for a ScriptVariablesValue 2387 object. 2388 2389 Fields: 2390 additionalProperties: Additional properties of type ScriptVariablesValue 2391 """ 2392 2393 class AdditionalProperty(_messages.Message): 2394 r"""An additional property for a ScriptVariablesValue object. 2395 2396 Fields: 2397 key: Name of the additional property. 2398 value: A string attribute. 2399 """ 2400 2401 key = _messages.StringField(1) 2402 value = _messages.StringField(2) 2403 2404 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2405 2406 continueOnFailure = _messages.BooleanField(1) 2407 jarFileUris = _messages.StringField(2, repeated=True) 2408 properties = _messages.MessageField('PropertiesValue', 3) 2409 queryFileUri = _messages.StringField(4) 2410 queryList = _messages.MessageField('QueryList', 5) 2411 scriptVariables = _messages.MessageField('ScriptVariablesValue', 6) 2412 2413 2414class IdentityConfig(_messages.Message): 2415 r"""Identity related configuration, including service account based secure 2416 multi-tenancy user mappings. 2417 2418 Messages: 2419 UserServiceAccountMappingValue: Required. Map of user to service account. 2420 2421 Fields: 2422 userServiceAccountMapping: Required. Map of user to service account. 2423 """ 2424 2425 @encoding.MapUnrecognizedFields('additionalProperties') 2426 class UserServiceAccountMappingValue(_messages.Message): 2427 r"""Required. Map of user to service account. 2428 2429 Messages: 2430 AdditionalProperty: An additional property for a 2431 UserServiceAccountMappingValue object. 2432 2433 Fields: 2434 additionalProperties: Additional properties of type 2435 UserServiceAccountMappingValue 2436 """ 2437 2438 class AdditionalProperty(_messages.Message): 2439 r"""An additional property for a UserServiceAccountMappingValue object. 2440 2441 Fields: 2442 key: Name of the additional property. 2443 value: A string attribute. 2444 """ 2445 2446 key = _messages.StringField(1) 2447 value = _messages.StringField(2) 2448 2449 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2450 2451 userServiceAccountMapping = _messages.MessageField('UserServiceAccountMappingValue', 1) 2452 2453 2454class InjectCredentialsRequest(_messages.Message): 2455 r"""A request to inject credentials into a cluster. 2456 2457 Fields: 2458 clusterUuid: Required. The cluster UUID. 2459 credentialsCiphertext: Required. The encrypted credentials being injected 2460 in to the cluster.The client is responsible for encrypting the 2461 credentials in a way that is supported by the cluster.A wrapped value is 2462 used here so that the actual contents of the encrypted credentials are 2463 not written to audit logs. 2464 """ 2465 2466 clusterUuid = _messages.StringField(1) 2467 credentialsCiphertext = _messages.StringField(2) 2468 2469 2470class InstanceGroupAutoscalingPolicyConfig(_messages.Message): 2471 r"""Configuration for the size bounds of an instance group, including its 2472 proportional size to other groups. 2473 2474 Fields: 2475 maxInstances: Optional. Maximum number of instances for this group. 2476 Required for primary workers. Note that by default, clusters will not 2477 use secondary workers. Required for secondary workers if the minimum 2478 secondary instances is set.Primary workers - Bounds: [min_instances, ). 2479 Required. Secondary workers - Bounds: [min_instances, ). Default: 0. 2480 minInstances: Optional. Minimum number of instances for this group.Primary 2481 workers - Bounds: 2, max_instances. Default: 2. Secondary workers - 2482 Bounds: 0, max_instances. Default: 0. 2483 weight: Optional. Weight for the instance group, which is used to 2484 determine the fraction of total workers in the cluster from this 2485 instance group. For example, if primary workers have weight 2, and 2486 secondary workers have weight 1, the cluster will have approximately 2 2487 primary workers for each secondary worker.The cluster may not reach the 2488 specified balance if constrained by min/max bounds or other autoscaling 2489 settings. For example, if max_instances for secondary workers is 0, then 2490 only primary workers will be added. The cluster can also be out of 2491 balance when created.If weight is not set on any instance group, the 2492 cluster will default to equal weight for all groups: the cluster will 2493 attempt to maintain an equal number of workers in each group within the 2494 configured size bounds for each group. If weight is set for one group 2495 only, the cluster will default to zero weight on the unset group. For 2496 example if weight is set only on primary workers, the cluster will use 2497 primary workers only and no secondary workers. 2498 """ 2499 2500 maxInstances = _messages.IntegerField(1, variant=_messages.Variant.INT32) 2501 minInstances = _messages.IntegerField(2, variant=_messages.Variant.INT32) 2502 weight = _messages.IntegerField(3, variant=_messages.Variant.INT32) 2503 2504 2505class InstanceGroupConfig(_messages.Message): 2506 r"""The config settings for Compute Engine resources in an instance group, 2507 such as a master or worker group. 2508 2509 Enums: 2510 PreemptibilityValueValuesEnum: Optional. Specifies the preemptibility of 2511 the instance group.The default value for master and worker groups is 2512 NON_PREEMPTIBLE. This default cannot be changed.The default value for 2513 secondary instances is PREEMPTIBLE. 2514 2515 Fields: 2516 accelerators: Optional. The Compute Engine accelerator configuration for 2517 these instances. 2518 diskConfig: Optional. Disk option config settings. 2519 imageUri: Optional. The Compute Engine image resource used for cluster 2520 instances.The URI can represent an image or image family.Image examples: 2521 https://www.googleapis.com/compute/beta/projects/[project_id]/global/ima 2522 ges/[image-id] projects/[project_id]/global/images/[image-id] image- 2523 idImage family examples. Dataproc will use the most recent image from 2524 the family: https://www.googleapis.com/compute/beta/projects/[project_id 2525 ]/global/images/family/[custom-image-family-name] 2526 projects/[project_id]/global/images/family/[custom-image-family-name]If 2527 the URI is unspecified, it will be inferred from 2528 SoftwareConfig.image_version or the system default. 2529 instanceNames: Output only. The list of instance names. Dataproc derives 2530 the names from cluster_name, num_instances, and the instance group. 2531 instanceReferences: Output only. List of references to Compute Engine 2532 instances. 2533 isPreemptible: Output only. Specifies that this instance group contains 2534 preemptible instances. 2535 machineTypeUri: Optional. The Compute Engine machine type used for cluster 2536 instances.A full URL, partial URI, or short name are valid. Examples: 2537 https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us- 2538 east1-a/machineTypes/n1-standard-2 projects/[project_id]/zones/us- 2539 east1-a/machineTypes/n1-standard-2 n1-standard-2Auto Zone Exception: If 2540 you are using the Dataproc Auto Zone Placement 2541 (https://cloud.google.com/dataproc/docs/concepts/configuring- 2542 clusters/auto-zone#using_auto_zone_placement) feature, you must use the 2543 short name of the machine type resource, for example, n1-standard-2. 2544 managedGroupConfig: Output only. The config for Compute Engine Instance 2545 Group Manager that manages this group. This is only used for preemptible 2546 instance groups. 2547 minCpuPlatform: Specifies the minimum cpu platform for the Instance Group. 2548 See Dataproc -> Minimum CPU Platform 2549 (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min- 2550 cpu). 2551 numInstances: Optional. The number of VM instances in the instance group. 2552 For HA cluster master_config groups, must be set to 3. For standard 2553 cluster master_config groups, must be set to 1. 2554 preemptibility: Optional. Specifies the preemptibility of the instance 2555 group.The default value for master and worker groups is NON_PREEMPTIBLE. 2556 This default cannot be changed.The default value for secondary instances 2557 is PREEMPTIBLE. 2558 """ 2559 2560 class PreemptibilityValueValuesEnum(_messages.Enum): 2561 r"""Optional. Specifies the preemptibility of the instance group.The 2562 default value for master and worker groups is NON_PREEMPTIBLE. This 2563 default cannot be changed.The default value for secondary instances is 2564 PREEMPTIBLE. 2565 2566 Values: 2567 PREEMPTIBILITY_UNSPECIFIED: Preemptibility is unspecified, the system 2568 will choose the appropriate setting for each instance group. 2569 NON_PREEMPTIBLE: Instances are non-preemptible.This option is allowed 2570 for all instance groups and is the only valid value for Master and 2571 Worker instance groups. 2572 PREEMPTIBLE: Instances are preemptible.This option is allowed only for 2573 secondary worker groups. 2574 """ 2575 PREEMPTIBILITY_UNSPECIFIED = 0 2576 NON_PREEMPTIBLE = 1 2577 PREEMPTIBLE = 2 2578 2579 accelerators = _messages.MessageField('AcceleratorConfig', 1, repeated=True) 2580 diskConfig = _messages.MessageField('DiskConfig', 2) 2581 imageUri = _messages.StringField(3) 2582 instanceNames = _messages.StringField(4, repeated=True) 2583 instanceReferences = _messages.MessageField('InstanceReference', 5, repeated=True) 2584 isPreemptible = _messages.BooleanField(6) 2585 machineTypeUri = _messages.StringField(7) 2586 managedGroupConfig = _messages.MessageField('ManagedGroupConfig', 8) 2587 minCpuPlatform = _messages.StringField(9) 2588 numInstances = _messages.IntegerField(10, variant=_messages.Variant.INT32) 2589 preemptibility = _messages.EnumField('PreemptibilityValueValuesEnum', 11) 2590 2591 2592class InstanceReference(_messages.Message): 2593 r"""A reference to a Compute Engine instance. 2594 2595 Fields: 2596 instanceId: The unique identifier of the Compute Engine instance. 2597 instanceName: The user-friendly name of the Compute Engine instance. 2598 publicKey: The public key used for sharing data with this instance. 2599 """ 2600 2601 instanceId = _messages.StringField(1) 2602 instanceName = _messages.StringField(2) 2603 publicKey = _messages.StringField(3) 2604 2605 2606class InstantiateWorkflowTemplateRequest(_messages.Message): 2607 r"""A request to instantiate a workflow template. 2608 2609 Messages: 2610 ParametersValue: Optional. Map from parameter names to values that should 2611 be used for those parameters. Values may not exceed 1000 characters. 2612 2613 Fields: 2614 instanceId: Deprecated. Please use request_id field instead. 2615 parameters: Optional. Map from parameter names to values that should be 2616 used for those parameters. Values may not exceed 1000 characters. 2617 requestId: Optional. A tag that prevents multiple concurrent workflow 2618 instances with the same tag from running. This mitigates risk of 2619 concurrent instances started due to retries.It is recommended to always 2620 set this value to a UUID 2621 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag 2622 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 2623 and hyphens (-). The maximum length is 40 characters. 2624 version: Optional. The version of workflow template to instantiate. If 2625 specified, the workflow will be instantiated only if the current version 2626 of the workflow template has the supplied version.This option cannot be 2627 used to instantiate a previous version of workflow template. 2628 """ 2629 2630 @encoding.MapUnrecognizedFields('additionalProperties') 2631 class ParametersValue(_messages.Message): 2632 r"""Optional. Map from parameter names to values that should be used for 2633 those parameters. Values may not exceed 1000 characters. 2634 2635 Messages: 2636 AdditionalProperty: An additional property for a ParametersValue object. 2637 2638 Fields: 2639 additionalProperties: Additional properties of type ParametersValue 2640 """ 2641 2642 class AdditionalProperty(_messages.Message): 2643 r"""An additional property for a ParametersValue object. 2644 2645 Fields: 2646 key: Name of the additional property. 2647 value: A string attribute. 2648 """ 2649 2650 key = _messages.StringField(1) 2651 value = _messages.StringField(2) 2652 2653 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2654 2655 instanceId = _messages.StringField(1) 2656 parameters = _messages.MessageField('ParametersValue', 2) 2657 requestId = _messages.StringField(3) 2658 version = _messages.IntegerField(4, variant=_messages.Variant.INT32) 2659 2660 2661class Job(_messages.Message): 2662 r"""A Dataproc job resource. 2663 2664 Messages: 2665 LabelsValue: Optional. The labels to associate with this job. Label keys 2666 must contain 1 to 63 characters, and must conform to RFC 1035 2667 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, 2668 if present, must contain 1 to 63 characters, and must conform to RFC 2669 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can 2670 be associated with a job. 2671 2672 Fields: 2673 done: Output only. Indicates whether the job is completed. If the value is 2674 false, the job is still in progress. If true, the job is completed, and 2675 status.state field will indicate if it was successful, failed, or 2676 cancelled. 2677 driverControlFilesUri: Output only. If present, the location of 2678 miscellaneous control files which may be used as part of job setup and 2679 handling. If not present, control files may be placed in the same 2680 location as driver_output_uri. 2681 driverOutputResourceUri: Output only. A URI pointing to the location of 2682 the stdout of the job's driver program. 2683 driverRunner: Optional. Configurations for the driver runner 2684 hadoopJob: Optional. Job is a Hadoop job. 2685 hiveJob: Optional. Job is a Hive job. 2686 jobUuid: Output only. A UUID that uniquely identifies a job within the 2687 project over time. This is in contrast to a user-settable 2688 reference.job_id that may be reused over time. 2689 labels: Optional. The labels to associate with this job. Label keys must 2690 contain 1 to 63 characters, and must conform to RFC 1035 2691 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, 2692 if present, must contain 1 to 63 characters, and must conform to RFC 2693 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can 2694 be associated with a job. 2695 pigJob: Optional. Job is a Pig job. 2696 placement: Required. Job information, including how, when, and where to 2697 run the job. 2698 prestoJob: Optional. Job is a Presto job. 2699 pysparkJob: Optional. Job is a PySpark job. 2700 reference: Optional. The fully qualified reference to the job, which can 2701 be used to obtain the equivalent REST path of the job resource. If this 2702 property is not specified when a job is created, the server generates a 2703 job_id. 2704 scheduling: Optional. Job scheduling configuration. 2705 sparkJob: Optional. Job is a Spark job. 2706 sparkRJob: Optional. Job is a SparkR job. 2707 sparkSqlJob: Optional. Job is a SparkSql job. 2708 status: Output only. The job status. Additional application-specific 2709 status information may be contained in the type_job and 2710 yarn_applications fields. 2711 statusHistory: Output only. The previous job status. 2712 submittedBy: Output only. The email address of the user submitting the 2713 job. For jobs submitted on the cluster, the address is 2714 username@hostname. 2715 yarnApplications: Output only. The collection of YARN applications spun up 2716 by this job.Beta Feature: This report is available for testing purposes 2717 only. It may be changed before final release. 2718 """ 2719 2720 @encoding.MapUnrecognizedFields('additionalProperties') 2721 class LabelsValue(_messages.Message): 2722 r"""Optional. The labels to associate with this job. Label keys must 2723 contain 1 to 63 characters, and must conform to RFC 1035 2724 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if 2725 present, must contain 1 to 63 characters, and must conform to RFC 1035 2726 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be 2727 associated with a job. 2728 2729 Messages: 2730 AdditionalProperty: An additional property for a LabelsValue object. 2731 2732 Fields: 2733 additionalProperties: Additional properties of type LabelsValue 2734 """ 2735 2736 class AdditionalProperty(_messages.Message): 2737 r"""An additional property for a LabelsValue object. 2738 2739 Fields: 2740 key: Name of the additional property. 2741 value: A string attribute. 2742 """ 2743 2744 key = _messages.StringField(1) 2745 value = _messages.StringField(2) 2746 2747 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2748 2749 done = _messages.BooleanField(1) 2750 driverControlFilesUri = _messages.StringField(2) 2751 driverOutputResourceUri = _messages.StringField(3) 2752 driverRunner = _messages.MessageField('DriverRunner', 4) 2753 hadoopJob = _messages.MessageField('HadoopJob', 5) 2754 hiveJob = _messages.MessageField('HiveJob', 6) 2755 jobUuid = _messages.StringField(7) 2756 labels = _messages.MessageField('LabelsValue', 8) 2757 pigJob = _messages.MessageField('PigJob', 9) 2758 placement = _messages.MessageField('JobPlacement', 10) 2759 prestoJob = _messages.MessageField('PrestoJob', 11) 2760 pysparkJob = _messages.MessageField('PySparkJob', 12) 2761 reference = _messages.MessageField('JobReference', 13) 2762 scheduling = _messages.MessageField('JobScheduling', 14) 2763 sparkJob = _messages.MessageField('SparkJob', 15) 2764 sparkRJob = _messages.MessageField('SparkRJob', 16) 2765 sparkSqlJob = _messages.MessageField('SparkSqlJob', 17) 2766 status = _messages.MessageField('JobStatus', 18) 2767 statusHistory = _messages.MessageField('JobStatus', 19, repeated=True) 2768 submittedBy = _messages.StringField(20) 2769 yarnApplications = _messages.MessageField('YarnApplication', 21, repeated=True) 2770 2771 2772class JobMetadata(_messages.Message): 2773 r"""Job Operation metadata. 2774 2775 Fields: 2776 jobId: Output only. The job id. 2777 operationType: Output only. Operation type. 2778 startTime: Output only. Job submission time. 2779 status: Output only. Most recent job status. 2780 """ 2781 2782 jobId = _messages.StringField(1) 2783 operationType = _messages.StringField(2) 2784 startTime = _messages.StringField(3) 2785 status = _messages.MessageField('JobStatus', 4) 2786 2787 2788class JobPlacement(_messages.Message): 2789 r"""Dataproc job config. 2790 2791 Messages: 2792 ClusterLabelsValue: Optional. Cluster labels to identify a cluster where 2793 the job will be submitted. 2794 2795 Fields: 2796 clusterLabels: Optional. Cluster labels to identify a cluster where the 2797 job will be submitted. 2798 clusterName: Required. The name of the cluster where the job will be 2799 submitted. 2800 clusterUuid: Output only. A cluster UUID generated by the Dataproc service 2801 when the job is submitted. 2802 """ 2803 2804 @encoding.MapUnrecognizedFields('additionalProperties') 2805 class ClusterLabelsValue(_messages.Message): 2806 r"""Optional. Cluster labels to identify a cluster where the job will be 2807 submitted. 2808 2809 Messages: 2810 AdditionalProperty: An additional property for a ClusterLabelsValue 2811 object. 2812 2813 Fields: 2814 additionalProperties: Additional properties of type ClusterLabelsValue 2815 """ 2816 2817 class AdditionalProperty(_messages.Message): 2818 r"""An additional property for a ClusterLabelsValue object. 2819 2820 Fields: 2821 key: Name of the additional property. 2822 value: A string attribute. 2823 """ 2824 2825 key = _messages.StringField(1) 2826 value = _messages.StringField(2) 2827 2828 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 2829 2830 clusterLabels = _messages.MessageField('ClusterLabelsValue', 1) 2831 clusterName = _messages.StringField(2) 2832 clusterUuid = _messages.StringField(3) 2833 2834 2835class JobReference(_messages.Message): 2836 r"""Encapsulates the full scoping used to reference a job. 2837 2838 Fields: 2839 jobId: Optional. The job ID, which must be unique within the project. The 2840 ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 2841 or hyphens (-). The maximum length is 100 characters.If not specified by 2842 the caller, the job ID will be provided by the server. 2843 projectId: Optional. The ID of the Google Cloud Platform project that the 2844 job belongs to. If specified, must match the request project ID. 2845 """ 2846 2847 jobId = _messages.StringField(1) 2848 projectId = _messages.StringField(2) 2849 2850 2851class JobScheduling(_messages.Message): 2852 r"""Job scheduling options. 2853 2854 Fields: 2855 maxFailuresPerHour: Optional. Maximum number of times per hour a driver 2856 may be restarted as a result of driver terminating with non-zero code 2857 before job is reported failed.A job may be reported as thrashing if 2858 driver exits with non-zero code 4 times within 10 minute window.Maximum 2859 value is 10. 2860 maxFailuresTotal: Optional. Maximum number of times in total a driver may 2861 be restarted as a result of driver exiting with non-zero code before job 2862 is reported failed. Maximum value is 240. 2863 """ 2864 2865 maxFailuresPerHour = _messages.IntegerField(1, variant=_messages.Variant.INT32) 2866 maxFailuresTotal = _messages.IntegerField(2, variant=_messages.Variant.INT32) 2867 2868 2869class JobStatus(_messages.Message): 2870 r"""Dataproc job status. 2871 2872 Enums: 2873 StateValueValuesEnum: Output only. A state message specifying the overall 2874 job state. 2875 SubstateValueValuesEnum: Output only. Additional state information, which 2876 includes status reported by the agent. 2877 2878 Fields: 2879 details: Output only. Optional Job state details, such as an error 2880 description if the state is ERROR. 2881 state: Output only. A state message specifying the overall job state. 2882 stateStartTime: Output only. The time when this state was entered. 2883 substate: Output only. Additional state information, which includes status 2884 reported by the agent. 2885 """ 2886 2887 class StateValueValuesEnum(_messages.Enum): 2888 r"""Output only. A state message specifying the overall job state. 2889 2890 Values: 2891 STATE_UNSPECIFIED: The job state is unknown. 2892 PENDING: The job is pending; it has been submitted, but is not yet 2893 running. 2894 SETUP_DONE: Job has been received by the service and completed initial 2895 setup; it will soon be submitted to the cluster. 2896 RUNNING: The job is running on the cluster. 2897 CANCEL_PENDING: A CancelJob request has been received, but is pending. 2898 CANCEL_STARTED: Transient in-flight resources have been canceled, and 2899 the request to cancel the running job has been issued to the cluster. 2900 CANCELLED: The job cancellation was successful. 2901 DONE: The job has completed successfully. 2902 ERROR: The job has completed, but encountered an error. 2903 ATTEMPT_FAILURE: Job attempt has failed. The detail field contains 2904 failure details for this attempt.Applies to restartable jobs only. 2905 """ 2906 STATE_UNSPECIFIED = 0 2907 PENDING = 1 2908 SETUP_DONE = 2 2909 RUNNING = 3 2910 CANCEL_PENDING = 4 2911 CANCEL_STARTED = 5 2912 CANCELLED = 6 2913 DONE = 7 2914 ERROR = 8 2915 ATTEMPT_FAILURE = 9 2916 2917 class SubstateValueValuesEnum(_messages.Enum): 2918 r"""Output only. Additional state information, which includes status 2919 reported by the agent. 2920 2921 Values: 2922 UNSPECIFIED: The job substate is unknown. 2923 SUBMITTED: The Job is submitted to the agent.Applies to RUNNING state. 2924 QUEUED: The Job has been received and is awaiting execution (it may be 2925 waiting for a condition to be met). See the "details" field for the 2926 reason for the delay.Applies to RUNNING state. 2927 STALE_STATUS: The agent-reported status is out of date, which may be 2928 caused by a loss of communication between the agent and Dataproc. If 2929 the agent does not send a timely update, the job will fail.Applies to 2930 RUNNING state. 2931 """ 2932 UNSPECIFIED = 0 2933 SUBMITTED = 1 2934 QUEUED = 2 2935 STALE_STATUS = 3 2936 2937 details = _messages.StringField(1) 2938 state = _messages.EnumField('StateValueValuesEnum', 2) 2939 stateStartTime = _messages.StringField(3) 2940 substate = _messages.EnumField('SubstateValueValuesEnum', 4) 2941 2942 2943class KerberosConfig(_messages.Message): 2944 r"""Specifies Kerberos related configuration. 2945 2946 Fields: 2947 crossRealmTrustAdminServer: Optional. The admin server (IP or hostname) 2948 for the remote trusted realm in a cross realm trust relationship. 2949 crossRealmTrustKdc: Optional. The KDC (IP or hostname) for the remote 2950 trusted realm in a cross realm trust relationship. 2951 crossRealmTrustRealm: Optional. The remote realm the Dataproc on-cluster 2952 KDC will trust, should the user enable cross realm trust. 2953 crossRealmTrustSharedPasswordUri: Optional. The Cloud Storage URI of a KMS 2954 encrypted file containing the shared password between the on-cluster 2955 Kerberos realm and the remote trusted realm, in a cross realm trust 2956 relationship. 2957 enableKerberos: Optional. Flag to indicate whether to Kerberize the 2958 cluster (default: false). Set this field to true to enable Kerberos on a 2959 cluster. 2960 kdcDbKeyUri: Optional. The Cloud Storage URI of a KMS encrypted file 2961 containing the master key of the KDC database. 2962 keyPasswordUri: Optional. The Cloud Storage URI of a KMS encrypted file 2963 containing the password to the user provided key. For the self-signed 2964 certificate, this password is generated by Dataproc. 2965 keystorePasswordUri: Optional. The Cloud Storage URI of a KMS encrypted 2966 file containing the password to the user provided keystore. For the 2967 self-signed certificate, this password is generated by Dataproc. 2968 keystoreUri: Optional. The Cloud Storage URI of the keystore file used for 2969 SSL encryption. If not provided, Dataproc will provide a self-signed 2970 certificate. 2971 kmsKeyUri: Optional. The uri of the KMS key used to encrypt various 2972 sensitive files. 2973 realm: Optional. The name of the on-cluster Kerberos realm. If not 2974 specified, the uppercased domain of hostnames will be the realm. 2975 rootPrincipalPasswordUri: Optional. The Cloud Storage URI of a KMS 2976 encrypted file containing the root principal password. 2977 tgtLifetimeHours: Optional. The lifetime of the ticket granting ticket, in 2978 hours. If not specified, or user specifies 0, then default value 10 will 2979 be used. 2980 truststorePasswordUri: Optional. The Cloud Storage URI of a KMS encrypted 2981 file containing the password to the user provided truststore. For the 2982 self-signed certificate, this password is generated by Dataproc. 2983 truststoreUri: Optional. The Cloud Storage URI of the truststore file used 2984 for SSL encryption. If not provided, Dataproc will provide a self-signed 2985 certificate. 2986 """ 2987 2988 crossRealmTrustAdminServer = _messages.StringField(1) 2989 crossRealmTrustKdc = _messages.StringField(2) 2990 crossRealmTrustRealm = _messages.StringField(3) 2991 crossRealmTrustSharedPasswordUri = _messages.StringField(4) 2992 enableKerberos = _messages.BooleanField(5) 2993 kdcDbKeyUri = _messages.StringField(6) 2994 keyPasswordUri = _messages.StringField(7) 2995 keystorePasswordUri = _messages.StringField(8) 2996 keystoreUri = _messages.StringField(9) 2997 kmsKeyUri = _messages.StringField(10) 2998 realm = _messages.StringField(11) 2999 rootPrincipalPasswordUri = _messages.StringField(12) 3000 tgtLifetimeHours = _messages.IntegerField(13, variant=_messages.Variant.INT32) 3001 truststorePasswordUri = _messages.StringField(14) 3002 truststoreUri = _messages.StringField(15) 3003 3004 3005class LifecycleConfig(_messages.Message): 3006 r"""Specifies the cluster auto-delete schedule configuration. 3007 3008 Fields: 3009 autoDeleteTime: Optional. The time when cluster will be auto-deleted. (see 3010 JSON representation of Timestamp 3011 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 3012 autoDeleteTtl: Optional. The lifetime duration of cluster. The cluster 3013 will be auto-deleted at the end of this period. Minimum value is 10 3014 minutes; maximum value is 14 days (see JSON representation of Duration 3015 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 3016 idleDeleteTtl: Optional. The duration to keep the cluster alive while 3017 idling (when no jobs are running). Passing this threshold will cause the 3018 cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 3019 days (see JSON representation of Duration 3020 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 3021 idleStartTime: Output only. The time when cluster became idle (most recent 3022 job finished) and became eligible for deletion due to idleness (see JSON 3023 representation of Timestamp (https://developers.google.com/protocol- 3024 buffers/docs/proto3#json)). 3025 """ 3026 3027 autoDeleteTime = _messages.StringField(1) 3028 autoDeleteTtl = _messages.StringField(2) 3029 idleDeleteTtl = _messages.StringField(3) 3030 idleStartTime = _messages.StringField(4) 3031 3032 3033class ListAutoscalingPoliciesResponse(_messages.Message): 3034 r"""A response to a request to list autoscaling policies in a project. 3035 3036 Fields: 3037 nextPageToken: Output only. This token is included in the response if 3038 there are more results to fetch. 3039 policies: Output only. Autoscaling policies list. 3040 """ 3041 3042 nextPageToken = _messages.StringField(1) 3043 policies = _messages.MessageField('AutoscalingPolicy', 2, repeated=True) 3044 3045 3046class ListClustersResponse(_messages.Message): 3047 r"""The list of all clusters in a project. 3048 3049 Fields: 3050 clusters: Output only. The clusters in the project. 3051 nextPageToken: Output only. This token is included in the response if 3052 there are more results to fetch. To fetch additional results, provide 3053 this value as the page_token in a subsequent ListClustersRequest. 3054 """ 3055 3056 clusters = _messages.MessageField('Cluster', 1, repeated=True) 3057 nextPageToken = _messages.StringField(2) 3058 3059 3060class ListJobsResponse(_messages.Message): 3061 r"""A list of jobs in a project. 3062 3063 Fields: 3064 jobs: Output only. Jobs list. 3065 nextPageToken: Optional. This token is included in the response if there 3066 are more results to fetch. To fetch additional results, provide this 3067 value as the page_token in a subsequent ListJobsRequest. 3068 """ 3069 3070 jobs = _messages.MessageField('Job', 1, repeated=True) 3071 nextPageToken = _messages.StringField(2) 3072 3073 3074class ListOperationsResponse(_messages.Message): 3075 r"""The response message for Operations.ListOperations. 3076 3077 Fields: 3078 nextPageToken: The standard List next-page token. 3079 operations: A list of operations that matches the specified filter in the 3080 request. 3081 """ 3082 3083 nextPageToken = _messages.StringField(1) 3084 operations = _messages.MessageField('Operation', 2, repeated=True) 3085 3086 3087class ListWorkflowTemplatesResponse(_messages.Message): 3088 r"""A response to a request to list workflow templates in a project. 3089 3090 Fields: 3091 nextPageToken: Output only. This token is included in the response if 3092 there are more results to fetch. To fetch additional results, provide 3093 this value as the page_token in a subsequent 3094 ListWorkflowTemplatesRequest. 3095 templates: Output only. WorkflowTemplates list. 3096 """ 3097 3098 nextPageToken = _messages.StringField(1) 3099 templates = _messages.MessageField('WorkflowTemplate', 2, repeated=True) 3100 3101 3102class LoggingConfig(_messages.Message): 3103 r"""The runtime logging config of the job. 3104 3105 Messages: 3106 DriverLogLevelsValue: The per-package log levels for the driver. This may 3107 include "root" package name to configure rootLogger. Examples: 3108 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 3109 3110 Fields: 3111 driverLogLevels: The per-package log levels for the driver. This may 3112 include "root" package name to configure rootLogger. Examples: 3113 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG' 3114 """ 3115 3116 @encoding.MapUnrecognizedFields('additionalProperties') 3117 class DriverLogLevelsValue(_messages.Message): 3118 r"""The per-package log levels for the driver. This may include "root" 3119 package name to configure rootLogger. Examples: 'com.google = FATAL', 3120 'root = INFO', 'org.apache = DEBUG' 3121 3122 Messages: 3123 AdditionalProperty: An additional property for a DriverLogLevelsValue 3124 object. 3125 3126 Fields: 3127 additionalProperties: Additional properties of type DriverLogLevelsValue 3128 """ 3129 3130 class AdditionalProperty(_messages.Message): 3131 r"""An additional property for a DriverLogLevelsValue object. 3132 3133 Enums: 3134 ValueValueValuesEnum: 3135 3136 Fields: 3137 key: Name of the additional property. 3138 value: A ValueValueValuesEnum attribute. 3139 """ 3140 3141 class ValueValueValuesEnum(_messages.Enum): 3142 r"""ValueValueValuesEnum enum type. 3143 3144 Values: 3145 LEVEL_UNSPECIFIED: Level is unspecified. Use default level for 3146 log4j. 3147 ALL: Use ALL level for log4j. 3148 TRACE: Use TRACE level for log4j. 3149 DEBUG: Use DEBUG level for log4j. 3150 INFO: Use INFO level for log4j. 3151 WARN: Use WARN level for log4j. 3152 ERROR: Use ERROR level for log4j. 3153 FATAL: Use FATAL level for log4j. 3154 OFF: Turn off log4j. 3155 """ 3156 LEVEL_UNSPECIFIED = 0 3157 ALL = 1 3158 TRACE = 2 3159 DEBUG = 3 3160 INFO = 4 3161 WARN = 5 3162 ERROR = 6 3163 FATAL = 7 3164 OFF = 8 3165 3166 key = _messages.StringField(1) 3167 value = _messages.EnumField('ValueValueValuesEnum', 2) 3168 3169 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3170 3171 driverLogLevels = _messages.MessageField('DriverLogLevelsValue', 1) 3172 3173 3174class ManagedCluster(_messages.Message): 3175 r"""Cluster that is managed by the workflow. 3176 3177 Messages: 3178 LabelsValue: Optional. The labels to associate with this cluster.Label 3179 keys must be between 1 and 63 characters long, and must conform to the 3180 following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must 3181 be between 1 and 63 characters long, and must conform to the following 3182 PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels 3183 can be associated with a given cluster. 3184 3185 Fields: 3186 clusterName: Required. The cluster name prefix. A unique cluster name will 3187 be formed by appending a random suffix.The name must contain only lower- 3188 case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a 3189 letter. Cannot begin or end with hyphen. Must consist of between 2 and 3190 35 characters. 3191 config: Required. The cluster configuration. 3192 labels: Optional. The labels to associate with this cluster.Label keys 3193 must be between 1 and 63 characters long, and must conform to the 3194 following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must 3195 be between 1 and 63 characters long, and must conform to the following 3196 PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels 3197 can be associated with a given cluster. 3198 """ 3199 3200 @encoding.MapUnrecognizedFields('additionalProperties') 3201 class LabelsValue(_messages.Message): 3202 r"""Optional. The labels to associate with this cluster.Label keys must be 3203 between 1 and 63 characters long, and must conform to the following PCRE 3204 regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 3205 63 characters long, and must conform to the following PCRE regular 3206 expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be 3207 associated with a given cluster. 3208 3209 Messages: 3210 AdditionalProperty: An additional property for a LabelsValue object. 3211 3212 Fields: 3213 additionalProperties: Additional properties of type LabelsValue 3214 """ 3215 3216 class AdditionalProperty(_messages.Message): 3217 r"""An additional property for a LabelsValue object. 3218 3219 Fields: 3220 key: Name of the additional property. 3221 value: A string attribute. 3222 """ 3223 3224 key = _messages.StringField(1) 3225 value = _messages.StringField(2) 3226 3227 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3228 3229 clusterName = _messages.StringField(1) 3230 config = _messages.MessageField('ClusterConfig', 2) 3231 labels = _messages.MessageField('LabelsValue', 3) 3232 3233 3234class ManagedGroupConfig(_messages.Message): 3235 r"""Specifies the resources used to actively manage an instance group. 3236 3237 Fields: 3238 instanceGroupManagerName: Output only. The name of the Instance Group 3239 Manager for this group. 3240 instanceTemplateName: Output only. The name of the Instance Template used 3241 for the Managed Instance Group. 3242 """ 3243 3244 instanceGroupManagerName = _messages.StringField(1) 3245 instanceTemplateName = _messages.StringField(2) 3246 3247 3248class MasterDriverRunner(_messages.Message): 3249 r"""The default mode of executing drivers: on master nodes Currently no 3250 internal fields. 3251 """ 3252 3253 3254 3255class MetastoreConfig(_messages.Message): 3256 r"""Specifies a Metastore configuration. 3257 3258 Fields: 3259 dataprocMetastoreService: Required. Resource name of an existing Dataproc 3260 Metastore service.Example: 3261 projects/[project_id]/locations/[dataproc_region]/services/[service- 3262 name] 3263 """ 3264 3265 dataprocMetastoreService = _messages.StringField(1) 3266 3267 3268class NamespacedGkeDeploymentTarget(_messages.Message): 3269 r"""A full, namespace-isolated deployment target for an existing GKE 3270 cluster. 3271 3272 Fields: 3273 clusterNamespace: Optional. A namespace within the GKE cluster to deploy 3274 into. 3275 targetGkeCluster: Optional. The target GKE cluster to deploy to. Format: 3276 'projects/{project}/locations/{location}/clusters/{cluster_id}' 3277 """ 3278 3279 clusterNamespace = _messages.StringField(1) 3280 targetGkeCluster = _messages.StringField(2) 3281 3282 3283class NodeGroupAffinity(_messages.Message): 3284 r"""Node Group Affinity for clusters using sole-tenant node groups. 3285 3286 Fields: 3287 nodeGroupUri: Required. The URI of a sole-tenant node group resource 3288 (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) 3289 that the cluster will be created on.A full URL, partial URI, or node 3290 group name are valid. Examples: 3291 https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us- 3292 central1-a/nodeGroups/node-group-1 projects/[project_id]/zones/us- 3293 central1-a/nodeGroups/node-group-1 node-group-1 3294 """ 3295 3296 nodeGroupUri = _messages.StringField(1) 3297 3298 3299class NodeInitializationAction(_messages.Message): 3300 r"""Specifies an executable to run on a fully configured node and a timeout 3301 period for executable completion. 3302 3303 Fields: 3304 executableFile: Required. Cloud Storage URI of executable file. 3305 executionTimeout: Optional. Amount of time executable has to complete. 3306 Default is 10 minutes (see JSON representation of Duration 3307 (https://developers.google.com/protocol- 3308 buffers/docs/proto3#json)).Cluster creation fails with an explanatory 3309 error message (the name of the executable that caused the error and the 3310 exceeded timeout period) if the executable is not completed at end of 3311 the timeout period. 3312 """ 3313 3314 executableFile = _messages.StringField(1) 3315 executionTimeout = _messages.StringField(2) 3316 3317 3318class Operation(_messages.Message): 3319 r"""This resource represents a long-running operation that is the result of 3320 a network API call. 3321 3322 Messages: 3323 MetadataValue: Service-specific metadata associated with the operation. It 3324 typically contains progress information and common metadata such as 3325 create time. Some services might not provide such metadata. Any method 3326 that returns a long-running operation should document the metadata type, 3327 if any. 3328 ResponseValue: The normal response of the operation in case of success. If 3329 the original method returns no data on success, such as Delete, the 3330 response is google.protobuf.Empty. If the original method is standard 3331 Get/Create/Update, the response should be the resource. For other 3332 methods, the response should have the type XxxResponse, where Xxx is the 3333 original method name. For example, if the original method name is 3334 TakeSnapshot(), the inferred response type is TakeSnapshotResponse. 3335 3336 Fields: 3337 done: If the value is false, it means the operation is still in progress. 3338 If true, the operation is completed, and either error or response is 3339 available. 3340 error: The error result of the operation in case of failure or 3341 cancellation. 3342 metadata: Service-specific metadata associated with the operation. It 3343 typically contains progress information and common metadata such as 3344 create time. Some services might not provide such metadata. Any method 3345 that returns a long-running operation should document the metadata type, 3346 if any. 3347 name: The server-assigned name, which is only unique within the same 3348 service that originally returns it. If you use the default HTTP mapping, 3349 the name should be a resource name ending with operations/{unique_id}. 3350 response: The normal response of the operation in case of success. If the 3351 original method returns no data on success, such as Delete, the response 3352 is google.protobuf.Empty. If the original method is standard 3353 Get/Create/Update, the response should be the resource. For other 3354 methods, the response should have the type XxxResponse, where Xxx is the 3355 original method name. For example, if the original method name is 3356 TakeSnapshot(), the inferred response type is TakeSnapshotResponse. 3357 """ 3358 3359 @encoding.MapUnrecognizedFields('additionalProperties') 3360 class MetadataValue(_messages.Message): 3361 r"""Service-specific metadata associated with the operation. It typically 3362 contains progress information and common metadata such as create time. 3363 Some services might not provide such metadata. Any method that returns a 3364 long-running operation should document the metadata type, if any. 3365 3366 Messages: 3367 AdditionalProperty: An additional property for a MetadataValue object. 3368 3369 Fields: 3370 additionalProperties: Properties of the object. Contains field @type 3371 with type URL. 3372 """ 3373 3374 class AdditionalProperty(_messages.Message): 3375 r"""An additional property for a MetadataValue object. 3376 3377 Fields: 3378 key: Name of the additional property. 3379 value: A extra_types.JsonValue attribute. 3380 """ 3381 3382 key = _messages.StringField(1) 3383 value = _messages.MessageField('extra_types.JsonValue', 2) 3384 3385 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3386 3387 @encoding.MapUnrecognizedFields('additionalProperties') 3388 class ResponseValue(_messages.Message): 3389 r"""The normal response of the operation in case of success. If the 3390 original method returns no data on success, such as Delete, the response 3391 is google.protobuf.Empty. If the original method is standard 3392 Get/Create/Update, the response should be the resource. For other methods, 3393 the response should have the type XxxResponse, where Xxx is the original 3394 method name. For example, if the original method name is TakeSnapshot(), 3395 the inferred response type is TakeSnapshotResponse. 3396 3397 Messages: 3398 AdditionalProperty: An additional property for a ResponseValue object. 3399 3400 Fields: 3401 additionalProperties: Properties of the object. Contains field @type 3402 with type URL. 3403 """ 3404 3405 class AdditionalProperty(_messages.Message): 3406 r"""An additional property for a ResponseValue object. 3407 3408 Fields: 3409 key: Name of the additional property. 3410 value: A extra_types.JsonValue attribute. 3411 """ 3412 3413 key = _messages.StringField(1) 3414 value = _messages.MessageField('extra_types.JsonValue', 2) 3415 3416 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3417 3418 done = _messages.BooleanField(1) 3419 error = _messages.MessageField('Status', 2) 3420 metadata = _messages.MessageField('MetadataValue', 3) 3421 name = _messages.StringField(4) 3422 response = _messages.MessageField('ResponseValue', 5) 3423 3424 3425class OrderedJob(_messages.Message): 3426 r"""A job executed by the workflow. 3427 3428 Messages: 3429 LabelsValue: Optional. The labels to associate with this job.Label keys 3430 must be between 1 and 63 characters long, and must conform to the 3431 following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be 3432 between 1 and 63 characters long, and must conform to the following 3433 regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can 3434 be associated with a given job. 3435 3436 Fields: 3437 hadoopJob: Optional. Job is a Hadoop job. 3438 hiveJob: Optional. Job is a Hive job. 3439 labels: Optional. The labels to associate with this job.Label keys must be 3440 between 1 and 63 characters long, and must conform to the following 3441 regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 3442 63 characters long, and must conform to the following regular 3443 expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be 3444 associated with a given job. 3445 pigJob: Optional. Job is a Pig job. 3446 prerequisiteStepIds: Optional. The optional list of prerequisite job 3447 step_ids. If not specified, the job will start at the beginning of 3448 workflow. 3449 prestoJob: Optional. Job is a Presto job. 3450 pysparkJob: Optional. Job is a PySpark job. 3451 scheduling: Optional. Job scheduling configuration. 3452 sparkJob: Optional. Job is a Spark job. 3453 sparkRJob: Optional. Job is a SparkR job. 3454 sparkSqlJob: Optional. Job is a SparkSql job. 3455 stepId: Required. The step id. The id must be unique among all jobs within 3456 the template.The step id is used as prefix for job id, as job goog- 3457 dataproc-workflow-step-id label, and in prerequisiteStepIds field from 3458 other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), 3459 underscores (_), and hyphens (-). Cannot begin or end with underscore or 3460 hyphen. Must consist of between 3 and 50 characters. 3461 """ 3462 3463 @encoding.MapUnrecognizedFields('additionalProperties') 3464 class LabelsValue(_messages.Message): 3465 r"""Optional. The labels to associate with this job.Label keys must be 3466 between 1 and 63 characters long, and must conform to the following 3467 regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 3468 63 characters long, and must conform to the following regular expression: 3469 \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a 3470 given job. 3471 3472 Messages: 3473 AdditionalProperty: An additional property for a LabelsValue object. 3474 3475 Fields: 3476 additionalProperties: Additional properties of type LabelsValue 3477 """ 3478 3479 class AdditionalProperty(_messages.Message): 3480 r"""An additional property for a LabelsValue object. 3481 3482 Fields: 3483 key: Name of the additional property. 3484 value: A string attribute. 3485 """ 3486 3487 key = _messages.StringField(1) 3488 value = _messages.StringField(2) 3489 3490 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3491 3492 hadoopJob = _messages.MessageField('HadoopJob', 1) 3493 hiveJob = _messages.MessageField('HiveJob', 2) 3494 labels = _messages.MessageField('LabelsValue', 3) 3495 pigJob = _messages.MessageField('PigJob', 4) 3496 prerequisiteStepIds = _messages.StringField(5, repeated=True) 3497 prestoJob = _messages.MessageField('PrestoJob', 6) 3498 pysparkJob = _messages.MessageField('PySparkJob', 7) 3499 scheduling = _messages.MessageField('JobScheduling', 8) 3500 sparkJob = _messages.MessageField('SparkJob', 9) 3501 sparkRJob = _messages.MessageField('SparkRJob', 10) 3502 sparkSqlJob = _messages.MessageField('SparkSqlJob', 11) 3503 stepId = _messages.StringField(12) 3504 3505 3506class ParameterValidation(_messages.Message): 3507 r"""Configuration for parameter validation. 3508 3509 Fields: 3510 regex: Validation based on regular expressions. 3511 values: Validation based on a list of allowed values. 3512 """ 3513 3514 regex = _messages.MessageField('RegexValidation', 1) 3515 values = _messages.MessageField('ValueValidation', 2) 3516 3517 3518class PigJob(_messages.Message): 3519 r"""A Dataproc job for running Apache Pig (https://pig.apache.org/) queries 3520 on YARN. 3521 3522 Messages: 3523 PropertiesValue: Optional. A mapping of property names to values, used to 3524 configure Pig. Properties that conflict with values set by the Dataproc 3525 API may be overwritten. Can include properties set in 3526 /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes 3527 in user code. 3528 ScriptVariablesValue: Optional. Mapping of query variable names to values 3529 (equivalent to the Pig command: name=[value]). 3530 3531 Fields: 3532 continueOnFailure: Optional. Whether to continue executing queries if a 3533 query fails. The default value is false. Setting to true can be useful 3534 when executing independent parallel queries. 3535 jarFileUris: Optional. HCFS URIs of jar files to add to the CLASSPATH of 3536 the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. 3537 loggingConfig: Optional. The runtime log config for job execution. 3538 properties: Optional. A mapping of property names to values, used to 3539 configure Pig. Properties that conflict with values set by the Dataproc 3540 API may be overwritten. Can include properties set in 3541 /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes 3542 in user code. 3543 queryFileUri: The HCFS URI of the script that contains the Pig queries. 3544 queryList: A list of queries. 3545 scriptVariables: Optional. Mapping of query variable names to values 3546 (equivalent to the Pig command: name=[value]). 3547 """ 3548 3549 @encoding.MapUnrecognizedFields('additionalProperties') 3550 class PropertiesValue(_messages.Message): 3551 r"""Optional. A mapping of property names to values, used to configure 3552 Pig. Properties that conflict with values set by the Dataproc API may be 3553 overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, 3554 /etc/pig/conf/pig.properties, and classes in user code. 3555 3556 Messages: 3557 AdditionalProperty: An additional property for a PropertiesValue object. 3558 3559 Fields: 3560 additionalProperties: Additional properties of type PropertiesValue 3561 """ 3562 3563 class AdditionalProperty(_messages.Message): 3564 r"""An additional property for a PropertiesValue object. 3565 3566 Fields: 3567 key: Name of the additional property. 3568 value: A string attribute. 3569 """ 3570 3571 key = _messages.StringField(1) 3572 value = _messages.StringField(2) 3573 3574 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3575 3576 @encoding.MapUnrecognizedFields('additionalProperties') 3577 class ScriptVariablesValue(_messages.Message): 3578 r"""Optional. Mapping of query variable names to values (equivalent to the 3579 Pig command: name=[value]). 3580 3581 Messages: 3582 AdditionalProperty: An additional property for a ScriptVariablesValue 3583 object. 3584 3585 Fields: 3586 additionalProperties: Additional properties of type ScriptVariablesValue 3587 """ 3588 3589 class AdditionalProperty(_messages.Message): 3590 r"""An additional property for a ScriptVariablesValue object. 3591 3592 Fields: 3593 key: Name of the additional property. 3594 value: A string attribute. 3595 """ 3596 3597 key = _messages.StringField(1) 3598 value = _messages.StringField(2) 3599 3600 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3601 3602 continueOnFailure = _messages.BooleanField(1) 3603 jarFileUris = _messages.StringField(2, repeated=True) 3604 loggingConfig = _messages.MessageField('LoggingConfig', 3) 3605 properties = _messages.MessageField('PropertiesValue', 4) 3606 queryFileUri = _messages.StringField(5) 3607 queryList = _messages.MessageField('QueryList', 6) 3608 scriptVariables = _messages.MessageField('ScriptVariablesValue', 7) 3609 3610 3611class Policy(_messages.Message): 3612 r"""An Identity and Access Management (IAM) policy, which specifies access 3613 controls for Google Cloud resources.A Policy is a collection of bindings. A 3614 binding binds one or more members to a single role. Members can be user 3615 accounts, service accounts, Google groups, and domains (such as G Suite). A 3616 role is a named list of permissions; each role can be an IAM predefined role 3617 or a user-created custom role.For some types of Google Cloud resources, a 3618 binding can also specify a condition, which is a logical expression that 3619 allows access to a resource only if the expression evaluates to true. A 3620 condition can add constraints based on attributes of the request, the 3621 resource, or both. To learn which resources support conditions in their IAM 3622 policies, see the IAM documentation 3623 (https://cloud.google.com/iam/help/conditions/resource-policies).JSON 3624 example: { "bindings": [ { "role": 3625 "roles/resourcemanager.organizationAdmin", "members": [ 3626 "user:mike@example.com", "group:admins@example.com", "domain:google.com", 3627 "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": 3628 "roles/resourcemanager.organizationViewer", "members": [ 3629 "user:eve@example.com" ], "condition": { "title": "expirable access", 3630 "description": "Does not grant access after Sep 2020", "expression": 3631 "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": 3632 "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - 3633 user:mike@example.com - group:admins@example.com - domain:google.com - 3634 serviceAccount:my-project-id@appspot.gserviceaccount.com role: 3635 roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 3636 role: roles/resourcemanager.organizationViewer condition: title: expirable 3637 access description: Does not grant access after Sep 2020 expression: 3638 request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - 3639 version: 3 For a description of IAM and its features, see the IAM 3640 documentation (https://cloud.google.com/iam/docs/). 3641 3642 Fields: 3643 bindings: Associates a list of members to a role. Optionally, may specify 3644 a condition that determines how and when the bindings are applied. Each 3645 of the bindings must contain at least one member. 3646 etag: etag is used for optimistic concurrency control as a way to help 3647 prevent simultaneous updates of a policy from overwriting each other. It 3648 is strongly suggested that systems make use of the etag in the read- 3649 modify-write cycle to perform policy updates in order to avoid race 3650 conditions: An etag is returned in the response to getIamPolicy, and 3651 systems are expected to put that etag in the request to setIamPolicy to 3652 ensure that their change will be applied to the same version of the 3653 policy.Important: If you use IAM Conditions, you must include the etag 3654 field whenever you call setIamPolicy. If you omit this field, then IAM 3655 allows you to overwrite a version 3 policy with a version 1 policy, and 3656 all of the conditions in the version 3 policy are lost. 3657 version: Specifies the format of the policy.Valid values are 0, 1, and 3. 3658 Requests that specify an invalid value are rejected.Any operation that 3659 affects conditional role bindings must specify version 3. This 3660 requirement applies to the following operations: Getting a policy that 3661 includes a conditional role binding Adding a conditional role binding to 3662 a policy Changing a conditional role binding in a policy Removing any 3663 role binding, with or without a condition, from a policy that includes 3664 conditionsImportant: If you use IAM Conditions, you must include the 3665 etag field whenever you call setIamPolicy. If you omit this field, then 3666 IAM allows you to overwrite a version 3 policy with a version 1 policy, 3667 and all of the conditions in the version 3 policy are lost.If a policy 3668 does not include any conditions, operations on that policy may specify 3669 any valid version or leave the field unset.To learn which resources 3670 support conditions in their IAM policies, see the IAM documentation 3671 (https://cloud.google.com/iam/help/conditions/resource-policies). 3672 """ 3673 3674 bindings = _messages.MessageField('Binding', 1, repeated=True) 3675 etag = _messages.BytesField(2) 3676 version = _messages.IntegerField(3, variant=_messages.Variant.INT32) 3677 3678 3679class PrestoJob(_messages.Message): 3680 r"""A Dataproc job for running Presto (https://prestosql.io/) queries. 3681 IMPORTANT: The Dataproc Presto Optional Component 3682 (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be 3683 enabled when the cluster is created to submit a Presto job to the cluster. 3684 3685 Messages: 3686 PropertiesValue: Optional. A mapping of property names to values. Used to 3687 set Presto session properties (https://prestodb.io/docs/current/sql/set- 3688 session.html) Equivalent to using the --session flag in the Presto CLI 3689 3690 Fields: 3691 clientTags: Optional. Presto client tags to attach to this query 3692 continueOnFailure: Optional. Whether to continue executing queries if a 3693 query fails. The default value is false. Setting to true can be useful 3694 when executing independent parallel queries. 3695 loggingConfig: Optional. The runtime log config for job execution. 3696 outputFormat: Optional. The format in which query output will be 3697 displayed. See the Presto documentation for supported output formats 3698 properties: Optional. A mapping of property names to values. Used to set 3699 Presto session properties (https://prestodb.io/docs/current/sql/set- 3700 session.html) Equivalent to using the --session flag in the Presto CLI 3701 queryFileUri: The HCFS URI of the script that contains SQL queries. 3702 queryList: A list of queries. 3703 """ 3704 3705 @encoding.MapUnrecognizedFields('additionalProperties') 3706 class PropertiesValue(_messages.Message): 3707 r"""Optional. A mapping of property names to values. Used to set Presto 3708 session properties (https://prestodb.io/docs/current/sql/set-session.html) 3709 Equivalent to using the --session flag in the Presto CLI 3710 3711 Messages: 3712 AdditionalProperty: An additional property for a PropertiesValue object. 3713 3714 Fields: 3715 additionalProperties: Additional properties of type PropertiesValue 3716 """ 3717 3718 class AdditionalProperty(_messages.Message): 3719 r"""An additional property for a PropertiesValue object. 3720 3721 Fields: 3722 key: Name of the additional property. 3723 value: A string attribute. 3724 """ 3725 3726 key = _messages.StringField(1) 3727 value = _messages.StringField(2) 3728 3729 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3730 3731 clientTags = _messages.StringField(1, repeated=True) 3732 continueOnFailure = _messages.BooleanField(2) 3733 loggingConfig = _messages.MessageField('LoggingConfig', 3) 3734 outputFormat = _messages.StringField(4) 3735 properties = _messages.MessageField('PropertiesValue', 5) 3736 queryFileUri = _messages.StringField(6) 3737 queryList = _messages.MessageField('QueryList', 7) 3738 3739 3740class PySparkJob(_messages.Message): 3741 r"""A Dataproc job for running Apache PySpark 3742 (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) 3743 applications on YARN. 3744 3745 Messages: 3746 PropertiesValue: Optional. A mapping of property names to values, used to 3747 configure PySpark. Properties that conflict with values set by the 3748 Dataproc API may be overwritten. Can include properties set in 3749 /etc/spark/conf/spark-defaults.conf and classes in user code. 3750 3751 Fields: 3752 archiveUris: Optional. HCFS URIs of archives to be extracted into the 3753 working directory of each executor. Supported file types: .jar, .tar, 3754 .tar.gz, .tgz, and .zip. 3755 args: Optional. The arguments to pass to the driver. Do not include 3756 arguments, such as --conf, that can be set as job properties, since a 3757 collision may occur that causes an incorrect job submission. 3758 fileUris: Optional. HCFS URIs of files to be placed in the working 3759 directory of each executor. Useful for naively parallel tasks. 3760 jarFileUris: Optional. HCFS URIs of jar files to add to the CLASSPATHs of 3761 the Python driver and tasks. 3762 loggingConfig: Optional. The runtime log config for job execution. 3763 mainPythonFileUri: Required. The HCFS URI of the main Python file to use 3764 as the driver. Must be a .py file. 3765 properties: Optional. A mapping of property names to values, used to 3766 configure PySpark. Properties that conflict with values set by the 3767 Dataproc API may be overwritten. Can include properties set in 3768 /etc/spark/conf/spark-defaults.conf and classes in user code. 3769 pythonFileUris: Optional. HCFS file URIs of Python files to pass to the 3770 PySpark framework. Supported file types: .py, .egg, and .zip. 3771 """ 3772 3773 @encoding.MapUnrecognizedFields('additionalProperties') 3774 class PropertiesValue(_messages.Message): 3775 r"""Optional. A mapping of property names to values, used to configure 3776 PySpark. Properties that conflict with values set by the Dataproc API may 3777 be overwritten. Can include properties set in /etc/spark/conf/spark- 3778 defaults.conf and classes in user code. 3779 3780 Messages: 3781 AdditionalProperty: An additional property for a PropertiesValue object. 3782 3783 Fields: 3784 additionalProperties: Additional properties of type PropertiesValue 3785 """ 3786 3787 class AdditionalProperty(_messages.Message): 3788 r"""An additional property for a PropertiesValue object. 3789 3790 Fields: 3791 key: Name of the additional property. 3792 value: A string attribute. 3793 """ 3794 3795 key = _messages.StringField(1) 3796 value = _messages.StringField(2) 3797 3798 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 3799 3800 archiveUris = _messages.StringField(1, repeated=True) 3801 args = _messages.StringField(2, repeated=True) 3802 fileUris = _messages.StringField(3, repeated=True) 3803 jarFileUris = _messages.StringField(4, repeated=True) 3804 loggingConfig = _messages.MessageField('LoggingConfig', 5) 3805 mainPythonFileUri = _messages.StringField(6) 3806 properties = _messages.MessageField('PropertiesValue', 7) 3807 pythonFileUris = _messages.StringField(8, repeated=True) 3808 3809 3810class QueryList(_messages.Message): 3811 r"""A list of queries to run on a cluster. 3812 3813 Fields: 3814 queries: Required. The queries to execute. You do not need to end a query 3815 expression with a semicolon. Multiple queries can be specified in one 3816 string by separating each with a semicolon. Here is an example of a 3817 Dataproc API snippet that uses a QueryList to specify a HiveJob: 3818 "hiveJob": { "queryList": { "queries": [ "query1", "query2", 3819 "query3;query4", ] } } 3820 """ 3821 3822 queries = _messages.StringField(1, repeated=True) 3823 3824 3825class RegexValidation(_messages.Message): 3826 r"""Validation based on regular expressions. 3827 3828 Fields: 3829 regexes: Required. RE2 regular expressions used to validate the 3830 parameter's value. The value must match the regex in its entirety 3831 (substring matches are not sufficient). 3832 """ 3833 3834 regexes = _messages.StringField(1, repeated=True) 3835 3836 3837class ReservationAffinity(_messages.Message): 3838 r"""Reservation Affinity for consuming Zonal reservation. 3839 3840 Enums: 3841 ConsumeReservationTypeValueValuesEnum: Optional. Type of reservation to 3842 consume 3843 3844 Fields: 3845 consumeReservationType: Optional. Type of reservation to consume 3846 key: Optional. Corresponds to the label key of reservation resource. 3847 values: Optional. Corresponds to the label values of reservation resource. 3848 """ 3849 3850 class ConsumeReservationTypeValueValuesEnum(_messages.Enum): 3851 r"""Optional. Type of reservation to consume 3852 3853 Values: 3854 TYPE_UNSPECIFIED: <no description> 3855 NO_RESERVATION: Do not consume from any allocated capacity. 3856 ANY_RESERVATION: Consume any reservation available. 3857 SPECIFIC_RESERVATION: Must consume from a specific reservation. Must 3858 specify key value fields for specifying the reservations. 3859 """ 3860 TYPE_UNSPECIFIED = 0 3861 NO_RESERVATION = 1 3862 ANY_RESERVATION = 2 3863 SPECIFIC_RESERVATION = 3 3864 3865 consumeReservationType = _messages.EnumField('ConsumeReservationTypeValueValuesEnum', 1) 3866 key = _messages.StringField(2) 3867 values = _messages.StringField(3, repeated=True) 3868 3869 3870class SecurityConfig(_messages.Message): 3871 r"""Security related configuration, including encryption, Kerberos, etc. 3872 3873 Fields: 3874 identityConfig: Optional. Identity related configuration, including 3875 service account based secure multi-tenancy user mappings. 3876 kerberosConfig: Optional. Kerberos related configuration. 3877 """ 3878 3879 identityConfig = _messages.MessageField('IdentityConfig', 1) 3880 kerberosConfig = _messages.MessageField('KerberosConfig', 2) 3881 3882 3883class SetIamPolicyRequest(_messages.Message): 3884 r"""Request message for SetIamPolicy method. 3885 3886 Fields: 3887 policy: REQUIRED: The complete policy to be applied to the resource. The 3888 size of the policy is limited to a few 10s of KB. An empty policy is a 3889 valid policy but certain Cloud Platform services (such as Projects) 3890 might reject them. 3891 """ 3892 3893 policy = _messages.MessageField('Policy', 1) 3894 3895 3896class ShieldedInstanceConfig(_messages.Message): 3897 r"""Shielded Instance Config for clusters using Compute Engine Shielded VMs 3898 (https://cloud.google.com/security/shielded-cloud/shielded-vm). 3899 3900 Fields: 3901 enableIntegrityMonitoring: Optional. Defines whether instances have 3902 integrity monitoring enabled. 3903 enableSecureBoot: Optional. Defines whether instances have Secure Boot 3904 enabled. 3905 enableVtpm: Optional. Defines whether instances have the vTPM enabled. 3906 """ 3907 3908 enableIntegrityMonitoring = _messages.BooleanField(1) 3909 enableSecureBoot = _messages.BooleanField(2) 3910 enableVtpm = _messages.BooleanField(3) 3911 3912 3913class SoftwareConfig(_messages.Message): 3914 r"""Specifies the selection and config of software inside the cluster. 3915 3916 Enums: 3917 OptionalComponentsValueListEntryValuesEnum: 3918 3919 Messages: 3920 PropertiesValue: Optional. The properties to set on daemon config 3921 files.Property keys are specified in prefix:property format, for example 3922 core:hadoop.tmp.dir. The following are supported prefixes and their 3923 mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml 3924 distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml 3925 mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf 3926 yarn: yarn-site.xmlFor more information, see Cluster properties 3927 (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). 3928 3929 Fields: 3930 imageVersion: Optional. The version of software inside the cluster. It 3931 must be one of the supported Dataproc Versions 3932 (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc- 3933 versions#supported_dataproc_versions), such as "1.2" (including a 3934 subminor version, such as "1.2.29"), or the "preview" version 3935 (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc- 3936 versions#other_versions). If unspecified, it defaults to the latest 3937 Debian version. 3938 optionalComponents: The set of optional components to activate on the 3939 cluster. 3940 properties: Optional. The properties to set on daemon config 3941 files.Property keys are specified in prefix:property format, for example 3942 core:hadoop.tmp.dir. The following are supported prefixes and their 3943 mappings: capacity-scheduler: capacity-scheduler.xml core: core-site.xml 3944 distcp: distcp-default.xml hdfs: hdfs-site.xml hive: hive-site.xml 3945 mapred: mapred-site.xml pig: pig.properties spark: spark-defaults.conf 3946 yarn: yarn-site.xmlFor more information, see Cluster properties 3947 (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). 3948 """ 3949 3950 class OptionalComponentsValueListEntryValuesEnum(_messages.Enum): 3951 r"""OptionalComponentsValueListEntryValuesEnum enum type. 3952 3953 Values: 3954 COMPONENT_UNSPECIFIED: Unspecified component. Specifying this will cause 3955 Cluster creation to fail. 3956 ANACONDA: The Anaconda python distribution. The Anaconda component is 3957 not supported in the Dataproc 2.0 image. The 2.0 image is pre- 3958 installed with Miniconda. 3959 DOCKER: Docker 3960 DRUID: The Druid query engine. 3961 FLINK: Flink 3962 HBASE: HBase. 3963 HIVE_WEBHCAT: The Hive Web HCatalog (the REST service for accessing 3964 HCatalog). 3965 JUPYTER: The Jupyter Notebook. 3966 KERBEROS: The Kerberos security feature. 3967 PRESTO: The Presto query engine. 3968 RANGER: The Ranger service. 3969 SOLR: The Solr service. 3970 ZEPPELIN: The Zeppelin notebook. 3971 ZOOKEEPER: The Zookeeper service. 3972 """ 3973 COMPONENT_UNSPECIFIED = 0 3974 ANACONDA = 1 3975 DOCKER = 2 3976 DRUID = 3 3977 FLINK = 4 3978 HBASE = 5 3979 HIVE_WEBHCAT = 6 3980 JUPYTER = 7 3981 KERBEROS = 8 3982 PRESTO = 9 3983 RANGER = 10 3984 SOLR = 11 3985 ZEPPELIN = 12 3986 ZOOKEEPER = 13 3987 3988 @encoding.MapUnrecognizedFields('additionalProperties') 3989 class PropertiesValue(_messages.Message): 3990 r"""Optional. The properties to set on daemon config files.Property keys 3991 are specified in prefix:property format, for example core:hadoop.tmp.dir. 3992 The following are supported prefixes and their mappings: capacity- 3993 scheduler: capacity-scheduler.xml core: core-site.xml distcp: distcp- 3994 default.xml hdfs: hdfs-site.xml hive: hive-site.xml mapred: mapred- 3995 site.xml pig: pig.properties spark: spark-defaults.conf yarn: yarn- 3996 site.xmlFor more information, see Cluster properties 3997 (https://cloud.google.com/dataproc/docs/concepts/cluster-properties). 3998 3999 Messages: 4000 AdditionalProperty: An additional property for a PropertiesValue object. 4001 4002 Fields: 4003 additionalProperties: Additional properties of type PropertiesValue 4004 """ 4005 4006 class AdditionalProperty(_messages.Message): 4007 r"""An additional property for a PropertiesValue object. 4008 4009 Fields: 4010 key: Name of the additional property. 4011 value: A string attribute. 4012 """ 4013 4014 key = _messages.StringField(1) 4015 value = _messages.StringField(2) 4016 4017 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4018 4019 imageVersion = _messages.StringField(1) 4020 optionalComponents = _messages.EnumField('OptionalComponentsValueListEntryValuesEnum', 2, repeated=True) 4021 properties = _messages.MessageField('PropertiesValue', 3) 4022 4023 4024class SparkJob(_messages.Message): 4025 r"""A Dataproc job for running Apache Spark (http://spark.apache.org/) 4026 applications on YARN. The specification of the main method to call to drive 4027 the job. Specify either the jar file that contains the main class or the 4028 main class name. To pass both a main jar and a main class in that jar, add 4029 the jar to CommonJob.jar_file_uris, and then specify the main class name in 4030 main_class. 4031 4032 Messages: 4033 PropertiesValue: Optional. A mapping of property names to values, used to 4034 configure Spark. Properties that conflict with values set by the 4035 Dataproc API may be overwritten. Can include properties set in 4036 /etc/spark/conf/spark-defaults.conf and classes in user code. 4037 4038 Fields: 4039 archiveUris: Optional. HCFS URIs of archives to be extracted into the 4040 working directory of each executor. Supported file types: .jar, .tar, 4041 .tar.gz, .tgz, and .zip. 4042 args: Optional. The arguments to pass to the driver. Do not include 4043 arguments, such as --conf, that can be set as job properties, since a 4044 collision may occur that causes an incorrect job submission. 4045 fileUris: Optional. HCFS URIs of files to be placed in the working 4046 directory of each executor. Useful for naively parallel tasks. 4047 jarFileUris: Optional. HCFS URIs of jar files to add to the CLASSPATHs of 4048 the Spark driver and tasks. 4049 loggingConfig: Optional. The runtime log config for job execution. 4050 mainClass: The name of the driver's main class. The jar file that contains 4051 the class must be in the default CLASSPATH or specified in 4052 jar_file_uris. 4053 mainJarFileUri: The HCFS URI of the jar file that contains the main class. 4054 properties: Optional. A mapping of property names to values, used to 4055 configure Spark. Properties that conflict with values set by the 4056 Dataproc API may be overwritten. Can include properties set in 4057 /etc/spark/conf/spark-defaults.conf and classes in user code. 4058 """ 4059 4060 @encoding.MapUnrecognizedFields('additionalProperties') 4061 class PropertiesValue(_messages.Message): 4062 r"""Optional. A mapping of property names to values, used to configure 4063 Spark. Properties that conflict with values set by the Dataproc API may be 4064 overwritten. Can include properties set in /etc/spark/conf/spark- 4065 defaults.conf and classes in user code. 4066 4067 Messages: 4068 AdditionalProperty: An additional property for a PropertiesValue object. 4069 4070 Fields: 4071 additionalProperties: Additional properties of type PropertiesValue 4072 """ 4073 4074 class AdditionalProperty(_messages.Message): 4075 r"""An additional property for a PropertiesValue object. 4076 4077 Fields: 4078 key: Name of the additional property. 4079 value: A string attribute. 4080 """ 4081 4082 key = _messages.StringField(1) 4083 value = _messages.StringField(2) 4084 4085 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4086 4087 archiveUris = _messages.StringField(1, repeated=True) 4088 args = _messages.StringField(2, repeated=True) 4089 fileUris = _messages.StringField(3, repeated=True) 4090 jarFileUris = _messages.StringField(4, repeated=True) 4091 loggingConfig = _messages.MessageField('LoggingConfig', 5) 4092 mainClass = _messages.StringField(6) 4093 mainJarFileUri = _messages.StringField(7) 4094 properties = _messages.MessageField('PropertiesValue', 8) 4095 4096 4097class SparkRJob(_messages.Message): 4098 r"""A Dataproc job for running Apache SparkR 4099 (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. 4100 4101 Messages: 4102 PropertiesValue: Optional. A mapping of property names to values, used to 4103 configure SparkR. Properties that conflict with values set by the 4104 Dataproc API may be overwritten. Can include properties set in 4105 /etc/spark/conf/spark-defaults.conf and classes in user code. 4106 4107 Fields: 4108 archiveUris: Optional. HCFS URIs of archives to be extracted into the 4109 working directory of each executor. Supported file types: .jar, .tar, 4110 .tar.gz, .tgz, and .zip. 4111 args: Optional. The arguments to pass to the driver. Do not include 4112 arguments, such as --conf, that can be set as job properties, since a 4113 collision may occur that causes an incorrect job submission. 4114 fileUris: Optional. HCFS URIs of files to be placed in the working 4115 directory of each executor. Useful for naively parallel tasks. 4116 loggingConfig: Optional. The runtime log config for job execution. 4117 mainRFileUri: Required. The HCFS URI of the main R file to use as the 4118 driver. Must be a .R file. 4119 properties: Optional. A mapping of property names to values, used to 4120 configure SparkR. Properties that conflict with values set by the 4121 Dataproc API may be overwritten. Can include properties set in 4122 /etc/spark/conf/spark-defaults.conf and classes in user code. 4123 """ 4124 4125 @encoding.MapUnrecognizedFields('additionalProperties') 4126 class PropertiesValue(_messages.Message): 4127 r"""Optional. A mapping of property names to values, used to configure 4128 SparkR. Properties that conflict with values set by the Dataproc API may 4129 be overwritten. Can include properties set in /etc/spark/conf/spark- 4130 defaults.conf and classes in user code. 4131 4132 Messages: 4133 AdditionalProperty: An additional property for a PropertiesValue object. 4134 4135 Fields: 4136 additionalProperties: Additional properties of type PropertiesValue 4137 """ 4138 4139 class AdditionalProperty(_messages.Message): 4140 r"""An additional property for a PropertiesValue object. 4141 4142 Fields: 4143 key: Name of the additional property. 4144 value: A string attribute. 4145 """ 4146 4147 key = _messages.StringField(1) 4148 value = _messages.StringField(2) 4149 4150 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4151 4152 archiveUris = _messages.StringField(1, repeated=True) 4153 args = _messages.StringField(2, repeated=True) 4154 fileUris = _messages.StringField(3, repeated=True) 4155 loggingConfig = _messages.MessageField('LoggingConfig', 4) 4156 mainRFileUri = _messages.StringField(5) 4157 properties = _messages.MessageField('PropertiesValue', 6) 4158 4159 4160class SparkSqlJob(_messages.Message): 4161 r"""A Dataproc job for running Apache Spark SQL 4162 (http://spark.apache.org/sql/) queries. 4163 4164 Messages: 4165 PropertiesValue: Optional. A mapping of property names to values, used to 4166 configure Spark SQL's SparkConf. Properties that conflict with values 4167 set by the Dataproc API may be overwritten. 4168 ScriptVariablesValue: Optional. Mapping of query variable names to values 4169 (equivalent to the Spark SQL command: SET name="value";). 4170 4171 Fields: 4172 jarFileUris: Optional. HCFS URIs of jar files to be added to the Spark 4173 CLASSPATH. 4174 loggingConfig: Optional. The runtime log config for job execution. 4175 properties: Optional. A mapping of property names to values, used to 4176 configure Spark SQL's SparkConf. Properties that conflict with values 4177 set by the Dataproc API may be overwritten. 4178 queryFileUri: The HCFS URI of the script that contains SQL queries. 4179 queryList: A list of queries. 4180 scriptVariables: Optional. Mapping of query variable names to values 4181 (equivalent to the Spark SQL command: SET name="value";). 4182 """ 4183 4184 @encoding.MapUnrecognizedFields('additionalProperties') 4185 class PropertiesValue(_messages.Message): 4186 r"""Optional. A mapping of property names to values, used to configure 4187 Spark SQL's SparkConf. Properties that conflict with values set by the 4188 Dataproc API may be overwritten. 4189 4190 Messages: 4191 AdditionalProperty: An additional property for a PropertiesValue object. 4192 4193 Fields: 4194 additionalProperties: Additional properties of type PropertiesValue 4195 """ 4196 4197 class AdditionalProperty(_messages.Message): 4198 r"""An additional property for a PropertiesValue object. 4199 4200 Fields: 4201 key: Name of the additional property. 4202 value: A string attribute. 4203 """ 4204 4205 key = _messages.StringField(1) 4206 value = _messages.StringField(2) 4207 4208 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4209 4210 @encoding.MapUnrecognizedFields('additionalProperties') 4211 class ScriptVariablesValue(_messages.Message): 4212 r"""Optional. Mapping of query variable names to values (equivalent to the 4213 Spark SQL command: SET name="value";). 4214 4215 Messages: 4216 AdditionalProperty: An additional property for a ScriptVariablesValue 4217 object. 4218 4219 Fields: 4220 additionalProperties: Additional properties of type ScriptVariablesValue 4221 """ 4222 4223 class AdditionalProperty(_messages.Message): 4224 r"""An additional property for a ScriptVariablesValue object. 4225 4226 Fields: 4227 key: Name of the additional property. 4228 value: A string attribute. 4229 """ 4230 4231 key = _messages.StringField(1) 4232 value = _messages.StringField(2) 4233 4234 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4235 4236 jarFileUris = _messages.StringField(1, repeated=True) 4237 loggingConfig = _messages.MessageField('LoggingConfig', 2) 4238 properties = _messages.MessageField('PropertiesValue', 3) 4239 queryFileUri = _messages.StringField(4) 4240 queryList = _messages.MessageField('QueryList', 5) 4241 scriptVariables = _messages.MessageField('ScriptVariablesValue', 6) 4242 4243 4244class StandardQueryParameters(_messages.Message): 4245 r"""Query parameters accepted by all methods. 4246 4247 Enums: 4248 FXgafvValueValuesEnum: V1 error format. 4249 AltValueValuesEnum: Data format for response. 4250 4251 Fields: 4252 f__xgafv: V1 error format. 4253 access_token: OAuth access token. 4254 alt: Data format for response. 4255 callback: JSONP 4256 fields: Selector specifying which fields to include in a partial response. 4257 key: API key. Your API key identifies your project and provides you with 4258 API access, quota, and reports. Required unless you provide an OAuth 2.0 4259 token. 4260 oauth_token: OAuth 2.0 token for the current user. 4261 prettyPrint: Returns response with indentations and line breaks. 4262 quotaUser: Available to use for quota purposes for server-side 4263 applications. Can be any arbitrary string assigned to a user, but should 4264 not exceed 40 characters. 4265 trace: A tracing token of the form "token:<tokenid>" to include in api 4266 requests. 4267 uploadType: Legacy upload protocol for media (e.g. "media", "multipart"). 4268 upload_protocol: Upload protocol for media (e.g. "raw", "multipart"). 4269 """ 4270 4271 class AltValueValuesEnum(_messages.Enum): 4272 r"""Data format for response. 4273 4274 Values: 4275 json: Responses with Content-Type of application/json 4276 media: Media download with context-dependent Content-Type 4277 proto: Responses with Content-Type of application/x-protobuf 4278 """ 4279 json = 0 4280 media = 1 4281 proto = 2 4282 4283 class FXgafvValueValuesEnum(_messages.Enum): 4284 r"""V1 error format. 4285 4286 Values: 4287 _1: v1 error format 4288 _2: v2 error format 4289 """ 4290 _1 = 0 4291 _2 = 1 4292 4293 f__xgafv = _messages.EnumField('FXgafvValueValuesEnum', 1) 4294 access_token = _messages.StringField(2) 4295 alt = _messages.EnumField('AltValueValuesEnum', 3, default='json') 4296 callback = _messages.StringField(4) 4297 fields = _messages.StringField(5) 4298 key = _messages.StringField(6) 4299 oauth_token = _messages.StringField(7) 4300 prettyPrint = _messages.BooleanField(8, default=True) 4301 quotaUser = _messages.StringField(9) 4302 trace = _messages.StringField(10) 4303 uploadType = _messages.StringField(11) 4304 upload_protocol = _messages.StringField(12) 4305 4306 4307class StartClusterRequest(_messages.Message): 4308 r"""A request to start a cluster. 4309 4310 Fields: 4311 clusterUuid: Optional. Specifying the cluster_uuid means the RPC will fail 4312 (with error NOT_FOUND) if a cluster with the specified UUID does not 4313 exist. 4314 requestId: Optional. A unique id used to identify the request. If the 4315 server receives two StartClusterRequest (https://cloud.google.com/datapr 4316 oc/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.datapro 4317 c.v1beta2.StartClusterRequest)s with the same id, then the second 4318 request will be ignored and the first google.longrunning.Operation 4319 created and stored in the backend is returned.Recommendation: Set this 4320 value to a UUID 4321 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id 4322 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 4323 and hyphens (-). The maximum length is 40 characters. 4324 """ 4325 4326 clusterUuid = _messages.StringField(1) 4327 requestId = _messages.StringField(2) 4328 4329 4330class Status(_messages.Message): 4331 r"""The Status type defines a logical error model that is suitable for 4332 different programming environments, including REST APIs and RPC APIs. It is 4333 used by gRPC (https://github.com/grpc). Each Status message contains three 4334 pieces of data: error code, error message, and error details.You can find 4335 out more about this error model and how to work with it in the API Design 4336 Guide (https://cloud.google.com/apis/design/errors). 4337 4338 Messages: 4339 DetailsValueListEntry: A DetailsValueListEntry object. 4340 4341 Fields: 4342 code: The status code, which should be an enum value of google.rpc.Code. 4343 details: A list of messages that carry the error details. There is a 4344 common set of message types for APIs to use. 4345 message: A developer-facing error message, which should be in English. Any 4346 user-facing error message should be localized and sent in the 4347 google.rpc.Status.details field, or localized by the client. 4348 """ 4349 4350 @encoding.MapUnrecognizedFields('additionalProperties') 4351 class DetailsValueListEntry(_messages.Message): 4352 r"""A DetailsValueListEntry object. 4353 4354 Messages: 4355 AdditionalProperty: An additional property for a DetailsValueListEntry 4356 object. 4357 4358 Fields: 4359 additionalProperties: Properties of the object. Contains field @type 4360 with type URL. 4361 """ 4362 4363 class AdditionalProperty(_messages.Message): 4364 r"""An additional property for a DetailsValueListEntry object. 4365 4366 Fields: 4367 key: Name of the additional property. 4368 value: A extra_types.JsonValue attribute. 4369 """ 4370 4371 key = _messages.StringField(1) 4372 value = _messages.MessageField('extra_types.JsonValue', 2) 4373 4374 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4375 4376 code = _messages.IntegerField(1, variant=_messages.Variant.INT32) 4377 details = _messages.MessageField('DetailsValueListEntry', 2, repeated=True) 4378 message = _messages.StringField(3) 4379 4380 4381class StopClusterRequest(_messages.Message): 4382 r"""A request to stop a cluster. 4383 4384 Fields: 4385 clusterUuid: Optional. Specifying the cluster_uuid means the RPC will fail 4386 (with error NOT_FOUND) if a cluster with the specified UUID does not 4387 exist. 4388 requestId: Optional. A unique id used to identify the request. If the 4389 server receives two StopClusterRequest (https://cloud.google.com/datapro 4390 c/docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.dataproc 4391 .v1beta2.StopClusterRequest)s with the same id, then the second request 4392 will be ignored and the first google.longrunning.Operation created and 4393 stored in the backend is returned.Recommendation: Set this value to a 4394 UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The 4395 id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 4396 and hyphens (-). The maximum length is 40 characters. 4397 """ 4398 4399 clusterUuid = _messages.StringField(1) 4400 requestId = _messages.StringField(2) 4401 4402 4403class SubmitJobRequest(_messages.Message): 4404 r"""A request to submit a job. 4405 4406 Fields: 4407 job: Required. The job resource. 4408 requestId: Optional. A unique id used to identify the request. If the 4409 server receives two SubmitJobRequest (https://cloud.google.com/dataproc/ 4410 docs/reference/rpc/google.cloud.dataproc.v1beta2#google.cloud.dataproc.v 4411 1.SubmitJobRequest)s with the same id, then the second request will be 4412 ignored and the first Job created and stored in the backend is 4413 returned.It is recommended to always set this value to a UUID 4414 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id 4415 must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), 4416 and hyphens (-). The maximum length is 40 characters. 4417 """ 4418 4419 job = _messages.MessageField('Job', 1) 4420 requestId = _messages.StringField(2) 4421 4422 4423class TemplateParameter(_messages.Message): 4424 r"""A configurable parameter that replaces one or more fields in the 4425 template. Parameterizable fields: - Labels - File uris - Job properties - 4426 Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - 4427 Zone (in ClusterSelector) 4428 4429 Fields: 4430 description: Optional. Brief description of the parameter. Must not exceed 4431 1024 characters. 4432 fields: Required. Paths to all fields that the parameter replaces. A field 4433 is allowed to appear in at most one parameter's list of field paths.A 4434 field path is similar in syntax to a google.protobuf.FieldMask. For 4435 example, a field path that references the zone field of a workflow 4436 template's cluster selector would be specified as 4437 placement.clusterSelector.zone.Also, field paths can reference fields 4438 using the following syntax: Values in maps can be referenced by key: 4439 labels'key' placement.clusterSelector.clusterLabels'key' 4440 placement.managedCluster.labels'key' 4441 placement.clusterSelector.clusterLabels'key' jobs'step-id'.labels'key' 4442 Jobs in the jobs list can be referenced by step-id: jobs'step- 4443 id'.hadoopJob.mainJarFileUri jobs'step-id'.hiveJob.queryFileUri 4444 jobs'step-id'.pySparkJob.mainPythonFileUri jobs'step- 4445 id'.hadoopJob.jarFileUris0 jobs'step-id'.hadoopJob.archiveUris0 4446 jobs'step-id'.hadoopJob.fileUris0 jobs'step- 4447 id'.pySparkJob.pythonFileUris0 Items in repeated fields can be 4448 referenced by a zero-based index: jobs'step-id'.sparkJob.args0 Other 4449 examples: jobs'step-id'.hadoopJob.properties'key' jobs'step- 4450 id'.hadoopJob.args0 jobs'step-id'.hiveJob.scriptVariables'key' 4451 jobs'step-id'.hadoopJob.mainJarFileUri placement.clusterSelector.zoneIt 4452 may not be possible to parameterize maps and repeated fields in their 4453 entirety since only individual map values and individual items in 4454 repeated fields can be referenced. For example, the following field 4455 paths are invalid: placement.clusterSelector.clusterLabels jobs'step- 4456 id'.sparkJob.args 4457 name: Required. Parameter name. The parameter name is used as the key, and 4458 paired with the parameter value, which are passed to the template when 4459 the template is instantiated. The name must contain only capital letters 4460 (A-Z), numbers (0-9), and underscores (_), and must not start with a 4461 number. The maximum length is 40 characters. 4462 validation: Optional. Validation rules to be applied to this parameter's 4463 value. 4464 """ 4465 4466 description = _messages.StringField(1) 4467 fields = _messages.StringField(2, repeated=True) 4468 name = _messages.StringField(3) 4469 validation = _messages.MessageField('ParameterValidation', 4) 4470 4471 4472class TestIamPermissionsRequest(_messages.Message): 4473 r"""Request message for TestIamPermissions method. 4474 4475 Fields: 4476 permissions: The set of permissions to check for the resource. Permissions 4477 with wildcards (such as '*' or 'storage.*') are not allowed. For more 4478 information see IAM Overview 4479 (https://cloud.google.com/iam/docs/overview#permissions). 4480 """ 4481 4482 permissions = _messages.StringField(1, repeated=True) 4483 4484 4485class TestIamPermissionsResponse(_messages.Message): 4486 r"""Response message for TestIamPermissions method. 4487 4488 Fields: 4489 permissions: A subset of TestPermissionsRequest.permissions that the 4490 caller is allowed. 4491 """ 4492 4493 permissions = _messages.StringField(1, repeated=True) 4494 4495 4496class ValueValidation(_messages.Message): 4497 r"""Validation based on a list of allowed values. 4498 4499 Fields: 4500 values: Required. List of allowed values for the parameter. 4501 """ 4502 4503 values = _messages.StringField(1, repeated=True) 4504 4505 4506class WorkflowGraph(_messages.Message): 4507 r"""The workflow graph. 4508 4509 Fields: 4510 nodes: Output only. The workflow nodes. 4511 """ 4512 4513 nodes = _messages.MessageField('WorkflowNode', 1, repeated=True) 4514 4515 4516class WorkflowMetadata(_messages.Message): 4517 r"""A Dataproc workflow template resource. 4518 4519 Enums: 4520 StateValueValuesEnum: Output only. The workflow state. 4521 4522 Messages: 4523 ParametersValue: Map from parameter names to values that were used for 4524 those parameters. 4525 4526 Fields: 4527 clusterName: Output only. The name of the target cluster. 4528 clusterUuid: Output only. The UUID of target cluster. 4529 createCluster: Output only. The create cluster operation metadata. 4530 dagEndTime: Output only. DAG end time, which is only set for workflows 4531 with dag_timeout when the DAG ends. 4532 dagStartTime: Output only. DAG start time, which is only set for workflows 4533 with dag_timeout when the DAG begins. 4534 dagTimeout: Output only. The timeout duration for the DAG of jobs, 4535 expressed in seconds (see JSON representation of duration 4536 (https://developers.google.com/protocol-buffers/docs/proto3#json)). 4537 deleteCluster: Output only. The delete cluster operation metadata. 4538 endTime: Output only. Workflow end time. 4539 graph: Output only. The workflow graph. 4540 parameters: Map from parameter names to values that were used for those 4541 parameters. 4542 startTime: Output only. Workflow start time. 4543 state: Output only. The workflow state. 4544 template: Output only. The resource name of the workflow template as 4545 described in https://cloud.google.com/apis/design/resource_names. For 4546 projects.regions.workflowTemplates, the resource name of the template 4547 has the following format: 4548 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 4549 For projects.locations.workflowTemplates, the resource name of the 4550 template has the following format: projects/{project_id}/locations/{loca 4551 tion}/workflowTemplates/{template_id} 4552 version: Output only. The version of template at the time of workflow 4553 instantiation. 4554 """ 4555 4556 class StateValueValuesEnum(_messages.Enum): 4557 r"""Output only. The workflow state. 4558 4559 Values: 4560 UNKNOWN: Unused. 4561 PENDING: The operation has been created. 4562 RUNNING: The operation is running. 4563 DONE: The operation is done; either cancelled or completed. 4564 """ 4565 UNKNOWN = 0 4566 PENDING = 1 4567 RUNNING = 2 4568 DONE = 3 4569 4570 @encoding.MapUnrecognizedFields('additionalProperties') 4571 class ParametersValue(_messages.Message): 4572 r"""Map from parameter names to values that were used for those 4573 parameters. 4574 4575 Messages: 4576 AdditionalProperty: An additional property for a ParametersValue object. 4577 4578 Fields: 4579 additionalProperties: Additional properties of type ParametersValue 4580 """ 4581 4582 class AdditionalProperty(_messages.Message): 4583 r"""An additional property for a ParametersValue object. 4584 4585 Fields: 4586 key: Name of the additional property. 4587 value: A string attribute. 4588 """ 4589 4590 key = _messages.StringField(1) 4591 value = _messages.StringField(2) 4592 4593 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4594 4595 clusterName = _messages.StringField(1) 4596 clusterUuid = _messages.StringField(2) 4597 createCluster = _messages.MessageField('ClusterOperation', 3) 4598 dagEndTime = _messages.StringField(4) 4599 dagStartTime = _messages.StringField(5) 4600 dagTimeout = _messages.StringField(6) 4601 deleteCluster = _messages.MessageField('ClusterOperation', 7) 4602 endTime = _messages.StringField(8) 4603 graph = _messages.MessageField('WorkflowGraph', 9) 4604 parameters = _messages.MessageField('ParametersValue', 10) 4605 startTime = _messages.StringField(11) 4606 state = _messages.EnumField('StateValueValuesEnum', 12) 4607 template = _messages.StringField(13) 4608 version = _messages.IntegerField(14, variant=_messages.Variant.INT32) 4609 4610 4611class WorkflowNode(_messages.Message): 4612 r"""The workflow node. 4613 4614 Enums: 4615 StateValueValuesEnum: Output only. The node state. 4616 4617 Fields: 4618 error: Output only. The error detail. 4619 jobId: Output only. The job id; populated after the node enters RUNNING 4620 state. 4621 prerequisiteStepIds: Output only. Node's prerequisite nodes. 4622 state: Output only. The node state. 4623 stepId: Output only. The name of the node. 4624 """ 4625 4626 class StateValueValuesEnum(_messages.Enum): 4627 r"""Output only. The node state. 4628 4629 Values: 4630 NODE_STATUS_UNSPECIFIED: State is unspecified. 4631 BLOCKED: The node is awaiting prerequisite node to finish. 4632 RUNNABLE: The node is runnable but not running. 4633 RUNNING: The node is running. 4634 COMPLETED: The node completed successfully. 4635 FAILED: The node failed. A node can be marked FAILED because its 4636 ancestor or peer failed. 4637 """ 4638 NODE_STATUS_UNSPECIFIED = 0 4639 BLOCKED = 1 4640 RUNNABLE = 2 4641 RUNNING = 3 4642 COMPLETED = 4 4643 FAILED = 5 4644 4645 error = _messages.StringField(1) 4646 jobId = _messages.StringField(2) 4647 prerequisiteStepIds = _messages.StringField(3, repeated=True) 4648 state = _messages.EnumField('StateValueValuesEnum', 4) 4649 stepId = _messages.StringField(5) 4650 4651 4652class WorkflowTemplate(_messages.Message): 4653 r"""A Dataproc workflow template resource. 4654 4655 Messages: 4656 LabelsValue: Optional. The labels to associate with this template. These 4657 labels will be propagated to all jobs and clusters created by the 4658 workflow instance.Label keys must contain 1 to 63 characters, and must 4659 conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values 4660 may be empty, but, if present, must contain 1 to 63 characters, and must 4661 conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 4662 32 labels can be associated with a template. 4663 4664 Fields: 4665 createTime: Output only. The time template was created. 4666 dagTimeout: Optional. Timeout duration for the DAG of jobs, expressed in 4667 seconds (see JSON representation of duration 4668 (https://developers.google.com/protocol-buffers/docs/proto3#json)). The 4669 timeout duration must be from 10 minutes ("600s") to 24 hours 4670 ("86400s"). The timer begins when the first job is submitted. If the 4671 workflow is running at the end of the timeout period, any remaining jobs 4672 are cancelled, the workflow is ended, and if the workflow was running on 4673 a managed cluster, the cluster is deleted. 4674 id: Required. The template id.The id must contain only letters (a-z, A-Z), 4675 numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end 4676 with underscore or hyphen. Must consist of between 3 and 50 characters.. 4677 jobs: Required. The Directed Acyclic Graph of Jobs to submit. 4678 labels: Optional. The labels to associate with this template. These labels 4679 will be propagated to all jobs and clusters created by the workflow 4680 instance.Label keys must contain 1 to 63 characters, and must conform to 4681 RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be 4682 empty, but, if present, must contain 1 to 63 characters, and must 4683 conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 4684 32 labels can be associated with a template. 4685 name: Output only. The resource name of the workflow template, as 4686 described in https://cloud.google.com/apis/design/resource_names. For 4687 projects.regions.workflowTemplates, the resource name of the template 4688 has the following format: 4689 projects/{project_id}/regions/{region}/workflowTemplates/{template_id} 4690 For projects.locations.workflowTemplates, the resource name of the 4691 template has the following format: projects/{project_id}/locations/{loca 4692 tion}/workflowTemplates/{template_id} 4693 parameters: Optional. Template parameters whose values are substituted 4694 into the template. Values for parameters must be provided when the 4695 template is instantiated. 4696 placement: Required. WorkflowTemplate scheduling information. 4697 updateTime: Output only. The time template was last updated. 4698 version: Optional. Used to perform a consistent read-modify-write.This 4699 field should be left blank for a CreateWorkflowTemplate request. It is 4700 required for an UpdateWorkflowTemplate request, and must match the 4701 current server version. A typical update template flow would fetch the 4702 current template with a GetWorkflowTemplate request, which will return 4703 the current template with the version field filled in with the current 4704 server version. The user updates other fields in the template, then 4705 returns it as part of the UpdateWorkflowTemplate request. 4706 """ 4707 4708 @encoding.MapUnrecognizedFields('additionalProperties') 4709 class LabelsValue(_messages.Message): 4710 r"""Optional. The labels to associate with this template. These labels 4711 will be propagated to all jobs and clusters created by the workflow 4712 instance.Label keys must contain 1 to 63 characters, and must conform to 4713 RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, 4714 but, if present, must contain 1 to 63 characters, and must conform to RFC 4715 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be 4716 associated with a template. 4717 4718 Messages: 4719 AdditionalProperty: An additional property for a LabelsValue object. 4720 4721 Fields: 4722 additionalProperties: Additional properties of type LabelsValue 4723 """ 4724 4725 class AdditionalProperty(_messages.Message): 4726 r"""An additional property for a LabelsValue object. 4727 4728 Fields: 4729 key: Name of the additional property. 4730 value: A string attribute. 4731 """ 4732 4733 key = _messages.StringField(1) 4734 value = _messages.StringField(2) 4735 4736 additionalProperties = _messages.MessageField('AdditionalProperty', 1, repeated=True) 4737 4738 createTime = _messages.StringField(1) 4739 dagTimeout = _messages.StringField(2) 4740 id = _messages.StringField(3) 4741 jobs = _messages.MessageField('OrderedJob', 4, repeated=True) 4742 labels = _messages.MessageField('LabelsValue', 5) 4743 name = _messages.StringField(6) 4744 parameters = _messages.MessageField('TemplateParameter', 7, repeated=True) 4745 placement = _messages.MessageField('WorkflowTemplatePlacement', 8) 4746 updateTime = _messages.StringField(9) 4747 version = _messages.IntegerField(10, variant=_messages.Variant.INT32) 4748 4749 4750class WorkflowTemplatePlacement(_messages.Message): 4751 r"""Specifies workflow execution target.Either managed_cluster or 4752 cluster_selector is required. 4753 4754 Fields: 4755 clusterSelector: Optional. A selector that chooses target cluster for jobs 4756 based on metadata.The selector is evaluated at the time each job is 4757 submitted. 4758 managedCluster: Optional. A cluster that is managed by the workflow. 4759 """ 4760 4761 clusterSelector = _messages.MessageField('ClusterSelector', 1) 4762 managedCluster = _messages.MessageField('ManagedCluster', 2) 4763 4764 4765class YarnApplication(_messages.Message): 4766 r"""A YARN application created by a job. Application information is a subset 4767 of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.Beta 4768 Feature: This report is available for testing purposes only. It may be 4769 changed before final release. 4770 4771 Enums: 4772 StateValueValuesEnum: Output only. The application state. 4773 4774 Fields: 4775 name: Output only. The application name. 4776 progress: Output only. The numerical progress of the application, from 1 4777 to 100. 4778 state: Output only. The application state. 4779 trackingUrl: Output only. The HTTP URL of the ApplicationMaster, 4780 HistoryServer, or TimelineServer that provides application-specific 4781 information. The URL uses the internal hostname, and requires a proxy 4782 server for resolution and, possibly, access. 4783 """ 4784 4785 class StateValueValuesEnum(_messages.Enum): 4786 r"""Output only. The application state. 4787 4788 Values: 4789 STATE_UNSPECIFIED: Status is unspecified. 4790 NEW: Status is NEW. 4791 NEW_SAVING: Status is NEW_SAVING. 4792 SUBMITTED: Status is SUBMITTED. 4793 ACCEPTED: Status is ACCEPTED. 4794 RUNNING: Status is RUNNING. 4795 FINISHED: Status is FINISHED. 4796 FAILED: Status is FAILED. 4797 KILLED: Status is KILLED. 4798 """ 4799 STATE_UNSPECIFIED = 0 4800 NEW = 1 4801 NEW_SAVING = 2 4802 SUBMITTED = 3 4803 ACCEPTED = 4 4804 RUNNING = 5 4805 FINISHED = 6 4806 FAILED = 7 4807 KILLED = 8 4808 4809 name = _messages.StringField(1) 4810 progress = _messages.FloatField(2, variant=_messages.Variant.FLOAT) 4811 state = _messages.EnumField('StateValueValuesEnum', 3) 4812 trackingUrl = _messages.StringField(4) 4813 4814 4815class YarnDriverRunner(_messages.Message): 4816 r"""Schedule the driver on workers using YARN 4817 4818 Fields: 4819 memoryMb: Optional. The amount of memory in MB this driver is requesting 4820 from YARN 4821 vcores: Optional. The number of vCPUs this driver is requesting from YARN 4822 """ 4823 4824 memoryMb = _messages.IntegerField(1, variant=_messages.Variant.INT32) 4825 vcores = _messages.IntegerField(2, variant=_messages.Variant.INT32) 4826 4827 4828encoding.AddCustomJsonFieldMapping( 4829 StandardQueryParameters, 'f__xgafv', '$.xgafv') 4830encoding.AddCustomJsonEnumMapping( 4831 StandardQueryParameters.FXgafvValueValuesEnum, '_1', '1') 4832encoding.AddCustomJsonEnumMapping( 4833 StandardQueryParameters.FXgafvValueValuesEnum, '_2', '2') 4834