Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / dataproc_v1.projects.regions.workflowTemplates.html
blob: 6f76d7e46854c8f0379ac53d83910af619eb085e [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1.html">Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.workflowTemplates.html">workflowTemplates</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Creates new workflow template.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(name, version=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a workflow template. It does not cancel in-progress workflows.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, version=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.</p>
86<p class="toc_element">
87 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
89<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]90 <code><a href="#instantiate">instantiate(name, body=None, x__xgafv=None)</a></code></p>
91<p class="firstline">Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]93 <code><a href="#instantiateInline">instantiateInline(parent, body=None, requestId=None, x__xgafv=None)</a></code></p>
94<p class="firstline">Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95<p class="toc_element">
96 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
97<p class="firstline">Lists workflows that match the specified filter in the request.</p>
98<p class="toc_element">
99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
100<p class="firstline">Retrieves the next page of results.</p>
101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]105 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]106<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109<p class="firstline">Updates (replaces) workflow template. The updated template must contain version that matches the current server version.</p>
110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]113 <pre>Creates new workflow template.
114
115Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]116 parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
117For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region}
118For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)
119 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120 The object takes the form of:
121
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]122{ # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]123 "updateTime": "A String", # Output only. The time template was last updated.
124 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
125 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]126 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]127 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
128 "a_key": "A String",
129 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]131 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]132 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
133 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
134 "a_key": "A String",
135 },
136 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]137 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
138 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
139 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
140 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
141 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
142 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]144 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
145 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]146 "A String",
147 ],
148 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
149 # capacity-scheduler: capacity-scheduler.xml
150 # core: core-site.xml
151 # distcp: distcp-default.xml
152 # hdfs: hdfs-site.xml
153 # hive: hive-site.xml
154 # mapred: mapred-site.xml
155 # pig: pig.properties
156 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]157 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]158 "a_key": "A String",
159 },
160 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]161 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]162 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
163 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
165 "values": [ # Optional. Corresponds to the label values of reservation resource.
166 "A String",
167 ],
168 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
169 "consumeReservationType": "A String", # Optional. Type of reservation to consume
170 },
171 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
173 # projects/[project_id]/regions/global/default
174 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]175 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]176 "A String",
177 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]178 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
179 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
181 # projects/[project_id]/zones/[zone]
182 # us-central1-f
183 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
184 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
185 # projects/[project_id]/regions/us-east1/subnetworks/sub0
186 # sub0
187 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
188 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
189 # https://www.googleapis.com/auth/devstorage.read_write
190 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
191 # https://www.googleapis.com/auth/bigquery
192 # https://www.googleapis.com/auth/bigtable.admin.table
193 # https://www.googleapis.com/auth/bigtable.data
194 # https://www.googleapis.com/auth/devstorage.full_control
195 "A String",
196 ],
197 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
198 "a_key": "A String",
199 },
200 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]201 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
202 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
203 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
204 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
205 },
206 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
207 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
208 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]209 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
210 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
211 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]212 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
213 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]214 "A String",
215 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]216 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
217 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
218 # projects/[project_id]/global/images/[image-id]
219 # image-idImage family examples. Dataproc will use the most recent image from the family:
220 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
221 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
222 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
223 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]224 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]225 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]226 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
227 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]228 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]229 },
230 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]231 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]232 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
233 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
234 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
235 },
236 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
237 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
238 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
239 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
240 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
241 },
242 },
243 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
244 # ROLE=$(curl -H Metadata-Flavor:Google
245 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
246 # if [[ "${ROLE}" == 'Master' ]]; then
247 # ... master specific actions ...
248 # else
249 # ... worker specific actions ...
250 # fi
251 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]253 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
254 },
255 ],
256 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
257 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
258 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]259 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
260 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
261 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
263 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
264 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]265 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
266 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]267 "A String",
268 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]269 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
270 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
271 # projects/[project_id]/global/images/[image-id]
272 # image-idImage family examples. Dataproc will use the most recent image from the family:
273 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
274 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
275 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
276 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]277 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]278 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]279 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
280 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]281 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]282 },
283 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]284 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]285 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
286 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
287 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
288 },
289 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
290 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
291 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
292 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
293 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
294 },
295 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]296 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
297 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
298 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]299 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
300 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
301 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]302 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
303 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]304 "A String",
305 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]306 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
307 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
308 # projects/[project_id]/global/images/[image-id]
309 # image-idImage family examples. Dataproc will use the most recent image from the family:
310 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
311 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
312 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
313 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]314 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]315 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]316 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
317 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]318 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]319 },
320 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]321 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]322 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
323 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
324 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
325 },
326 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
327 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
328 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
329 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
330 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
331 },
332 },
333 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
334 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
335 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
336 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]337 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]338 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]339 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
341 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
342 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
343 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
344 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
345 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
346 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
347 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
348 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
349 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
350 },
351 },
352 },
353 },
354 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]355 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
356 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
357 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
358 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
360 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
361 # Values in maps can be referenced by key:
362 # labels'key'
363 # placement.clusterSelector.clusterLabels'key'
364 # placement.managedCluster.labels'key'
365 # placement.clusterSelector.clusterLabels'key'
366 # jobs'step-id'.labels'key'
367 # Jobs in the jobs list can be referenced by step-id:
368 # jobs'step-id'.hadoopJob.mainJarFileUri
369 # jobs'step-id'.hiveJob.queryFileUri
370 # jobs'step-id'.pySparkJob.mainPythonFileUri
371 # jobs'step-id'.hadoopJob.jarFileUris0
372 # jobs'step-id'.hadoopJob.archiveUris0
373 # jobs'step-id'.hadoopJob.fileUris0
374 # jobs'step-id'.pySparkJob.pythonFileUris0
375 # Items in repeated fields can be referenced by a zero-based index:
376 # jobs'step-id'.sparkJob.args0
377 # Other examples:
378 # jobs'step-id'.hadoopJob.properties'key'
379 # jobs'step-id'.hadoopJob.args0
380 # jobs'step-id'.hiveJob.scriptVariables'key'
381 # jobs'step-id'.hadoopJob.mainJarFileUri
382 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
383 # placement.clusterSelector.clusterLabels
384 # jobs'step-id'.sparkJob.args
385 "A String",
386 ],
387 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
388 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
389 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
390 "A String",
391 ],
392 },
393 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
394 "values": [ # Required. List of allowed values for the parameter.
395 "A String",
396 ],
397 },
398 },
399 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
400 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
401 },
402 ],
403 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
404 "a_key": "A String",
405 },
406 "createTime": "A String", # Output only. The time template was created.
407 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
408 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
409 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]410 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]411 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
412 "A String",
413 ],
414 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
415 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
416 "a_key": "A String",
417 },
418 },
419 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
420 "A String",
421 ],
422 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
423 "A String",
424 ],
425 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
426 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
427 "A String",
428 ],
429 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]430 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]431 "a_key": "A String",
432 },
433 },
434 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]435 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
436 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
437 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
438 "a_key": "A String",
439 },
440 },
441 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
442 "A String",
443 ],
444 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
445 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
446 "A String",
447 ],
448 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
449 "A String",
450 ],
451 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
452 "a_key": "A String",
453 },
454 },
455 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]456 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
457 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
458 "a_key": "A String",
459 },
460 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
461 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
462 "a_key": "A String",
463 },
464 },
465 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
466 "A String",
467 ],
468 "queryList": { # A list of queries to run on a cluster. # A list of queries.
469 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
470 # "hiveJob": {
471 # "queryList": {
472 # "queries": [
473 # "query1",
474 # "query2",
475 # "query3;query4",
476 # ]
477 # }
478 # }
479 "A String",
480 ],
481 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]482 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]483 "a_key": "A String",
484 },
485 },
486 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
487 "A String",
488 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]489 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]490 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
491 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
492 "a_key": "A String",
493 },
494 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
495 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
496 "a_key": "A String",
497 },
498 },
499 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
500 "A String",
501 ],
502 "queryList": { # A list of queries to run on a cluster. # A list of queries.
503 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
504 # "hiveJob": {
505 # "queryList": {
506 # "queries": [
507 # "query1",
508 # "query2",
509 # "query3;query4",
510 # ]
511 # }
512 # }
513 "A String",
514 ],
515 },
516 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]517 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]518 "a_key": "A String",
519 },
520 },
521 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
522 "a_key": "A String",
523 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]524 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]525 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
526 "A String",
527 ],
528 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
529 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
530 "a_key": "A String",
531 },
532 },
533 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
534 "A String",
535 ],
536 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
537 "A String",
538 ],
539 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
540 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
541 "A String",
542 ],
543 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]544 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
545 "a_key": "A String",
546 },
547 },
548 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
549 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
550 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
551 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
552 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
553 "a_key": "A String",
554 },
555 },
556 "clientTags": [ # Optional. Presto client tags to attach to this query
557 "A String",
558 ],
559 "queryList": { # A list of queries to run on a cluster. # A list of queries.
560 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
561 # "hiveJob": {
562 # "queryList": {
563 # "queries": [
564 # "query1",
565 # "query2",
566 # "query3;query4",
567 # ]
568 # }
569 # }
570 "A String",
571 ],
572 },
573 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
574 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]575 "a_key": "A String",
576 },
577 },
578 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
579 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
580 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]581 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]582 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]583 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]584 "A String",
585 ],
586 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
587 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
588 "a_key": "A String",
589 },
590 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]591 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]592 "A String",
593 ],
594 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
595 "A String",
596 ],
597 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
598 "A String",
599 ],
600 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
601 "A String",
602 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]603 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]604 "a_key": "A String",
605 },
606 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]607 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]608 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
609 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
610 "a_key": "A String",
611 },
612 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
613 "A String",
614 ],
615 "queryList": { # A list of queries to run on a cluster. # A list of queries.
616 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
617 # "hiveJob": {
618 # "queryList": {
619 # "queries": [
620 # "query1",
621 # "query2",
622 # "query3;query4",
623 # ]
624 # }
625 # }
626 "A String",
627 ],
628 },
629 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]630 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]631 "a_key": "A String",
632 },
633 },
634 },
635 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]636 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]637}
638
639 x__xgafv: string, V1 error format.
640 Allowed values
641 1 - v1 error format
642 2 - v2 error format
643
644Returns:
645 An object of the form:
646
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]647 { # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]648 "updateTime": "A String", # Output only. The time template was last updated.
649 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
650 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]651 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]652 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
653 "a_key": "A String",
654 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]655 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]656 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]657 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
658 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
659 "a_key": "A String",
660 },
661 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]662 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
663 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
664 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
665 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
666 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
667 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]668 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]669 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
670 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]671 "A String",
672 ],
673 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
674 # capacity-scheduler: capacity-scheduler.xml
675 # core: core-site.xml
676 # distcp: distcp-default.xml
677 # hdfs: hdfs-site.xml
678 # hive: hive-site.xml
679 # mapred: mapred-site.xml
680 # pig: pig.properties
681 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]682 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]683 "a_key": "A String",
684 },
685 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]686 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]687 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
688 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]689 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
690 "values": [ # Optional. Corresponds to the label values of reservation resource.
691 "A String",
692 ],
693 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
694 "consumeReservationType": "A String", # Optional. Type of reservation to consume
695 },
696 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]697 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
698 # projects/[project_id]/regions/global/default
699 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]700 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]701 "A String",
702 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]703 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
704 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]705 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
706 # projects/[project_id]/zones/[zone]
707 # us-central1-f
708 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
709 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
710 # projects/[project_id]/regions/us-east1/subnetworks/sub0
711 # sub0
712 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
713 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
714 # https://www.googleapis.com/auth/devstorage.read_write
715 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
716 # https://www.googleapis.com/auth/bigquery
717 # https://www.googleapis.com/auth/bigtable.admin.table
718 # https://www.googleapis.com/auth/bigtable.data
719 # https://www.googleapis.com/auth/devstorage.full_control
720 "A String",
721 ],
722 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
723 "a_key": "A String",
724 },
725 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]726 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
727 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
728 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
729 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
730 },
731 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
732 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
733 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]734 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
735 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
736 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]737 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
738 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]739 "A String",
740 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]741 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
742 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
743 # projects/[project_id]/global/images/[image-id]
744 # image-idImage family examples. Dataproc will use the most recent image from the family:
745 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
746 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
747 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
748 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]749 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]750 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]751 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
752 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]753 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]754 },
755 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]756 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]757 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
758 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
759 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
760 },
761 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
762 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
763 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
764 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
765 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
766 },
767 },
768 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
769 # ROLE=$(curl -H Metadata-Flavor:Google
770 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
771 # if [[ "${ROLE}" == 'Master' ]]; then
772 # ... master specific actions ...
773 # else
774 # ... worker specific actions ...
775 # fi
776 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]777 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]778 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
779 },
780 ],
781 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
782 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
783 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]784 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
785 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
786 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]787 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
788 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
789 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]790 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
791 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]792 "A String",
793 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]794 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
795 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
796 # projects/[project_id]/global/images/[image-id]
797 # image-idImage family examples. Dataproc will use the most recent image from the family:
798 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
799 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
800 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
801 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]802 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]803 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]804 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
805 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]806 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]807 },
808 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]809 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]810 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
811 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
812 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
813 },
814 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
815 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
816 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
817 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
818 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
819 },
820 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]821 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
822 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
823 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]824 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
825 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
826 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]827 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
828 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]829 "A String",
830 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]831 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
832 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
833 # projects/[project_id]/global/images/[image-id]
834 # image-idImage family examples. Dataproc will use the most recent image from the family:
835 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
836 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
837 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
838 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]839 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]840 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]841 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
842 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]843 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]844 },
845 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]846 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]847 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
848 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
849 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
850 },
851 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
852 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
853 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
854 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
855 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
856 },
857 },
858 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
859 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
860 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
861 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]862 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]863 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]864 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]865 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
866 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
867 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
868 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
869 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
870 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
871 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
872 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
873 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
874 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
875 },
876 },
877 },
878 },
879 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]880 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
881 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
882 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
883 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]884 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
885 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
886 # Values in maps can be referenced by key:
887 # labels'key'
888 # placement.clusterSelector.clusterLabels'key'
889 # placement.managedCluster.labels'key'
890 # placement.clusterSelector.clusterLabels'key'
891 # jobs'step-id'.labels'key'
892 # Jobs in the jobs list can be referenced by step-id:
893 # jobs'step-id'.hadoopJob.mainJarFileUri
894 # jobs'step-id'.hiveJob.queryFileUri
895 # jobs'step-id'.pySparkJob.mainPythonFileUri
896 # jobs'step-id'.hadoopJob.jarFileUris0
897 # jobs'step-id'.hadoopJob.archiveUris0
898 # jobs'step-id'.hadoopJob.fileUris0
899 # jobs'step-id'.pySparkJob.pythonFileUris0
900 # Items in repeated fields can be referenced by a zero-based index:
901 # jobs'step-id'.sparkJob.args0
902 # Other examples:
903 # jobs'step-id'.hadoopJob.properties'key'
904 # jobs'step-id'.hadoopJob.args0
905 # jobs'step-id'.hiveJob.scriptVariables'key'
906 # jobs'step-id'.hadoopJob.mainJarFileUri
907 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
908 # placement.clusterSelector.clusterLabels
909 # jobs'step-id'.sparkJob.args
910 "A String",
911 ],
912 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
913 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
914 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
915 "A String",
916 ],
917 },
918 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
919 "values": [ # Required. List of allowed values for the parameter.
920 "A String",
921 ],
922 },
923 },
924 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
925 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
926 },
927 ],
928 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
929 "a_key": "A String",
930 },
931 "createTime": "A String", # Output only. The time template was created.
932 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
933 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
934 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]935 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
937 "A String",
938 ],
939 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
940 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
941 "a_key": "A String",
942 },
943 },
944 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
945 "A String",
946 ],
947 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
948 "A String",
949 ],
950 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
951 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
952 "A String",
953 ],
954 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]955 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]956 "a_key": "A String",
957 },
958 },
959 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]960 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
961 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
962 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
963 "a_key": "A String",
964 },
965 },
966 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
967 "A String",
968 ],
969 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
970 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
971 "A String",
972 ],
973 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
974 "A String",
975 ],
976 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
977 "a_key": "A String",
978 },
979 },
980 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]981 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
982 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
983 "a_key": "A String",
984 },
985 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
986 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
987 "a_key": "A String",
988 },
989 },
990 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
991 "A String",
992 ],
993 "queryList": { # A list of queries to run on a cluster. # A list of queries.
994 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
995 # "hiveJob": {
996 # "queryList": {
997 # "queries": [
998 # "query1",
999 # "query2",
1000 # "query3;query4",
1001 # ]
1002 # }
1003 # }
1004 "A String",
1005 ],
1006 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1007 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1008 "a_key": "A String",
1009 },
1010 },
1011 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
1012 "A String",
1013 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1014 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1015 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1016 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
1017 "a_key": "A String",
1018 },
1019 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1020 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1021 "a_key": "A String",
1022 },
1023 },
1024 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
1025 "A String",
1026 ],
1027 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1028 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1029 # "hiveJob": {
1030 # "queryList": {
1031 # "queries": [
1032 # "query1",
1033 # "query2",
1034 # "query3;query4",
1035 # ]
1036 # }
1037 # }
1038 "A String",
1039 ],
1040 },
1041 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1042 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1043 "a_key": "A String",
1044 },
1045 },
1046 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
1047 "a_key": "A String",
1048 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1049 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1050 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
1051 "A String",
1052 ],
1053 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1054 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1055 "a_key": "A String",
1056 },
1057 },
1058 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1059 "A String",
1060 ],
1061 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1062 "A String",
1063 ],
1064 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
1065 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
1066 "A String",
1067 ],
1068 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1069 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1070 "a_key": "A String",
1071 },
1072 },
1073 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
1074 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1075 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
1076 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1077 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1078 "a_key": "A String",
1079 },
1080 },
1081 "clientTags": [ # Optional. Presto client tags to attach to this query
1082 "A String",
1083 ],
1084 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1085 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1086 # "hiveJob": {
1087 # "queryList": {
1088 # "queries": [
1089 # "query1",
1090 # "query2",
1091 # "query3;query4",
1092 # ]
1093 # }
1094 # }
1095 "A String",
1096 ],
1097 },
1098 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
1099 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1100 "a_key": "A String",
1101 },
1102 },
1103 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
1104 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
1105 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1106 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1107 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1108 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1109 "A String",
1110 ],
1111 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1112 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1113 "a_key": "A String",
1114 },
1115 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1116 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1117 "A String",
1118 ],
1119 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1120 "A String",
1121 ],
1122 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1123 "A String",
1124 ],
1125 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1126 "A String",
1127 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1128 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1129 "a_key": "A String",
1130 },
1131 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1132 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1133 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1134 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
1135 "a_key": "A String",
1136 },
1137 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
1138 "A String",
1139 ],
1140 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1141 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1142 # "hiveJob": {
1143 # "queryList": {
1144 # "queries": [
1145 # "query1",
1146 # "query2",
1147 # "query3;query4",
1148 # ]
1149 # }
1150 # }
1151 "A String",
1152 ],
1153 },
1154 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1155 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1156 "a_key": "A String",
1157 },
1158 },
1159 },
1160 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1161 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1162 }</pre>
1163</div>
1164
1165<div class="method">
1166 <code class="details" id="delete">delete(name, version=None, x__xgafv=None)</code>
1167 <pre>Deletes a workflow template. It does not cancel in-progress workflows.
1168
1169Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1170 name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
1171For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
1172For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1173 version: integer, Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.
1174 x__xgafv: string, V1 error format.
1175 Allowed values
1176 1 - v1 error format
1177 2 - v2 error format
1178
1179Returns:
1180 An object of the form:
1181
1182 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:
1183 # service Foo {
1184 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1185 # }
1186 # The JSON representation for Empty is empty JSON object {}.
1187 }</pre>
1188</div>
1189
1190<div class="method">
1191 <code class="details" id="get">get(name, version=None, x__xgafv=None)</code>
1192 <pre>Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.
1193
1194Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1195 name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
1196For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
1197For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)
1198 version: integer, Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1199 x__xgafv: string, V1 error format.
1200 Allowed values
1201 1 - v1 error format
1202 2 - v2 error format
1203
1204Returns:
1205 An object of the form:
1206
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1207 { # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1208 "updateTime": "A String", # Output only. The time template was last updated.
1209 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
1210 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1211 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1212 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
1213 "a_key": "A String",
1214 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1215 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1216 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1217 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
1218 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
1219 "a_key": "A String",
1220 },
1221 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1222 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
1223 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1224 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
1225 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1226 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1227 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1228 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1229 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
1230 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1231 "A String",
1232 ],
1233 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
1234 # capacity-scheduler: capacity-scheduler.xml
1235 # core: core-site.xml
1236 # distcp: distcp-default.xml
1237 # hdfs: hdfs-site.xml
1238 # hive: hive-site.xml
1239 # mapred: mapred-site.xml
1240 # pig: pig.properties
1241 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1242 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1243 "a_key": "A String",
1244 },
1245 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1246 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1247 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
1248 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1249 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
1250 "values": [ # Optional. Corresponds to the label values of reservation resource.
1251 "A String",
1252 ],
1253 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
1254 "consumeReservationType": "A String", # Optional. Type of reservation to consume
1255 },
1256 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1257 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
1258 # projects/[project_id]/regions/global/default
1259 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1260 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1261 "A String",
1262 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1263 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
1264 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1265 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
1266 # projects/[project_id]/zones/[zone]
1267 # us-central1-f
1268 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
1269 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
1270 # projects/[project_id]/regions/us-east1/subnetworks/sub0
1271 # sub0
1272 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
1273 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
1274 # https://www.googleapis.com/auth/devstorage.read_write
1275 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
1276 # https://www.googleapis.com/auth/bigquery
1277 # https://www.googleapis.com/auth/bigtable.admin.table
1278 # https://www.googleapis.com/auth/bigtable.data
1279 # https://www.googleapis.com/auth/devstorage.full_control
1280 "A String",
1281 ],
1282 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
1283 "a_key": "A String",
1284 },
1285 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1286 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
1287 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
1288 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
1289 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
1290 },
1291 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
1292 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1293 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1294 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1295 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1296 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1297 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1298 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1299 "A String",
1300 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1301 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1302 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1303 # projects/[project_id]/global/images/[image-id]
1304 # image-idImage family examples. Dataproc will use the most recent image from the family:
1305 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1306 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1307 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1308 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1309 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1310 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1311 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1312 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1313 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1314 },
1315 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1316 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1317 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1318 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1319 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1320 },
1321 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1322 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1323 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
1324 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1325 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1326 },
1327 },
1328 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
1329 # ROLE=$(curl -H Metadata-Flavor:Google
1330 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
1331 # if [[ "${ROLE}" == 'Master' ]]; then
1332 # ... master specific actions ...
1333 # else
1334 # ... worker specific actions ...
1335 # fi
1336 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1337 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1338 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
1339 },
1340 ],
1341 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1342 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1343 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1344 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
1345 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1346 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1347 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1348 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1349 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1350 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1351 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1352 "A String",
1353 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1354 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1355 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1356 # projects/[project_id]/global/images/[image-id]
1357 # image-idImage family examples. Dataproc will use the most recent image from the family:
1358 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1359 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1360 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1361 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1362 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1363 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1364 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1365 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1366 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1367 },
1368 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1369 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1370 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1371 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1372 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1373 },
1374 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1375 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1376 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
1377 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1378 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1379 },
1380 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1381 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
1382 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1383 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1384 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1385 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1386 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1387 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1388 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1389 "A String",
1390 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1391 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1392 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1393 # projects/[project_id]/global/images/[image-id]
1394 # image-idImage family examples. Dataproc will use the most recent image from the family:
1395 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1396 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1397 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1398 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1399 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1400 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1401 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1402 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1403 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1404 },
1405 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1406 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1407 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1408 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1409 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1410 },
1411 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1412 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1413 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
1414 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1415 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1416 },
1417 },
1418 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
1419 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
1420 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
1421 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1422 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1423 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1424 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1425 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1426 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
1427 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1428 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
1429 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
1430 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1431 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1432 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
1433 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1434 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
1435 },
1436 },
1437 },
1438 },
1439 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1440 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
1441 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
1442 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
1443 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1444 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
1445 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
1446 # Values in maps can be referenced by key:
1447 # labels'key'
1448 # placement.clusterSelector.clusterLabels'key'
1449 # placement.managedCluster.labels'key'
1450 # placement.clusterSelector.clusterLabels'key'
1451 # jobs'step-id'.labels'key'
1452 # Jobs in the jobs list can be referenced by step-id:
1453 # jobs'step-id'.hadoopJob.mainJarFileUri
1454 # jobs'step-id'.hiveJob.queryFileUri
1455 # jobs'step-id'.pySparkJob.mainPythonFileUri
1456 # jobs'step-id'.hadoopJob.jarFileUris0
1457 # jobs'step-id'.hadoopJob.archiveUris0
1458 # jobs'step-id'.hadoopJob.fileUris0
1459 # jobs'step-id'.pySparkJob.pythonFileUris0
1460 # Items in repeated fields can be referenced by a zero-based index:
1461 # jobs'step-id'.sparkJob.args0
1462 # Other examples:
1463 # jobs'step-id'.hadoopJob.properties'key'
1464 # jobs'step-id'.hadoopJob.args0
1465 # jobs'step-id'.hiveJob.scriptVariables'key'
1466 # jobs'step-id'.hadoopJob.mainJarFileUri
1467 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
1468 # placement.clusterSelector.clusterLabels
1469 # jobs'step-id'.sparkJob.args
1470 "A String",
1471 ],
1472 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
1473 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
1474 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
1475 "A String",
1476 ],
1477 },
1478 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
1479 "values": [ # Required. List of allowed values for the parameter.
1480 "A String",
1481 ],
1482 },
1483 },
1484 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
1485 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
1486 },
1487 ],
1488 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
1489 "a_key": "A String",
1490 },
1491 "createTime": "A String", # Output only. The time template was created.
1492 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
1493 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
1494 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1495 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1496 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
1497 "A String",
1498 ],
1499 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1500 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1501 "a_key": "A String",
1502 },
1503 },
1504 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
1505 "A String",
1506 ],
1507 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
1508 "A String",
1509 ],
1510 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
1511 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
1512 "A String",
1513 ],
1514 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1515 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1516 "a_key": "A String",
1517 },
1518 },
1519 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1520 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
1521 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1522 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1523 "a_key": "A String",
1524 },
1525 },
1526 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
1527 "A String",
1528 ],
1529 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
1530 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
1531 "A String",
1532 ],
1533 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
1534 "A String",
1535 ],
1536 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1537 "a_key": "A String",
1538 },
1539 },
1540 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1541 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1542 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
1543 "a_key": "A String",
1544 },
1545 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1546 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1547 "a_key": "A String",
1548 },
1549 },
1550 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
1551 "A String",
1552 ],
1553 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1554 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1555 # "hiveJob": {
1556 # "queryList": {
1557 # "queries": [
1558 # "query1",
1559 # "query2",
1560 # "query3;query4",
1561 # ]
1562 # }
1563 # }
1564 "A String",
1565 ],
1566 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1567 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1568 "a_key": "A String",
1569 },
1570 },
1571 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
1572 "A String",
1573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1574 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1575 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
1576 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
1577 "a_key": "A String",
1578 },
1579 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1580 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1581 "a_key": "A String",
1582 },
1583 },
1584 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
1585 "A String",
1586 ],
1587 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1588 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1589 # "hiveJob": {
1590 # "queryList": {
1591 # "queries": [
1592 # "query1",
1593 # "query2",
1594 # "query3;query4",
1595 # ]
1596 # }
1597 # }
1598 "A String",
1599 ],
1600 },
1601 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1602 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1603 "a_key": "A String",
1604 },
1605 },
1606 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
1607 "a_key": "A String",
1608 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1609 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1610 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
1611 "A String",
1612 ],
1613 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1614 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1615 "a_key": "A String",
1616 },
1617 },
1618 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
1619 "A String",
1620 ],
1621 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
1622 "A String",
1623 ],
1624 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
1625 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
1626 "A String",
1627 ],
1628 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1629 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
1630 "a_key": "A String",
1631 },
1632 },
1633 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
1634 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
1635 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
1636 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1637 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1638 "a_key": "A String",
1639 },
1640 },
1641 "clientTags": [ # Optional. Presto client tags to attach to this query
1642 "A String",
1643 ],
1644 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1645 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1646 # "hiveJob": {
1647 # "queryList": {
1648 # "queries": [
1649 # "query1",
1650 # "query2",
1651 # "query3;query4",
1652 # ]
1653 # }
1654 # }
1655 "A String",
1656 ],
1657 },
1658 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
1659 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1660 "a_key": "A String",
1661 },
1662 },
1663 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
1664 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
1665 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1666 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1667 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1668 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1669 "A String",
1670 ],
1671 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
1672 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
1673 "a_key": "A String",
1674 },
1675 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1676 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1677 "A String",
1678 ],
1679 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
1680 "A String",
1681 ],
1682 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
1683 "A String",
1684 ],
1685 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
1686 "A String",
1687 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1688 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1689 "a_key": "A String",
1690 },
1691 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1692 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1693 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
1694 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
1695 "a_key": "A String",
1696 },
1697 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
1698 "A String",
1699 ],
1700 "queryList": { # A list of queries to run on a cluster. # A list of queries.
1701 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
1702 # "hiveJob": {
1703 # "queryList": {
1704 # "queries": [
1705 # "query1",
1706 # "query2",
1707 # "query3;query4",
1708 # ]
1709 # }
1710 # }
1711 "A String",
1712 ],
1713 },
1714 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1715 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1716 "a_key": "A String",
1717 },
1718 },
1719 },
1720 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1721 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1722 }</pre>
1723</div>
1724
1725<div class="method">
1726 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
1727 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
1728
1729Args:
1730 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
1731 body: object, The request body.
1732 The object takes the form of:
1733
1734{ # Request message for GetIamPolicy method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1735 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy. This field is only used by Cloud IAM.
1736 "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
1737 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1738 }
1739
1740 x__xgafv: string, V1 error format.
1741 Allowed values
1742 1 - v1 error format
1743 2 - v2 error format
1744
1745Returns:
1746 An object of the form:
1747
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1748 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1749 # {
1750 # "bindings": [
1751 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1752 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1753 # "members": [
1754 # "user:mike@example.com",
1755 # "group:admins@example.com",
1756 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1757 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1758 # ]
1759 # },
1760 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1761 # "role": "roles/resourcemanager.organizationViewer",
1762 # "members": ["user:eve@example.com"],
1763 # "condition": {
1764 # "title": "expirable access",
1765 # "description": "Does not grant access after Sep 2020",
1766 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1767 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1768 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1769 # ],
1770 # "etag": "BwWWja0YfJA=",
1771 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1772 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1773 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1774 # bindings:
1775 # - members:
1776 # - user:mike@example.com
1777 # - group:admins@example.com
1778 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1779 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1780 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1781 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1782 # - user:eve@example.com
1783 # role: roles/resourcemanager.organizationViewer
1784 # condition:
1785 # title: expirable access
1786 # description: Does not grant access after Sep 2020
1787 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1788 # - etag: BwWWja0YfJA=
1789 # - version: 3
1790 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
1791 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1792 { # Associates members with a role.
1793 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1794 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1795 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1796 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1797 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1798 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1799 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1800 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
1801 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
1802 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1803 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1804 "A String",
1805 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1806 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1807 # title: "Summary size limit"
1808 # description: "Determines if a summary is less than 100 chars"
1809 # expression: "document.summary.size() &lt; 100"
1810 # Example (Equality):
1811 # title: "Requestor is owner"
1812 # description: "Determines if requestor is the document owner"
1813 # expression: "document.owner == request.auth.claims.email"
1814 # Example (Logic):
1815 # title: "Public documents"
1816 # description: "Determine whether the document should be publicly visible"
1817 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1818 # Example (Data Manipulation):
1819 # title: "Notification string"
1820 # description: "Create a notification string with a timestamp."
1821 # expression: "'New message received at ' + string(document.create_time)"
1822 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1823 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1824 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
1825 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1826 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1827 },
1828 },
1829 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1830 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
1831 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
1832 # Getting a policy that includes a conditional role binding
1833 # Adding a conditional role binding to a policy
1834 # Changing a conditional role binding in a policy
1835 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1836 }</pre>
1837</div>
1838
1839<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1840 <code class="details" id="instantiate">instantiate(name, body=None, x__xgafv=None)</code>
1841 <pre>Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1842
1843Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1844 name: string, Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
1845For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
1846For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)
1847 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1848 The object takes the form of:
1849
1850{ # A request to instantiate a workflow template.
1851 "version": 42, # Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.
1852 "requestId": "A String", # Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1853 "parameters": { # Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.
1854 "a_key": "A String",
1855 },
1856 }
1857
1858 x__xgafv: string, V1 error format.
1859 Allowed values
1860 1 - v1 error format
1861 2 - v2 error format
1862
1863Returns:
1864 An object of the form:
1865
1866 { # This resource represents a long-running operation that is the result of a network API call.
1867 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
1868 "a_key": "", # Properties of the object. Contains field @type with type URL.
1869 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1870 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
1871 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
1872 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1873 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1874 {
1875 "a_key": "", # Properties of the object. Contains field @type with type URL.
1876 },
1877 ],
1878 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1879 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
1880 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
1881 "a_key": "", # Properties of the object. Contains field @type with type URL.
1882 },
1883 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1884 }</pre>
1885</div>
1886
1887<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1888 <code class="details" id="instantiateInline">instantiateInline(parent, body=None, requestId=None, x__xgafv=None)</code>
1889 <pre>Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1890
1891Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1892 parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
1893For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region}
1894For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)
1895 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1896 The object takes the form of:
1897
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1898{ # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1899 "updateTime": "A String", # Output only. The time template was last updated.
1900 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
1901 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1902 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1903 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
1904 "a_key": "A String",
1905 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1906 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1907 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1908 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
1909 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
1910 "a_key": "A String",
1911 },
1912 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1913 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
1914 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1915 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
1916 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1917 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1918 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1919 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1920 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
1921 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1922 "A String",
1923 ],
1924 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
1925 # capacity-scheduler: capacity-scheduler.xml
1926 # core: core-site.xml
1927 # distcp: distcp-default.xml
1928 # hdfs: hdfs-site.xml
1929 # hive: hive-site.xml
1930 # mapred: mapred-site.xml
1931 # pig: pig.properties
1932 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1933 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1934 "a_key": "A String",
1935 },
1936 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1937 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1938 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
1939 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1940 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
1941 "values": [ # Optional. Corresponds to the label values of reservation resource.
1942 "A String",
1943 ],
1944 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
1945 "consumeReservationType": "A String", # Optional. Type of reservation to consume
1946 },
1947 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1948 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
1949 # projects/[project_id]/regions/global/default
1950 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1951 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1952 "A String",
1953 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1954 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
1955 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1956 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
1957 # projects/[project_id]/zones/[zone]
1958 # us-central1-f
1959 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
1960 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
1961 # projects/[project_id]/regions/us-east1/subnetworks/sub0
1962 # sub0
1963 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
1964 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
1965 # https://www.googleapis.com/auth/devstorage.read_write
1966 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
1967 # https://www.googleapis.com/auth/bigquery
1968 # https://www.googleapis.com/auth/bigtable.admin.table
1969 # https://www.googleapis.com/auth/bigtable.data
1970 # https://www.googleapis.com/auth/devstorage.full_control
1971 "A String",
1972 ],
1973 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
1974 "a_key": "A String",
1975 },
1976 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1977 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
1978 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
1979 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
1980 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
1981 },
1982 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
1983 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1984 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1985 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1986 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1987 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1988 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1989 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1990 "A String",
1991 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1992 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1993 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1994 # projects/[project_id]/global/images/[image-id]
1995 # image-idImage family examples. Dataproc will use the most recent image from the family:
1996 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1997 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1998 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1999 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2000 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2001 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2002 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2003 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2004 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2005 },
2006 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2007 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2008 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2009 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2010 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2011 },
2012 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2013 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2014 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2015 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2016 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2017 },
2018 },
2019 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
2020 # ROLE=$(curl -H Metadata-Flavor:Google
2021 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
2022 # if [[ "${ROLE}" == 'Master' ]]; then
2023 # ... master specific actions ...
2024 # else
2025 # ... worker specific actions ...
2026 # fi
2027 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2028 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2029 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
2030 },
2031 ],
2032 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
2033 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
2034 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2035 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
2036 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
2037 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2038 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
2039 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
2040 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2041 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
2042 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2043 "A String",
2044 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2045 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
2046 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
2047 # projects/[project_id]/global/images/[image-id]
2048 # image-idImage family examples. Dataproc will use the most recent image from the family:
2049 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
2050 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
2051 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
2052 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2053 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2054 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2055 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2056 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2057 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2058 },
2059 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2060 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2061 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2062 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2063 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2064 },
2065 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2066 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2067 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2068 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2069 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2070 },
2071 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2072 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
2073 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
2074 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2075 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
2076 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
2077 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2078 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
2079 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2080 "A String",
2081 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2082 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
2083 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
2084 # projects/[project_id]/global/images/[image-id]
2085 # image-idImage family examples. Dataproc will use the most recent image from the family:
2086 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
2087 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
2088 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
2089 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2090 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2091 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2092 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2093 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2094 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2095 },
2096 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2097 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2098 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2099 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2100 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2101 },
2102 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2103 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2104 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2105 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2106 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2107 },
2108 },
2109 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
2110 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
2111 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
2112 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2113 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2114 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2115 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2116 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
2117 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
2118 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
2119 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
2120 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
2121 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
2122 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
2123 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
2124 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
2125 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
2126 },
2127 },
2128 },
2129 },
2130 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2131 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
2132 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
2133 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
2134 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2135 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
2136 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
2137 # Values in maps can be referenced by key:
2138 # labels'key'
2139 # placement.clusterSelector.clusterLabels'key'
2140 # placement.managedCluster.labels'key'
2141 # placement.clusterSelector.clusterLabels'key'
2142 # jobs'step-id'.labels'key'
2143 # Jobs in the jobs list can be referenced by step-id:
2144 # jobs'step-id'.hadoopJob.mainJarFileUri
2145 # jobs'step-id'.hiveJob.queryFileUri
2146 # jobs'step-id'.pySparkJob.mainPythonFileUri
2147 # jobs'step-id'.hadoopJob.jarFileUris0
2148 # jobs'step-id'.hadoopJob.archiveUris0
2149 # jobs'step-id'.hadoopJob.fileUris0
2150 # jobs'step-id'.pySparkJob.pythonFileUris0
2151 # Items in repeated fields can be referenced by a zero-based index:
2152 # jobs'step-id'.sparkJob.args0
2153 # Other examples:
2154 # jobs'step-id'.hadoopJob.properties'key'
2155 # jobs'step-id'.hadoopJob.args0
2156 # jobs'step-id'.hiveJob.scriptVariables'key'
2157 # jobs'step-id'.hadoopJob.mainJarFileUri
2158 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
2159 # placement.clusterSelector.clusterLabels
2160 # jobs'step-id'.sparkJob.args
2161 "A String",
2162 ],
2163 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
2164 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
2165 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
2166 "A String",
2167 ],
2168 },
2169 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
2170 "values": [ # Required. List of allowed values for the parameter.
2171 "A String",
2172 ],
2173 },
2174 },
2175 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
2176 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
2177 },
2178 ],
2179 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
2180 "a_key": "A String",
2181 },
2182 "createTime": "A String", # Output only. The time template was created.
2183 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
2184 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
2185 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2186 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2187 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2188 "A String",
2189 ],
2190 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2191 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2192 "a_key": "A String",
2193 },
2194 },
2195 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
2196 "A String",
2197 ],
2198 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
2199 "A String",
2200 ],
2201 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
2202 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
2203 "A String",
2204 ],
2205 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2206 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2207 "a_key": "A String",
2208 },
2209 },
2210 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2211 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
2212 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2213 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2214 "a_key": "A String",
2215 },
2216 },
2217 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2218 "A String",
2219 ],
2220 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
2221 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
2222 "A String",
2223 ],
2224 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
2225 "A String",
2226 ],
2227 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2228 "a_key": "A String",
2229 },
2230 },
2231 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2232 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2233 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
2234 "a_key": "A String",
2235 },
2236 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2237 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2238 "a_key": "A String",
2239 },
2240 },
2241 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
2242 "A String",
2243 ],
2244 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2245 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2246 # "hiveJob": {
2247 # "queryList": {
2248 # "queries": [
2249 # "query1",
2250 # "query2",
2251 # "query3;query4",
2252 # ]
2253 # }
2254 # }
2255 "A String",
2256 ],
2257 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2258 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2259 "a_key": "A String",
2260 },
2261 },
2262 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
2263 "A String",
2264 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2265 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2266 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
2267 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
2268 "a_key": "A String",
2269 },
2270 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2271 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2272 "a_key": "A String",
2273 },
2274 },
2275 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
2276 "A String",
2277 ],
2278 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2279 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2280 # "hiveJob": {
2281 # "queryList": {
2282 # "queries": [
2283 # "query1",
2284 # "query2",
2285 # "query3;query4",
2286 # ]
2287 # }
2288 # }
2289 "A String",
2290 ],
2291 },
2292 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2293 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2294 "a_key": "A String",
2295 },
2296 },
2297 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
2298 "a_key": "A String",
2299 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2300 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2301 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2302 "A String",
2303 ],
2304 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2305 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2306 "a_key": "A String",
2307 },
2308 },
2309 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
2310 "A String",
2311 ],
2312 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
2313 "A String",
2314 ],
2315 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
2316 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
2317 "A String",
2318 ],
2319 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2320 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2321 "a_key": "A String",
2322 },
2323 },
2324 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
2325 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2326 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
2327 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2328 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2329 "a_key": "A String",
2330 },
2331 },
2332 "clientTags": [ # Optional. Presto client tags to attach to this query
2333 "A String",
2334 ],
2335 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2336 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2337 # "hiveJob": {
2338 # "queryList": {
2339 # "queries": [
2340 # "query1",
2341 # "query2",
2342 # "query3;query4",
2343 # ]
2344 # }
2345 # }
2346 "A String",
2347 ],
2348 },
2349 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
2350 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2351 "a_key": "A String",
2352 },
2353 },
2354 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
2355 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
2356 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2357 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2358 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2359 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2360 "A String",
2361 ],
2362 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2363 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2364 "a_key": "A String",
2365 },
2366 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2367 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2368 "A String",
2369 ],
2370 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
2371 "A String",
2372 ],
2373 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
2374 "A String",
2375 ],
2376 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
2377 "A String",
2378 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2379 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2380 "a_key": "A String",
2381 },
2382 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2383 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2384 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
2385 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
2386 "a_key": "A String",
2387 },
2388 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
2389 "A String",
2390 ],
2391 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2392 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2393 # "hiveJob": {
2394 # "queryList": {
2395 # "queries": [
2396 # "query1",
2397 # "query2",
2398 # "query3;query4",
2399 # ]
2400 # }
2401 # }
2402 "A String",
2403 ],
2404 },
2405 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2406 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2407 "a_key": "A String",
2408 },
2409 },
2410 },
2411 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2412 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2413}
2414
2415 requestId: string, Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
2416 x__xgafv: string, V1 error format.
2417 Allowed values
2418 1 - v1 error format
2419 2 - v2 error format
2420
2421Returns:
2422 An object of the form:
2423
2424 { # This resource represents a long-running operation that is the result of a network API call.
2425 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
2426 "a_key": "", # Properties of the object. Contains field @type with type URL.
2427 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2428 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
2429 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
2430 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
2431 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
2432 {
2433 "a_key": "", # Properties of the object. Contains field @type with type URL.
2434 },
2435 ],
2436 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2437 "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
2438 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
2439 "a_key": "", # Properties of the object. Contains field @type with type URL.
2440 },
2441 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2442 }</pre>
2443</div>
2444
2445<div class="method">
2446 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None)</code>
2447 <pre>Lists workflows that match the specified filter in the request.
2448
2449Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2450 parent: string, Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
2451For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region}
2452For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location} (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2453 pageToken: string, Optional. The page token, returned by a previous call, to request the next page of results.
2454 x__xgafv: string, V1 error format.
2455 Allowed values
2456 1 - v1 error format
2457 2 - v2 error format
2458 pageSize: integer, Optional. The maximum number of results to return in each response.
2459
2460Returns:
2461 An object of the form:
2462
2463 { # A response to a request to list workflow templates in a project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2464 "templates": [ # Output only. WorkflowTemplates list.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2465 { # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2466 "updateTime": "A String", # Output only. The time template was last updated.
2467 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
2468 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2469 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2470 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
2471 "a_key": "A String",
2472 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2473 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2474 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2475 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
2476 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
2477 "a_key": "A String",
2478 },
2479 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2480 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
2481 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
2482 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
2483 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
2484 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
2485 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2486 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2487 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
2488 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2489 "A String",
2490 ],
2491 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
2492 # capacity-scheduler: capacity-scheduler.xml
2493 # core: core-site.xml
2494 # distcp: distcp-default.xml
2495 # hdfs: hdfs-site.xml
2496 # hive: hive-site.xml
2497 # mapred: mapred-site.xml
2498 # pig: pig.properties
2499 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2500 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2501 "a_key": "A String",
2502 },
2503 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2504 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2505 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
2506 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2507 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
2508 "values": [ # Optional. Corresponds to the label values of reservation resource.
2509 "A String",
2510 ],
2511 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
2512 "consumeReservationType": "A String", # Optional. Type of reservation to consume
2513 },
2514 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2515 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
2516 # projects/[project_id]/regions/global/default
2517 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2518 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2519 "A String",
2520 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2521 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
2522 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2523 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
2524 # projects/[project_id]/zones/[zone]
2525 # us-central1-f
2526 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
2527 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
2528 # projects/[project_id]/regions/us-east1/subnetworks/sub0
2529 # sub0
2530 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
2531 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
2532 # https://www.googleapis.com/auth/devstorage.read_write
2533 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
2534 # https://www.googleapis.com/auth/bigquery
2535 # https://www.googleapis.com/auth/bigtable.admin.table
2536 # https://www.googleapis.com/auth/bigtable.data
2537 # https://www.googleapis.com/auth/devstorage.full_control
2538 "A String",
2539 ],
2540 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
2541 "a_key": "A String",
2542 },
2543 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2544 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
2545 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
2546 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
2547 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
2548 },
2549 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
2550 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
2551 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2552 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
2553 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
2554 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2555 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
2556 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2557 "A String",
2558 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2559 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
2560 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
2561 # projects/[project_id]/global/images/[image-id]
2562 # image-idImage family examples. Dataproc will use the most recent image from the family:
2563 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
2564 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
2565 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
2566 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2567 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2568 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2569 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2570 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2571 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2572 },
2573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2574 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2575 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2576 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2577 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2578 },
2579 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2580 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2581 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2582 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2583 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2584 },
2585 },
2586 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
2587 # ROLE=$(curl -H Metadata-Flavor:Google
2588 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
2589 # if [[ "${ROLE}" == 'Master' ]]; then
2590 # ... master specific actions ...
2591 # else
2592 # ... worker specific actions ...
2593 # fi
2594 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2595 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2596 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
2597 },
2598 ],
2599 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
2600 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
2601 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2602 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
2603 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
2604 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2605 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
2606 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
2607 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2608 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
2609 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2610 "A String",
2611 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2612 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
2613 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
2614 # projects/[project_id]/global/images/[image-id]
2615 # image-idImage family examples. Dataproc will use the most recent image from the family:
2616 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
2617 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
2618 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
2619 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2620 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2621 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2622 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2623 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2624 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2625 },
2626 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2627 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2628 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2629 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2630 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2631 },
2632 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2633 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2634 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2635 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2636 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2637 },
2638 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2639 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
2640 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
2641 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2642 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
2643 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
2644 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2645 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
2646 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2647 "A String",
2648 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2649 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
2650 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
2651 # projects/[project_id]/global/images/[image-id]
2652 # image-idImage family examples. Dataproc will use the most recent image from the family:
2653 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
2654 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
2655 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
2656 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2657 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2658 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2659 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
2660 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2661 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2662 },
2663 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2664 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2665 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
2666 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
2667 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
2668 },
2669 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
2670 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
2671 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
2672 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
2673 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
2674 },
2675 },
2676 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
2677 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
2678 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
2679 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2680 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2681 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2682 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2683 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
2684 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
2685 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
2686 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
2687 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
2688 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
2689 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
2690 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
2691 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
2692 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
2693 },
2694 },
2695 },
2696 },
2697 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2698 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
2699 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
2700 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
2701 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2702 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
2703 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
2704 # Values in maps can be referenced by key:
2705 # labels'key'
2706 # placement.clusterSelector.clusterLabels'key'
2707 # placement.managedCluster.labels'key'
2708 # placement.clusterSelector.clusterLabels'key'
2709 # jobs'step-id'.labels'key'
2710 # Jobs in the jobs list can be referenced by step-id:
2711 # jobs'step-id'.hadoopJob.mainJarFileUri
2712 # jobs'step-id'.hiveJob.queryFileUri
2713 # jobs'step-id'.pySparkJob.mainPythonFileUri
2714 # jobs'step-id'.hadoopJob.jarFileUris0
2715 # jobs'step-id'.hadoopJob.archiveUris0
2716 # jobs'step-id'.hadoopJob.fileUris0
2717 # jobs'step-id'.pySparkJob.pythonFileUris0
2718 # Items in repeated fields can be referenced by a zero-based index:
2719 # jobs'step-id'.sparkJob.args0
2720 # Other examples:
2721 # jobs'step-id'.hadoopJob.properties'key'
2722 # jobs'step-id'.hadoopJob.args0
2723 # jobs'step-id'.hiveJob.scriptVariables'key'
2724 # jobs'step-id'.hadoopJob.mainJarFileUri
2725 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
2726 # placement.clusterSelector.clusterLabels
2727 # jobs'step-id'.sparkJob.args
2728 "A String",
2729 ],
2730 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
2731 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
2732 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
2733 "A String",
2734 ],
2735 },
2736 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
2737 "values": [ # Required. List of allowed values for the parameter.
2738 "A String",
2739 ],
2740 },
2741 },
2742 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
2743 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
2744 },
2745 ],
2746 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
2747 "a_key": "A String",
2748 },
2749 "createTime": "A String", # Output only. The time template was created.
2750 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
2751 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
2752 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2753 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2754 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2755 "A String",
2756 ],
2757 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2758 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2759 "a_key": "A String",
2760 },
2761 },
2762 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
2763 "A String",
2764 ],
2765 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
2766 "A String",
2767 ],
2768 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
2769 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
2770 "A String",
2771 ],
2772 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2773 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2774 "a_key": "A String",
2775 },
2776 },
2777 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2778 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
2779 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2780 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2781 "a_key": "A String",
2782 },
2783 },
2784 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2785 "A String",
2786 ],
2787 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
2788 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
2789 "A String",
2790 ],
2791 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
2792 "A String",
2793 ],
2794 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2795 "a_key": "A String",
2796 },
2797 },
2798 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2799 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2800 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
2801 "a_key": "A String",
2802 },
2803 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2804 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2805 "a_key": "A String",
2806 },
2807 },
2808 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
2809 "A String",
2810 ],
2811 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2812 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2813 # "hiveJob": {
2814 # "queryList": {
2815 # "queries": [
2816 # "query1",
2817 # "query2",
2818 # "query3;query4",
2819 # ]
2820 # }
2821 # }
2822 "A String",
2823 ],
2824 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2825 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2826 "a_key": "A String",
2827 },
2828 },
2829 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
2830 "A String",
2831 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2832 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2833 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
2834 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
2835 "a_key": "A String",
2836 },
2837 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2838 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2839 "a_key": "A String",
2840 },
2841 },
2842 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
2843 "A String",
2844 ],
2845 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2846 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2847 # "hiveJob": {
2848 # "queryList": {
2849 # "queries": [
2850 # "query1",
2851 # "query2",
2852 # "query3;query4",
2853 # ]
2854 # }
2855 # }
2856 "A String",
2857 ],
2858 },
2859 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2860 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2861 "a_key": "A String",
2862 },
2863 },
2864 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
2865 "a_key": "A String",
2866 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2867 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2868 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
2869 "A String",
2870 ],
2871 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2872 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2873 "a_key": "A String",
2874 },
2875 },
2876 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
2877 "A String",
2878 ],
2879 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
2880 "A String",
2881 ],
2882 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
2883 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
2884 "A String",
2885 ],
2886 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2887 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
2888 "a_key": "A String",
2889 },
2890 },
2891 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
2892 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
2893 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
2894 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2895 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2896 "a_key": "A String",
2897 },
2898 },
2899 "clientTags": [ # Optional. Presto client tags to attach to this query
2900 "A String",
2901 ],
2902 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2903 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2904 # "hiveJob": {
2905 # "queryList": {
2906 # "queries": [
2907 # "query1",
2908 # "query2",
2909 # "query3;query4",
2910 # ]
2911 # }
2912 # }
2913 "A String",
2914 ],
2915 },
2916 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
2917 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2918 "a_key": "A String",
2919 },
2920 },
2921 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
2922 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
2923 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2924 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2925 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2926 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2927 "A String",
2928 ],
2929 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
2930 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
2931 "a_key": "A String",
2932 },
2933 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2934 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2935 "A String",
2936 ],
2937 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
2938 "A String",
2939 ],
2940 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
2941 "A String",
2942 ],
2943 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
2944 "A String",
2945 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2946 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2947 "a_key": "A String",
2948 },
2949 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2950 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2951 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
2952 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
2953 "a_key": "A String",
2954 },
2955 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
2956 "A String",
2957 ],
2958 "queryList": { # A list of queries to run on a cluster. # A list of queries.
2959 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
2960 # "hiveJob": {
2961 # "queryList": {
2962 # "queries": [
2963 # "query1",
2964 # "query2",
2965 # "query3;query4",
2966 # ]
2967 # }
2968 # }
2969 "A String",
2970 ],
2971 },
2972 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2973 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2974 "a_key": "A String",
2975 },
2976 },
2977 },
2978 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2979 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2980 },
2981 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]2982 "nextPageToken": "A String", # Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent &lt;code&gt;ListWorkflowTemplatesRequest&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]2983 }</pre>
2984</div>
2985
2986<div class="method">
2987 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
2988 <pre>Retrieves the next page of results.
2989
2990Args:
2991 previous_request: The request for the previous page. (required)
2992 previous_response: The response from the request for the previous page. (required)
2993
2994Returns:
2995 A request object that you can call 'execute()' on to request the next
2996 page. Returns None if there are no more items in the collection.
2997 </pre>
2998</div>
2999
3000<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3001 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
3002 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3003
3004Args:
3005 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3006 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3007 The object takes the form of:
3008
3009{ # Request message for SetIamPolicy method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3010 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3011 # {
3012 # "bindings": [
3013 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3014 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3015 # "members": [
3016 # "user:mike@example.com",
3017 # "group:admins@example.com",
3018 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3019 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3020 # ]
3021 # },
3022 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3023 # "role": "roles/resourcemanager.organizationViewer",
3024 # "members": ["user:eve@example.com"],
3025 # "condition": {
3026 # "title": "expirable access",
3027 # "description": "Does not grant access after Sep 2020",
3028 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
3029 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3030 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3031 # ],
3032 # "etag": "BwWWja0YfJA=",
3033 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3034 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3035 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3036 # bindings:
3037 # - members:
3038 # - user:mike@example.com
3039 # - group:admins@example.com
3040 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3041 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
3042 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3043 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3044 # - user:eve@example.com
3045 # role: roles/resourcemanager.organizationViewer
3046 # condition:
3047 # title: expirable access
3048 # description: Does not grant access after Sep 2020
3049 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
3050 # - etag: BwWWja0YfJA=
3051 # - version: 3
3052 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
3053 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3054 { # Associates members with a role.
3055 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
3056 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
3057 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
3058 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3059 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3060 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
3061 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3062 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
3063 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
3064 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3065 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
3066 "A String",
3067 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3068 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
3069 # title: "Summary size limit"
3070 # description: "Determines if a summary is less than 100 chars"
3071 # expression: "document.summary.size() &lt; 100"
3072 # Example (Equality):
3073 # title: "Requestor is owner"
3074 # description: "Determines if requestor is the document owner"
3075 # expression: "document.owner == request.auth.claims.email"
3076 # Example (Logic):
3077 # title: "Public documents"
3078 # description: "Determine whether the document should be publicly visible"
3079 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
3080 # Example (Data Manipulation):
3081 # title: "Notification string"
3082 # description: "Create a notification string with a timestamp."
3083 # expression: "'New message received at ' + string(document.create_time)"
3084 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
3085 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
3086 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
3087 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
3088 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3089 },
3090 },
3091 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3092 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
3093 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
3094 # Getting a policy that includes a conditional role binding
3095 # Adding a conditional role binding to a policy
3096 # Changing a conditional role binding in a policy
3097 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3098 },
3099 }
3100
3101 x__xgafv: string, V1 error format.
3102 Allowed values
3103 1 - v1 error format
3104 2 - v2 error format
3105
3106Returns:
3107 An object of the form:
3108
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3109 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3110 # {
3111 # "bindings": [
3112 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3113 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3114 # "members": [
3115 # "user:mike@example.com",
3116 # "group:admins@example.com",
3117 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3118 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3119 # ]
3120 # },
3121 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3122 # "role": "roles/resourcemanager.organizationViewer",
3123 # "members": ["user:eve@example.com"],
3124 # "condition": {
3125 # "title": "expirable access",
3126 # "description": "Does not grant access after Sep 2020",
3127 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
3128 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3129 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3130 # ],
3131 # "etag": "BwWWja0YfJA=",
3132 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3133 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3134 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3135 # bindings:
3136 # - members:
3137 # - user:mike@example.com
3138 # - group:admins@example.com
3139 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3140 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
3141 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3142 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3143 # - user:eve@example.com
3144 # role: roles/resourcemanager.organizationViewer
3145 # condition:
3146 # title: expirable access
3147 # description: Does not grant access after Sep 2020
3148 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
3149 # - etag: BwWWja0YfJA=
3150 # - version: 3
3151 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
3152 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3153 { # Associates members with a role.
3154 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
3155 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
3156 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
3157 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3158 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3159 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
3160 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3161 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
3162 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
3163 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3164 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
3165 "A String",
3166 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3167 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
3168 # title: "Summary size limit"
3169 # description: "Determines if a summary is less than 100 chars"
3170 # expression: "document.summary.size() &lt; 100"
3171 # Example (Equality):
3172 # title: "Requestor is owner"
3173 # description: "Determines if requestor is the document owner"
3174 # expression: "document.owner == request.auth.claims.email"
3175 # Example (Logic):
3176 # title: "Public documents"
3177 # description: "Determine whether the document should be publicly visible"
3178 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
3179 # Example (Data Manipulation):
3180 # title: "Notification string"
3181 # description: "Create a notification string with a timestamp."
3182 # expression: "'New message received at ' + string(document.create_time)"
3183 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
3184 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
3185 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
3186 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
3187 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3188 },
3189 },
3190 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3191 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
3192 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
3193 # Getting a policy that includes a conditional role binding
3194 # Adding a conditional role binding to a policy
3195 # Changing a conditional role binding in a policy
3196 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3197 }</pre>
3198</div>
3199
3200<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3201 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3202 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
3203
3204Args:
3205 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3206 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3207 The object takes the form of:
3208
3209{ # Request message for TestIamPermissions method.
3210 "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
3211 "A String",
3212 ],
3213 }
3214
3215 x__xgafv: string, V1 error format.
3216 Allowed values
3217 1 - v1 error format
3218 2 - v2 error format
3219
3220Returns:
3221 An object of the form:
3222
3223 { # Response message for TestIamPermissions method.
3224 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
3225 "A String",
3226 ],
3227 }</pre>
3228</div>
3229
3230<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3231 <code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3232 <pre>Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
3233
3234Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3235 name: string, Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
3236For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
3237For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id} (required)
3238 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3239 The object takes the form of:
3240
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3241{ # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3242 "updateTime": "A String", # Output only. The time template was last updated.
3243 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
3244 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3245 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3246 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
3247 "a_key": "A String",
3248 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3249 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3250 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3251 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
3252 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
3253 "a_key": "A String",
3254 },
3255 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3256 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
3257 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3258 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
3259 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3260 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3261 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3262 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3263 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
3264 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3265 "A String",
3266 ],
3267 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
3268 # capacity-scheduler: capacity-scheduler.xml
3269 # core: core-site.xml
3270 # distcp: distcp-default.xml
3271 # hdfs: hdfs-site.xml
3272 # hive: hive-site.xml
3273 # mapred: mapred-site.xml
3274 # pig: pig.properties
3275 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3276 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3277 "a_key": "A String",
3278 },
3279 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3280 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3281 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
3282 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3283 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
3284 "values": [ # Optional. Corresponds to the label values of reservation resource.
3285 "A String",
3286 ],
3287 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
3288 "consumeReservationType": "A String", # Optional. Type of reservation to consume
3289 },
3290 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3291 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
3292 # projects/[project_id]/regions/global/default
3293 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3294 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3295 "A String",
3296 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3297 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
3298 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3299 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
3300 # projects/[project_id]/zones/[zone]
3301 # us-central1-f
3302 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
3303 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
3304 # projects/[project_id]/regions/us-east1/subnetworks/sub0
3305 # sub0
3306 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
3307 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
3308 # https://www.googleapis.com/auth/devstorage.read_write
3309 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
3310 # https://www.googleapis.com/auth/bigquery
3311 # https://www.googleapis.com/auth/bigtable.admin.table
3312 # https://www.googleapis.com/auth/bigtable.data
3313 # https://www.googleapis.com/auth/devstorage.full_control
3314 "A String",
3315 ],
3316 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
3317 "a_key": "A String",
3318 },
3319 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3320 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
3321 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
3322 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
3323 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
3324 },
3325 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
3326 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3327 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3328 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3329 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3330 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3331 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3332 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3333 "A String",
3334 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3335 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3336 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3337 # projects/[project_id]/global/images/[image-id]
3338 # image-idImage family examples. Dataproc will use the most recent image from the family:
3339 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3340 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3341 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3342 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3343 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3344 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3345 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3346 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3347 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3348 },
3349 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3350 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3351 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3352 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3353 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3354 },
3355 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3356 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3357 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3358 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3359 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3360 },
3361 },
3362 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
3363 # ROLE=$(curl -H Metadata-Flavor:Google
3364 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
3365 # if [[ "${ROLE}" == 'Master' ]]; then
3366 # ... master specific actions ...
3367 # else
3368 # ... worker specific actions ...
3369 # fi
3370 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3371 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3372 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
3373 },
3374 ],
3375 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
3376 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
3377 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3378 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
3379 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3380 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3381 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3382 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3383 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3384 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3385 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3386 "A String",
3387 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3388 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3389 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3390 # projects/[project_id]/global/images/[image-id]
3391 # image-idImage family examples. Dataproc will use the most recent image from the family:
3392 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3393 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3394 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3395 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3396 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3397 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3398 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3399 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3400 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3401 },
3402 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3403 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3404 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3405 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3406 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3407 },
3408 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3409 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3410 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3411 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3412 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3413 },
3414 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3415 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
3416 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3417 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3418 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3419 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3420 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3421 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3422 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3423 "A String",
3424 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3425 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3426 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3427 # projects/[project_id]/global/images/[image-id]
3428 # image-idImage family examples. Dataproc will use the most recent image from the family:
3429 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3430 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3431 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3432 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3433 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3434 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3435 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3436 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3437 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3438 },
3439 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3440 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3441 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3442 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3443 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3444 },
3445 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3446 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3447 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3448 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3449 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3450 },
3451 },
3452 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
3453 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
3454 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
3455 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3456 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3457 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3458 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3459 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
3460 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
3461 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
3462 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
3463 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
3464 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
3465 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
3466 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
3467 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
3468 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
3469 },
3470 },
3471 },
3472 },
3473 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3474 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
3475 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
3476 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
3477 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3478 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
3479 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
3480 # Values in maps can be referenced by key:
3481 # labels'key'
3482 # placement.clusterSelector.clusterLabels'key'
3483 # placement.managedCluster.labels'key'
3484 # placement.clusterSelector.clusterLabels'key'
3485 # jobs'step-id'.labels'key'
3486 # Jobs in the jobs list can be referenced by step-id:
3487 # jobs'step-id'.hadoopJob.mainJarFileUri
3488 # jobs'step-id'.hiveJob.queryFileUri
3489 # jobs'step-id'.pySparkJob.mainPythonFileUri
3490 # jobs'step-id'.hadoopJob.jarFileUris0
3491 # jobs'step-id'.hadoopJob.archiveUris0
3492 # jobs'step-id'.hadoopJob.fileUris0
3493 # jobs'step-id'.pySparkJob.pythonFileUris0
3494 # Items in repeated fields can be referenced by a zero-based index:
3495 # jobs'step-id'.sparkJob.args0
3496 # Other examples:
3497 # jobs'step-id'.hadoopJob.properties'key'
3498 # jobs'step-id'.hadoopJob.args0
3499 # jobs'step-id'.hiveJob.scriptVariables'key'
3500 # jobs'step-id'.hadoopJob.mainJarFileUri
3501 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
3502 # placement.clusterSelector.clusterLabels
3503 # jobs'step-id'.sparkJob.args
3504 "A String",
3505 ],
3506 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
3507 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
3508 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
3509 "A String",
3510 ],
3511 },
3512 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
3513 "values": [ # Required. List of allowed values for the parameter.
3514 "A String",
3515 ],
3516 },
3517 },
3518 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
3519 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
3520 },
3521 ],
3522 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
3523 "a_key": "A String",
3524 },
3525 "createTime": "A String", # Output only. The time template was created.
3526 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
3527 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
3528 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3529 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3530 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
3531 "A String",
3532 ],
3533 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3534 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3535 "a_key": "A String",
3536 },
3537 },
3538 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
3539 "A String",
3540 ],
3541 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
3542 "A String",
3543 ],
3544 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
3545 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
3546 "A String",
3547 ],
3548 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3549 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3550 "a_key": "A String",
3551 },
3552 },
3553 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3554 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
3555 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3556 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3557 "a_key": "A String",
3558 },
3559 },
3560 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
3561 "A String",
3562 ],
3563 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
3564 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
3565 "A String",
3566 ],
3567 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
3568 "A String",
3569 ],
3570 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
3571 "a_key": "A String",
3572 },
3573 },
3574 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3575 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
3576 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
3577 "a_key": "A String",
3578 },
3579 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3580 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3581 "a_key": "A String",
3582 },
3583 },
3584 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
3585 "A String",
3586 ],
3587 "queryList": { # A list of queries to run on a cluster. # A list of queries.
3588 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
3589 # "hiveJob": {
3590 # "queryList": {
3591 # "queries": [
3592 # "query1",
3593 # "query2",
3594 # "query3;query4",
3595 # ]
3596 # }
3597 # }
3598 "A String",
3599 ],
3600 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3601 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3602 "a_key": "A String",
3603 },
3604 },
3605 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
3606 "A String",
3607 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3608 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3609 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
3610 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
3611 "a_key": "A String",
3612 },
3613 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3614 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3615 "a_key": "A String",
3616 },
3617 },
3618 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
3619 "A String",
3620 ],
3621 "queryList": { # A list of queries to run on a cluster. # A list of queries.
3622 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
3623 # "hiveJob": {
3624 # "queryList": {
3625 # "queries": [
3626 # "query1",
3627 # "query2",
3628 # "query3;query4",
3629 # ]
3630 # }
3631 # }
3632 "A String",
3633 ],
3634 },
3635 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3636 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3637 "a_key": "A String",
3638 },
3639 },
3640 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
3641 "a_key": "A String",
3642 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3643 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3644 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
3645 "A String",
3646 ],
3647 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3648 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3649 "a_key": "A String",
3650 },
3651 },
3652 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
3653 "A String",
3654 ],
3655 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
3656 "A String",
3657 ],
3658 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
3659 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
3660 "A String",
3661 ],
3662 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3663 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
3664 "a_key": "A String",
3665 },
3666 },
3667 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
3668 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
3669 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
3670 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3671 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3672 "a_key": "A String",
3673 },
3674 },
3675 "clientTags": [ # Optional. Presto client tags to attach to this query
3676 "A String",
3677 ],
3678 "queryList": { # A list of queries to run on a cluster. # A list of queries.
3679 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
3680 # "hiveJob": {
3681 # "queryList": {
3682 # "queries": [
3683 # "query1",
3684 # "query2",
3685 # "query3;query4",
3686 # ]
3687 # }
3688 # }
3689 "A String",
3690 ],
3691 },
3692 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
3693 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3694 "a_key": "A String",
3695 },
3696 },
3697 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
3698 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
3699 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3700 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3701 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3702 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3703 "A String",
3704 ],
3705 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
3706 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
3707 "a_key": "A String",
3708 },
3709 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3710 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3711 "A String",
3712 ],
3713 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
3714 "A String",
3715 ],
3716 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
3717 "A String",
3718 ],
3719 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
3720 "A String",
3721 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3722 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3723 "a_key": "A String",
3724 },
3725 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3726 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3727 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
3728 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
3729 "a_key": "A String",
3730 },
3731 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
3732 "A String",
3733 ],
3734 "queryList": { # A list of queries to run on a cluster. # A list of queries.
3735 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
3736 # "hiveJob": {
3737 # "queryList": {
3738 # "queries": [
3739 # "query1",
3740 # "query2",
3741 # "query3;query4",
3742 # ]
3743 # }
3744 # }
3745 "A String",
3746 ],
3747 },
3748 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3749 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3750 "a_key": "A String",
3751 },
3752 },
3753 },
3754 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3755 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3756}
3757
3758 x__xgafv: string, V1 error format.
3759 Allowed values
3760 1 - v1 error format
3761 2 - v2 error format
3762
3763Returns:
3764 An object of the form:
3765
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3766 { # A Dataproc workflow template resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3767 "updateTime": "A String", # Output only. The time template was last updated.
3768 "placement": { # Specifies workflow execution target.Either managed_cluster or cluster_selector is required. # Required. WorkflowTemplate scheduling information.
3769 "clusterSelector": { # A selector that chooses target cluster for jobs based on metadata. # Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3770 "zone": "A String", # Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3771 "clusterLabels": { # Required. The cluster labels. Cluster must have all labels to match.
3772 "a_key": "A String",
3773 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3774 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3775 "managedCluster": { # Cluster that is managed by the workflow. # A cluster that is managed by the workflow.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3776 "clusterName": "A String", # Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix.The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
3777 "labels": { # Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given cluster.
3778 "a_key": "A String",
3779 },
3780 "config": { # The cluster config. # Required. The cluster configuration.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3781 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.
3782 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3783 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
3784 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3785 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
3786 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3787 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3788 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
3789 "optionalComponents": [ # Optional. The set of components to activate on the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3790 "A String",
3791 ],
3792 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
3793 # capacity-scheduler: capacity-scheduler.xml
3794 # core: core-site.xml
3795 # distcp: distcp-default.xml
3796 # hdfs: hdfs-site.xml
3797 # hive: hive-site.xml
3798 # mapred: mapred-site.xml
3799 # pig: pig.properties
3800 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3801 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3802 "a_key": "A String",
3803 },
3804 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3805 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3806 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
3807 "internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3808 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
3809 "values": [ # Optional. Corresponds to the label values of reservation resource.
3810 "A String",
3811 ],
3812 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
3813 "consumeReservationType": "A String", # Optional. Type of reservation to consume
3814 },
3815 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3816 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
3817 # projects/[project_id]/regions/global/default
3818 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3819 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3820 "A String",
3821 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3822 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
3823 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3824 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
3825 # projects/[project_id]/zones/[zone]
3826 # us-central1-f
3827 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
3828 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
3829 # projects/[project_id]/regions/us-east1/subnetworks/sub0
3830 # sub0
3831 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
3832 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
3833 # https://www.googleapis.com/auth/devstorage.read_write
3834 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
3835 # https://www.googleapis.com/auth/bigquery
3836 # https://www.googleapis.com/auth/bigtable.admin.table
3837 # https://www.googleapis.com/auth/bigtable.data
3838 # https://www.googleapis.com/auth/devstorage.full_control
3839 "A String",
3840 ],
3841 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
3842 "a_key": "A String",
3843 },
3844 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3845 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
3846 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
3847 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
3848 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
3849 },
3850 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
3851 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3852 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3853 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3854 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3855 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3856 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3857 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3858 "A String",
3859 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3860 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3861 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3862 # projects/[project_id]/global/images/[image-id]
3863 # image-idImage family examples. Dataproc will use the most recent image from the family:
3864 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3865 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3866 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3867 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3868 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3869 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3870 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3871 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3872 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3873 },
3874 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3875 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3876 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3877 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3878 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3879 },
3880 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3881 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3882 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3883 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3884 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3885 },
3886 },
3887 "initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
3888 # ROLE=$(curl -H Metadata-Flavor:Google
3889 # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
3890 # if [[ "${ROLE}" == 'Master' ]]; then
3891 # ... master specific actions ...
3892 # else
3893 # ... worker specific actions ...
3894 # fi
3895 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3896 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3897 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
3898 },
3899 ],
3900 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
3901 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
3902 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3903 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
3904 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3905 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3906 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3907 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3908 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3909 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3910 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3911 "A String",
3912 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3913 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3914 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3915 # projects/[project_id]/global/images/[image-id]
3916 # image-idImage family examples. Dataproc will use the most recent image from the family:
3917 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3918 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3919 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3920 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3921 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3922 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3923 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3924 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3925 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3926 },
3927 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3928 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3929 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3930 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3931 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3932 },
3933 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3934 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3935 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3936 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3937 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3938 },
3939 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3940 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
3941 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
3942 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3943 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
3944 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
3945 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3946 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
3947 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3948 "A String",
3949 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3950 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
3951 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
3952 # projects/[project_id]/global/images/[image-id]
3953 # image-idImage family examples. Dataproc will use the most recent image from the family:
3954 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
3955 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
3956 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
3957 { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3958 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3959 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3960 # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
3961 # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3962 # nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3963 },
3964 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3965 "minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3966 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
3967 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
3968 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
3969 },
3970 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
3971 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
3972 "numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
3973 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
3974 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
3975 },
3976 },
3977 "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
3978 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
3979 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
3980 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3981 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3982 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3983 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]3984 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
3985 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
3986 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
3987 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
3988 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
3989 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
3990 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
3991 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
3992 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
3993 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
3994 },
3995 },
3996 },
3997 },
3998 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]3999 "name": "A String", # Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
4000 # For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id}
4001 # For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}
4002 "parameters": [ # Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4003 { # A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
4004 "fields": [ # Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths.A field path is similar in syntax to a google.protobuf.FieldMask. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as placement.clusterSelector.zone.Also, field paths can reference fields using the following syntax:
4005 # Values in maps can be referenced by key:
4006 # labels'key'
4007 # placement.clusterSelector.clusterLabels'key'
4008 # placement.managedCluster.labels'key'
4009 # placement.clusterSelector.clusterLabels'key'
4010 # jobs'step-id'.labels'key'
4011 # Jobs in the jobs list can be referenced by step-id:
4012 # jobs'step-id'.hadoopJob.mainJarFileUri
4013 # jobs'step-id'.hiveJob.queryFileUri
4014 # jobs'step-id'.pySparkJob.mainPythonFileUri
4015 # jobs'step-id'.hadoopJob.jarFileUris0
4016 # jobs'step-id'.hadoopJob.archiveUris0
4017 # jobs'step-id'.hadoopJob.fileUris0
4018 # jobs'step-id'.pySparkJob.pythonFileUris0
4019 # Items in repeated fields can be referenced by a zero-based index:
4020 # jobs'step-id'.sparkJob.args0
4021 # Other examples:
4022 # jobs'step-id'.hadoopJob.properties'key'
4023 # jobs'step-id'.hadoopJob.args0
4024 # jobs'step-id'.hiveJob.scriptVariables'key'
4025 # jobs'step-id'.hadoopJob.mainJarFileUri
4026 # placement.clusterSelector.zoneIt may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid:
4027 # placement.clusterSelector.clusterLabels
4028 # jobs'step-id'.sparkJob.args
4029 "A String",
4030 ],
4031 "validation": { # Configuration for parameter validation. # Optional. Validation rules to be applied to this parameter's value.
4032 "regex": { # Validation based on regular expressions. # Validation based on regular expressions.
4033 "regexes": [ # Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
4034 "A String",
4035 ],
4036 },
4037 "values": { # Validation based on a list of allowed values. # Validation based on a list of allowed values.
4038 "values": [ # Required. List of allowed values for the parameter.
4039 "A String",
4040 ],
4041 },
4042 },
4043 "name": "A String", # Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
4044 "description": "A String", # Optional. Brief description of the parameter. Must not exceed 1024 characters.
4045 },
4046 ],
4047 "labels": { # Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.
4048 "a_key": "A String",
4049 },
4050 "createTime": "A String", # Output only. The time template was created.
4051 "version": 42, # Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.
4052 "jobs": [ # Required. The Directed Acyclic Graph of Jobs to submit.
4053 { # A job executed by the workflow.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4054 "hadoopJob": { # A Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html). # Optional. Job is a Hadoop job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4055 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
4056 "A String",
4057 ],
4058 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4059 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4060 "a_key": "A String",
4061 },
4062 },
4063 "jarFileUris": [ # Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
4064 "A String",
4065 ],
4066 "fileUris": [ # Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
4067 "A String",
4068 ],
4069 "mainClass": "A String", # The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.
4070 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
4071 "A String",
4072 ],
4073 "mainJarFileUri": "A String", # The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4074 "properties": { # Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4075 "a_key": "A String",
4076 },
4077 },
4078 "stepId": "A String", # Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job goog-dataproc-workflow-step-id label, and in prerequisiteStepIds field from other steps.The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4079 "sparkRJob": { # A Dataproc job for running Apache SparkR (https://spark.apache.org/docs/latest/sparkr.html) applications on YARN. # Optional. Job is a SparkR job.
4080 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4081 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4082 "a_key": "A String",
4083 },
4084 },
4085 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
4086 "A String",
4087 ],
4088 "mainRFileUri": "A String", # Required. The HCFS URI of the main R file to use as the driver. Must be a .R file.
4089 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of R drivers and distributed tasks. Useful for naively parallel tasks.
4090 "A String",
4091 ],
4092 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
4093 "A String",
4094 ],
4095 "properties": { # Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
4096 "a_key": "A String",
4097 },
4098 },
4099 "sparkSqlJob": { # A Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries. # Optional. Job is a SparkSql job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4100 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
4101 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name="value";).
4102 "a_key": "A String",
4103 },
4104 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4105 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4106 "a_key": "A String",
4107 },
4108 },
4109 "jarFileUris": [ # Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
4110 "A String",
4111 ],
4112 "queryList": { # A list of queries to run on a cluster. # A list of queries.
4113 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
4114 # "hiveJob": {
4115 # "queryList": {
4116 # "queries": [
4117 # "query1",
4118 # "query2",
4119 # "query3;query4",
4120 # ]
4121 # }
4122 # }
4123 "A String",
4124 ],
4125 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4126 "properties": { # Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4127 "a_key": "A String",
4128 },
4129 },
4130 "prerequisiteStepIds": [ # Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
4131 "A String",
4132 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4133 "pigJob": { # A Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN. # Optional. Job is a Pig job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4134 "queryFileUri": "A String", # The HCFS URI of the script that contains the Pig queries.
4135 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).
4136 "a_key": "A String",
4137 },
4138 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4139 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4140 "a_key": "A String",
4141 },
4142 },
4143 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
4144 "A String",
4145 ],
4146 "queryList": { # A list of queries to run on a cluster. # A list of queries.
4147 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
4148 # "hiveJob": {
4149 # "queryList": {
4150 # "queries": [
4151 # "query1",
4152 # "query2",
4153 # "query3;query4",
4154 # ]
4155 # }
4156 # }
4157 "A String",
4158 ],
4159 },
4160 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4161 "properties": { # Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4162 "a_key": "A String",
4163 },
4164 },
4165 "labels": { # Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 32 labels can be associated with a given job.
4166 "a_key": "A String",
4167 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4168 "sparkJob": { # A Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN. # Optional. Job is a Spark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4169 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
4170 "A String",
4171 ],
4172 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4173 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4174 "a_key": "A String",
4175 },
4176 },
4177 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
4178 "A String",
4179 ],
4180 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
4181 "A String",
4182 ],
4183 "mainClass": "A String", # The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.
4184 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
4185 "A String",
4186 ],
4187 "mainJarFileUri": "A String", # The HCFS URI of the jar file that contains the main class.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4188 "properties": { # Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
4189 "a_key": "A String",
4190 },
4191 },
4192 "prestoJob": { # A Dataproc job for running Presto (https://prestosql.io/) queries. IMPORTANT: The Dataproc Presto Optional Component (https://cloud.google.com/dataproc/docs/concepts/components/presto) must be enabled when the cluster is created to submit a Presto job to the cluster. # Optional. Job is a Presto job.
4193 "queryFileUri": "A String", # The HCFS URI of the script that contains SQL queries.
4194 "outputFormat": "A String", # Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats
4195 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4196 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4197 "a_key": "A String",
4198 },
4199 },
4200 "clientTags": [ # Optional. Presto client tags to attach to this query
4201 "A String",
4202 ],
4203 "queryList": { # A list of queries to run on a cluster. # A list of queries.
4204 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
4205 # "hiveJob": {
4206 # "queryList": {
4207 # "queries": [
4208 # "query1",
4209 # "query2",
4210 # "query3;query4",
4211 # ]
4212 # }
4213 # }
4214 "A String",
4215 ],
4216 },
4217 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
4218 "properties": { # Optional. A mapping of property names to values. Used to set Presto session properties (https://prestodb.io/docs/current/sql/set-session.html) Equivalent to using the --session flag in the Presto CLI
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4219 "a_key": "A String",
4220 },
4221 },
4222 "scheduling": { # Job scheduling options. # Optional. Job scheduling configuration.
4223 "maxFailuresPerHour": 42, # Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.
4224 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4225 "pysparkJob": { # A Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN. # Optional. Job is a PySpark job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4226 "mainPythonFileUri": "A String", # Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4227 "args": [ # Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4228 "A String",
4229 ],
4230 "loggingConfig": { # The runtime logging config of the job. # Optional. The runtime log config for job execution.
4231 "driverLogLevels": { # The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
4232 "a_key": "A String",
4233 },
4234 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4235 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4236 "A String",
4237 ],
4238 "fileUris": [ # Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
4239 "A String",
4240 ],
4241 "archiveUris": [ # Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
4242 "A String",
4243 ],
4244 "pythonFileUris": [ # Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
4245 "A String",
4246 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4247 "properties": { # Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4248 "a_key": "A String",
4249 },
4250 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4251 "hiveJob": { # A Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN. # Optional. Job is a Hive job.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4252 "queryFileUri": "A String", # The HCFS URI of the script that contains Hive queries.
4253 "scriptVariables": { # Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name="value";).
4254 "a_key": "A String",
4255 },
4256 "jarFileUris": [ # Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
4257 "A String",
4258 ],
4259 "queryList": { # A list of queries to run on a cluster. # A list of queries.
4260 "queries": [ # Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:
4261 # "hiveJob": {
4262 # "queryList": {
4263 # "queries": [
4264 # "query1",
4265 # "query2",
4266 # "query3;query4",
4267 # ]
4268 # }
4269 # }
4270 "A String",
4271 ],
4272 },
4273 "continueOnFailure": True or False, # Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4274 "properties": { # Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4275 "a_key": "A String",
4276 },
4277 },
4278 },
4279 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]4280 "id": "A String",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]4281 }</pre>
4282</div>
4283
4284</body></html>