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.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#create">create(projectId, region, body, requestId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a cluster in a project.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(projectId, region, clusterName, clusterUuid=None, requestId=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a cluster in a project.</p>
83<p class="toc_element">
84  <code><a href="#diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.</p>
86<p class="toc_element">
87  <code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the resource representation for a cluster in a project.</p>
89<p class="toc_element">
90  <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
91<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>
92<p class="toc_element">
93  <code><a href="#list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
94<p class="firstline">Lists all regions/{region}/clusters in a project.</p>
95<p class="toc_element">
96  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
99  <code><a href="#patch">patch(projectId, region, clusterName, body, x__xgafv=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=None)</a></code></p>
100<p class="firstline">Updates a cluster in a project.</p>
101<p class="toc_element">
102  <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
104<p class="toc_element">
105  <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
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<h3>Method Details</h3>
108<div class="method">
109    <code class="details" id="create">create(projectId, region, body, requestId=None, x__xgafv=None)</code>
110  <pre>Creates a cluster in a project.
111
112Args:
113  projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
114  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
115  body: object, The request body. (required)
116    The object takes the form of:
117
118{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
119  "status": { # The status of a cluster and its instances. # Output only. Cluster status.
120    "state": "A String", # Output only. The cluster's state.
121    "stateStartTime": "A String", # Output only. Time when this state was entered.
122    "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
123    "detail": "A String", # Output only. Optional details of cluster's state.
124  },
125  "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
126  "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
127  "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
128  "labels": { # Optional. The labels to associate with this cluster. 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 cluster.
129    "a_key": "A String",
130  },
131  "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
132    "yarnMetrics": { # The YARN metrics.
133      "a_key": "A String",
134    },
135    "hdfsMetrics": { # The HDFS metrics.
136      "a_key": "A String",
137    },
138  },
139  "statusHistory": [ # Output only. The previous cluster status.
140    { # The status of a cluster and its instances.
141      "state": "A String", # Output only. The cluster's state.
142      "stateStartTime": "A String", # Output only. Time when this state was entered.
143      "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
144      "detail": "A String", # Output only. Optional details of cluster's state.
145    },
146  ],
147  "config": { # The cluster config. # Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
148    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
149      "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.
150      "optionalComponents": [ # The set of optional components to activate on the cluster.
151        "A String",
152      ],
153      "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:
154          # capacity-scheduler: capacity-scheduler.xml
155          # core: core-site.xml
156          # distcp: distcp-default.xml
157          # hdfs: hdfs-site.xml
158          # hive: hive-site.xml
159          # mapred: mapred-site.xml
160          # pig: pig.properties
161          # spark: spark-defaults.conf
162          # yarn: yarn-site.xmlFor more information, see Cluster properties.
163        "a_key": "A String",
164      },
165    },
166    "configBucket": "A String", # Optional. A Google 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 Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).
167    "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.
168      "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.
169      "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 for more information).A full URL, partial URI, or short name are valid. Examples:
170          # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
171          # projects/[project_id]/regions/global/default
172          # default
173      "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).
174        "A String",
175      ],
176      "serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:
177          # roles/logging.logWriter
178          # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
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 Cloud 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:
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    },
201    "workerConfig": { # Optional. 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.
202      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
203      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
204          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
205          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
206          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
207      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
208        "A String",
209      ],
210      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
211      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
212        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
213          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
214          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
215              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
216              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
217              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
218        },
219      ],
220      "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.
221        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
222        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
223      },
224      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
225      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
226        "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.
227        "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).
228        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
229      },
230    },
231    "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):
232        # ROLE=$(curl -H Metadata-Flavor:Google
233        # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
234        # if [[ "${ROLE}" == 'Master' ]]; then
235        #   ... master specific actions ...
236        # else
237        #   ... worker specific actions ...
238        # fi
239      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
240        "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.
241        "executableFile": "A String", # Required. Cloud Storage URI of executable file.
242      },
243    ],
244    "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
245      "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
246    },
247    "secondaryWorkerConfig": { # Optional. 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.
248      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
249      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
250          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
251          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
252          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
253      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
254        "A String",
255      ],
256      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
257      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
258        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
259          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
260          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
261              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
262              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
263              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
264        },
265      ],
266      "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.
267        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
268        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
269      },
270      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
271      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
272        "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.
273        "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).
274        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
275      },
276    },
277    "masterConfig": { # Optional. 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.
278      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
279      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
280          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
281          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
282          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
283      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
284        "A String",
285      ],
286      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
287      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
288        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
289          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
290          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
291              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
292              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
293              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
294        },
295      ],
296      "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.
297        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
298        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
299      },
300      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
301      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
302        "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.
303        "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).
304        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
305      },
306    },
307    "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
308      "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
309        "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.
310        "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
311        "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.
312        "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.
313        "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
314        "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.
315        "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.
316        "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.
317        "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.
318        "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
319        "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.
320        "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
321        "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
322        "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
323      },
324    },
325  },
326}
327
328  requestId: string, Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
329  x__xgafv: string, V1 error format.
330    Allowed values
331      1 - v1 error format
332      2 - v2 error format
333
334Returns:
335  An object of the form:
336
337    { # This resource represents a long-running operation that is the result of a network API call.
338    "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.
339      "a_key": "", # Properties of the object. Contains field @type with type URL.
340    },
341    "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.
342    "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.
343      "a_key": "", # Properties of the object. Contains field @type with type URL.
344    },
345    "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}.
346    "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.
347      "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.
348      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
349      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
350        {
351          "a_key": "", # Properties of the object. Contains field @type with type URL.
352        },
353      ],
354    },
355  }</pre>
356</div>
357
358<div class="method">
359    <code class="details" id="delete">delete(projectId, region, clusterName, clusterUuid=None, requestId=None, x__xgafv=None)</code>
360  <pre>Deletes a cluster in a project.
361
362Args:
363  projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
364  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
365  clusterName: string, Required. The cluster name. (required)
366  clusterUuid: string, Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
367  requestId: string, Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
368  x__xgafv: string, V1 error format.
369    Allowed values
370      1 - v1 error format
371      2 - v2 error format
372
373Returns:
374  An object of the form:
375
376    { # This resource represents a long-running operation that is the result of a network API call.
377    "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.
378      "a_key": "", # Properties of the object. Contains field @type with type URL.
379    },
380    "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.
381    "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.
382      "a_key": "", # Properties of the object. Contains field @type with type URL.
383    },
384    "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}.
385    "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.
386      "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.
387      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
388      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
389        {
390          "a_key": "", # Properties of the object. Contains field @type with type URL.
391        },
392      ],
393    },
394  }</pre>
395</div>
396
397<div class="method">
398    <code class="details" id="diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</code>
399  <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.
400
401Args:
402  projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
403  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
404  clusterName: string, Required. The cluster name. (required)
405  body: object, The request body.
406    The object takes the form of:
407
408{ # A request to collect cluster diagnostic information.
409  }
410
411  x__xgafv: string, V1 error format.
412    Allowed values
413      1 - v1 error format
414      2 - v2 error format
415
416Returns:
417  An object of the form:
418
419    { # This resource represents a long-running operation that is the result of a network API call.
420    "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.
421      "a_key": "", # Properties of the object. Contains field @type with type URL.
422    },
423    "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.
424    "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.
425      "a_key": "", # Properties of the object. Contains field @type with type URL.
426    },
427    "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}.
428    "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.
429      "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.
430      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
431      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
432        {
433          "a_key": "", # Properties of the object. Contains field @type with type URL.
434        },
435      ],
436    },
437  }</pre>
438</div>
439
440<div class="method">
441    <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
442  <pre>Gets the resource representation for a cluster in a project.
443
444Args:
445  projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
446  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
447  clusterName: string, Required. The cluster name. (required)
448  x__xgafv: string, V1 error format.
449    Allowed values
450      1 - v1 error format
451      2 - v2 error format
452
453Returns:
454  An object of the form:
455
456    { # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
457    "status": { # The status of a cluster and its instances. # Output only. Cluster status.
458      "state": "A String", # Output only. The cluster's state.
459      "stateStartTime": "A String", # Output only. Time when this state was entered.
460      "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
461      "detail": "A String", # Output only. Optional details of cluster's state.
462    },
463    "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
464    "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
465    "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
466    "labels": { # Optional. The labels to associate with this cluster. 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 cluster.
467      "a_key": "A String",
468    },
469    "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
470      "yarnMetrics": { # The YARN metrics.
471        "a_key": "A String",
472      },
473      "hdfsMetrics": { # The HDFS metrics.
474        "a_key": "A String",
475      },
476    },
477    "statusHistory": [ # Output only. The previous cluster status.
478      { # The status of a cluster and its instances.
479        "state": "A String", # Output only. The cluster's state.
480        "stateStartTime": "A String", # Output only. Time when this state was entered.
481        "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
482        "detail": "A String", # Output only. Optional details of cluster's state.
483      },
484    ],
485    "config": { # The cluster config. # Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
486      "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
487        "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.
488        "optionalComponents": [ # The set of optional components to activate on the cluster.
489          "A String",
490        ],
491        "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:
492            # capacity-scheduler: capacity-scheduler.xml
493            # core: core-site.xml
494            # distcp: distcp-default.xml
495            # hdfs: hdfs-site.xml
496            # hive: hive-site.xml
497            # mapred: mapred-site.xml
498            # pig: pig.properties
499            # spark: spark-defaults.conf
500            # yarn: yarn-site.xmlFor more information, see Cluster properties.
501          "a_key": "A String",
502        },
503      },
504      "configBucket": "A String", # Optional. A Google 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 Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).
505      "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.
506        "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.
507        "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 for more information).A full URL, partial URI, or short name are valid. Examples:
508            # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
509            # projects/[project_id]/regions/global/default
510            # default
511        "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).
512          "A String",
513        ],
514        "serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:
515            # roles/logging.logWriter
516            # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
517        "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 Cloud 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:
518            # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
519            # projects/[project_id]/zones/[zone]
520            # us-central1-f
521        "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:
522            # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
523            # projects/[project_id]/regions/us-east1/subnetworks/sub0
524            # sub0
525        "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
526            # https://www.googleapis.com/auth/cloud.useraccounts.readonly
527            # https://www.googleapis.com/auth/devstorage.read_write
528            # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
529            # https://www.googleapis.com/auth/bigquery
530            # https://www.googleapis.com/auth/bigtable.admin.table
531            # https://www.googleapis.com/auth/bigtable.data
532            # https://www.googleapis.com/auth/devstorage.full_control
533          "A String",
534        ],
535        "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)).
536          "a_key": "A String",
537        },
538      },
539      "workerConfig": { # Optional. 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.
540        "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
541        "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
542            # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
543            # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
544            # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
545        "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
546          "A String",
547        ],
548        "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
549        "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
550          { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
551            "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
552            "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
553                # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
554                # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
555                # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
556          },
557        ],
558        "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.
559          "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
560          "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
561        },
562        "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
563        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
564          "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.
565          "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).
566          "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
567        },
568      },
569      "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):
570          # ROLE=$(curl -H Metadata-Flavor:Google
571          # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
572          # if [[ "${ROLE}" == 'Master' ]]; then
573          #   ... master specific actions ...
574          # else
575          #   ... worker specific actions ...
576          # fi
577        { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
578          "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.
579          "executableFile": "A String", # Required. Cloud Storage URI of executable file.
580        },
581      ],
582      "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
583        "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
584      },
585      "secondaryWorkerConfig": { # Optional. 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.
586        "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
587        "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
588            # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
589            # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
590            # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
591        "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
592          "A String",
593        ],
594        "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
595        "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
596          { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
597            "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
598            "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
599                # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
600                # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
601                # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
602          },
603        ],
604        "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.
605          "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
606          "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
607        },
608        "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
609        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
610          "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.
611          "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).
612          "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
613        },
614      },
615      "masterConfig": { # Optional. 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.
616        "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
617        "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
618            # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
619            # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
620            # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
621        "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
622          "A String",
623        ],
624        "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
625        "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
626          { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
627            "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
628            "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
629                # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
630                # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
631                # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
632          },
633        ],
634        "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.
635          "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
636          "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
637        },
638        "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
639        "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
640          "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.
641          "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).
642          "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
643        },
644      },
645      "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
646        "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
647          "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.
648          "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
649          "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.
650          "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.
651          "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
652          "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.
653          "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.
654          "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.
655          "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.
656          "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
657          "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.
658          "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
659          "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
660          "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
661        },
662      },
663    },
664  }</pre>
665</div>
666
667<div class="method">
668    <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
669  <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
670
671Args:
672  resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
673  body: object, The request body.
674    The object takes the form of:
675
676{ # Request message for GetIamPolicy method.
677  }
678
679  x__xgafv: string, V1 error format.
680    Allowed values
681      1 - v1 error format
682      2 - v2 error format
683
684Returns:
685  An object of the form:
686
687    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
688      # {
689      #   "bindings": [
690      #     {
691      #       "role": "roles/owner",
692      #       "members": [
693      #         "user:mike@example.com",
694      #         "group:admins@example.com",
695      #         "domain:google.com",
696      #         "serviceAccount:my-other-app@appspot.gserviceaccount.com"
697      #       ]
698      #     },
699      #     {
700      #       "role": "roles/viewer",
701      #       "members": ["user:sean@example.com"]
702      #     }
703      #   ]
704      # }
705      # YAML Example
706      # bindings:
707      # - members:
708      #   - user:mike@example.com
709      #   - group:admins@example.com
710      #   - domain:google.com
711      #   - serviceAccount:my-other-app@appspot.gserviceaccount.com
712      #   role: roles/owner
713      # - members:
714      #   - user:sean@example.com
715      #   role: roles/viewer
716      # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
717    "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
718      { # Associates members with a role.
719        "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
720        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
721            # allUsers: A special identifier that represents anyone who is  on the internet; with or without a Google account.
722            # allAuthenticatedUsers: A special identifier that represents anyone  who is authenticated with a Google account or a service account.
723            # user:{emailid}: An email address that represents a specific Google  account. For example, alice@gmail.com .
724            # serviceAccount:{emailid}: An email address that represents a service  account. For example, my-other-app@appspot.gserviceaccount.com.
725            # group:{emailid}: An email address that represents a Google group.  For example, admins@example.com.
726            # domain:{domain}: The G Suite domain (primary) that represents all the  users of that domain. For example, google.com or example.com.
727          "A String",
728        ],
729        "condition": { # Represents an expression text. Example: # 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.
730            # title: "User account presence"
731            # description: "Determines whether the request has a user account"
732            # expression: "size(request.user) > 0"
733          "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
734          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
735          "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
736          "title": "A String", # An 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.
737        },
738      },
739    ],
740    "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
741    "version": 42, # Deprecated.
742  }</pre>
743</div>
744
745<div class="method">
746    <code class="details" id="list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
747  <pre>Lists all regions/{region}/clusters in a project.
748
749Args:
750  projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
751  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
752  pageSize: integer, Optional. The standard List page size.
753  pageToken: string, Optional. The standard List page token.
754  x__xgafv: string, V1 error format.
755    Allowed values
756      1 - v1 error format
757      2 - v2 error format
758  filter: string, Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *
759
760Returns:
761  An object of the form:
762
763    { # The list of all clusters in a project.
764    "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 ListClustersRequest.
765    "clusters": [ # Output only. The clusters in the project.
766      { # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
767        "status": { # The status of a cluster and its instances. # Output only. Cluster status.
768          "state": "A String", # Output only. The cluster's state.
769          "stateStartTime": "A String", # Output only. Time when this state was entered.
770          "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
771          "detail": "A String", # Output only. Optional details of cluster's state.
772        },
773        "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
774        "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
775        "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
776        "labels": { # Optional. The labels to associate with this cluster. 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 cluster.
777          "a_key": "A String",
778        },
779        "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
780          "yarnMetrics": { # The YARN metrics.
781            "a_key": "A String",
782          },
783          "hdfsMetrics": { # The HDFS metrics.
784            "a_key": "A String",
785          },
786        },
787        "statusHistory": [ # Output only. The previous cluster status.
788          { # The status of a cluster and its instances.
789            "state": "A String", # Output only. The cluster's state.
790            "stateStartTime": "A String", # Output only. Time when this state was entered.
791            "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
792            "detail": "A String", # Output only. Optional details of cluster's state.
793          },
794        ],
795        "config": { # The cluster config. # Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
796          "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
797            "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.
798            "optionalComponents": [ # The set of optional components to activate on the cluster.
799              "A String",
800            ],
801            "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:
802                # capacity-scheduler: capacity-scheduler.xml
803                # core: core-site.xml
804                # distcp: distcp-default.xml
805                # hdfs: hdfs-site.xml
806                # hive: hive-site.xml
807                # mapred: mapred-site.xml
808                # pig: pig.properties
809                # spark: spark-defaults.conf
810                # yarn: yarn-site.xmlFor more information, see Cluster properties.
811              "a_key": "A String",
812            },
813          },
814          "configBucket": "A String", # Optional. A Google 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 Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).
815          "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.
816            "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.
817            "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 for more information).A full URL, partial URI, or short name are valid. Examples:
818                # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
819                # projects/[project_id]/regions/global/default
820                # default
821            "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).
822              "A String",
823            ],
824            "serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:
825                # roles/logging.logWriter
826                # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
827            "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 Cloud 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:
828                # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
829                # projects/[project_id]/zones/[zone]
830                # us-central1-f
831            "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:
832                # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
833                # projects/[project_id]/regions/us-east1/subnetworks/sub0
834                # sub0
835            "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
836                # https://www.googleapis.com/auth/cloud.useraccounts.readonly
837                # https://www.googleapis.com/auth/devstorage.read_write
838                # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
839                # https://www.googleapis.com/auth/bigquery
840                # https://www.googleapis.com/auth/bigtable.admin.table
841                # https://www.googleapis.com/auth/bigtable.data
842                # https://www.googleapis.com/auth/devstorage.full_control
843              "A String",
844            ],
845            "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)).
846              "a_key": "A String",
847            },
848          },
849          "workerConfig": { # Optional. 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.
850            "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
851            "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
852                # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
853                # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
854                # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
855            "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
856              "A String",
857            ],
858            "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
859            "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
860              { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
861                "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
862                "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
863                    # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
864                    # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
865                    # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
866              },
867            ],
868            "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.
869              "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
870              "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
871            },
872            "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
873            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
874              "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.
875              "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).
876              "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
877            },
878          },
879          "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):
880              # ROLE=$(curl -H Metadata-Flavor:Google
881              # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
882              # if [[ "${ROLE}" == 'Master' ]]; then
883              #   ... master specific actions ...
884              # else
885              #   ... worker specific actions ...
886              # fi
887            { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
888              "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.
889              "executableFile": "A String", # Required. Cloud Storage URI of executable file.
890            },
891          ],
892          "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
893            "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
894          },
895          "secondaryWorkerConfig": { # Optional. 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.
896            "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
897            "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
898                # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
899                # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
900                # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
901            "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
902              "A String",
903            ],
904            "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
905            "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
906              { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
907                "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
908                "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
909                    # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
910                    # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
911                    # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
912              },
913            ],
914            "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.
915              "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
916              "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
917            },
918            "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
919            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
920              "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.
921              "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).
922              "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
923            },
924          },
925          "masterConfig": { # Optional. 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.
926            "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
927            "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
928                # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
929                # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
930                # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
931            "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
932              "A String",
933            ],
934            "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
935            "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
936              { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
937                "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
938                "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
939                    # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
940                    # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
941                    # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
942              },
943            ],
944            "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.
945              "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
946              "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
947            },
948            "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
949            "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
950              "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.
951              "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).
952              "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
953            },
954          },
955          "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
956            "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
957              "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.
958              "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
959              "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.
960              "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.
961              "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
962              "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.
963              "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.
964              "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.
965              "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.
966              "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
967              "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.
968              "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
969              "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
970              "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
971            },
972          },
973        },
974      },
975    ],
976  }</pre>
977</div>
978
979<div class="method">
980    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
981  <pre>Retrieves the next page of results.
982
983Args:
984  previous_request: The request for the previous page. (required)
985  previous_response: The response from the request for the previous page. (required)
986
987Returns:
988  A request object that you can call 'execute()' on to request the next
989  page. Returns None if there are no more items in the collection.
990    </pre>
991</div>
992
993<div class="method">
994    <code class="details" id="patch">patch(projectId, region, clusterName, body, x__xgafv=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=None)</code>
995  <pre>Updates a cluster in a project.
996
997Args:
998  projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
999  region: string, Required. The Cloud Dataproc region in which to handle the request. (required)
1000  clusterName: string, Required. The cluster name. (required)
1001  body: object, The request body. (required)
1002    The object takes the form of:
1003
1004{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
1005  "status": { # The status of a cluster and its instances. # Output only. Cluster status.
1006    "state": "A String", # Output only. The cluster's state.
1007    "stateStartTime": "A String", # Output only. Time when this state was entered.
1008    "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
1009    "detail": "A String", # Output only. Optional details of cluster's state.
1010  },
1011  "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
1012  "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
1013  "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
1014  "labels": { # Optional. The labels to associate with this cluster. 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 cluster.
1015    "a_key": "A String",
1016  },
1017  "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
1018    "yarnMetrics": { # The YARN metrics.
1019      "a_key": "A String",
1020    },
1021    "hdfsMetrics": { # The HDFS metrics.
1022      "a_key": "A String",
1023    },
1024  },
1025  "statusHistory": [ # Output only. The previous cluster status.
1026    { # The status of a cluster and its instances.
1027      "state": "A String", # Output only. The cluster's state.
1028      "stateStartTime": "A String", # Output only. Time when this state was entered.
1029      "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
1030      "detail": "A String", # Output only. Optional details of cluster's state.
1031    },
1032  ],
1033  "config": { # The cluster config. # Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
1034    "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
1035      "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Cloud Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version.
1036      "optionalComponents": [ # The set of optional components to activate on the cluster.
1037        "A String",
1038      ],
1039      "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:
1040          # capacity-scheduler: capacity-scheduler.xml
1041          # core: core-site.xml
1042          # distcp: distcp-default.xml
1043          # hdfs: hdfs-site.xml
1044          # hive: hive-site.xml
1045          # mapred: mapred-site.xml
1046          # pig: pig.properties
1047          # spark: spark-defaults.conf
1048          # yarn: yarn-site.xmlFor more information, see Cluster properties.
1049        "a_key": "A String",
1050      },
1051    },
1052    "configBucket": "A String", # Optional. A Google 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 Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Cloud Dataproc staging bucket).
1053    "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.
1054      "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.
1055      "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 for more information).A full URL, partial URI, or short name are valid. Examples:
1056          # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
1057          # projects/[project_id]/regions/global/default
1058          # default
1059      "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances).
1060        "A String",
1061      ],
1062      "serviceAccount": "A String", # Optional. The service account of the instances. Defaults to the default Compute Engine service account. Custom service accounts need permissions equivalent to the following IAM roles:
1063          # roles/logging.logWriter
1064          # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
1065      "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 Cloud 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:
1066          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
1067          # projects/[project_id]/zones/[zone]
1068          # us-central1-f
1069      "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:
1070          # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
1071          # projects/[project_id]/regions/us-east1/subnetworks/sub0
1072          # sub0
1073      "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
1074          # https://www.googleapis.com/auth/cloud.useraccounts.readonly
1075          # https://www.googleapis.com/auth/devstorage.read_write
1076          # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
1077          # https://www.googleapis.com/auth/bigquery
1078          # https://www.googleapis.com/auth/bigtable.admin.table
1079          # https://www.googleapis.com/auth/bigtable.data
1080          # https://www.googleapis.com/auth/devstorage.full_control
1081        "A String",
1082      ],
1083      "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)).
1084        "a_key": "A String",
1085      },
1086    },
1087    "workerConfig": { # Optional. 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.
1088      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
1089      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1090          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1091          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1092          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1093      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
1094        "A String",
1095      ],
1096      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
1097      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
1098        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
1099          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
1100          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
1101              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1102              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1103              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
1104        },
1105      ],
1106      "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.
1107        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1108        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1109      },
1110      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1111      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1112        "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.
1113        "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).
1114        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1115      },
1116    },
1117    "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):
1118        # ROLE=$(curl -H Metadata-Flavor:Google
1119        # http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
1120        # if [[ "${ROLE}" == 'Master' ]]; then
1121        #   ... master specific actions ...
1122        # else
1123        #   ... worker specific actions ...
1124        # fi
1125      { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
1126        "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes. 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.
1127        "executableFile": "A String", # Required. Cloud Storage URI of executable file.
1128      },
1129    ],
1130    "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1131      "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1132    },
1133    "secondaryWorkerConfig": { # Optional. 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.
1134      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
1135      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1136          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1137          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1138          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1139      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
1140        "A String",
1141      ],
1142      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
1143      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
1144        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
1145          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
1146          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
1147              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1148              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1149              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
1150        },
1151      ],
1152      "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.
1153        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1154        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1155      },
1156      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1157      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1158        "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.
1159        "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).
1160        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1161      },
1162    },
1163    "masterConfig": { # Optional. 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.
1164      "isPreemptible": True or False, # Optional. Specifies that this instance group contains preemptible instances.
1165      "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1166          # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1167          # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1168          # n1-standard-2Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1169      "instanceNames": [ # Output only. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group.
1170        "A String",
1171      ],
1172      "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from SoftwareConfig.image_version.
1173      "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
1174        { # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
1175          "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
1176          "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:
1177              # https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1178              # projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80
1179              # nvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
1180        },
1181      ],
1182      "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.
1183        "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1184        "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1185      },
1186      "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1187      "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1188        "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.
1189        "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).
1190        "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1191      },
1192    },
1193    "securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.
1194      "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
1195        "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.
1196        "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
1197        "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.
1198        "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster.
1199        "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1200        "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.
1201        "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.
1202        "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.
1203        "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.
1204        "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1205        "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.
1206        "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
1207        "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1208        "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
1209      },
1210    },
1211  },
1212}
1213
1214  x__xgafv: string, V1 error format.
1215    Allowed values
1216      1 - v1 error format
1217      2 - v2 error format
1218  gracefulDecommissionTimeout: string, Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.
1219  requestId: string, Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1220  updateMask: string, Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:
1221{
1222  "config":{
1223    "workerConfig":{
1224      "numInstances":"5"
1225    }
1226  }
1227}
1228Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:
1229{
1230  "config":{
1231    "secondaryWorkerConfig":{
1232      "numInstances":"5"
1233    }
1234  }
1235}
1236<strong>Note:</strong> Currently, only the following fields can be updated:<table>  <tbody>  <tr>  <td><strong>Mask</strong></td>  <td><strong>Purpose</strong></td>  </tr>  <tr>  <td><strong><em>labels</em></strong></td>  <td>Update labels</td>  </tr>  <tr>  <td><strong><em>config.worker_config.num_instances</em></strong></td>  <td>Resize primary worker group</td>  </tr>  <tr>  <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td>  <td>Resize secondary worker group</td>  </tr>  </tbody>  </table>
1237
1238Returns:
1239  An object of the form:
1240
1241    { # This resource represents a long-running operation that is the result of a network API call.
1242    "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.
1243      "a_key": "", # Properties of the object. Contains field @type with type URL.
1244    },
1245    "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.
1246    "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.
1247      "a_key": "", # Properties of the object. Contains field @type with type URL.
1248    },
1249    "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}.
1250    "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.
1251      "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.
1252      "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1253      "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1254        {
1255          "a_key": "", # Properties of the object. Contains field @type with type URL.
1256        },
1257      ],
1258    },
1259  }</pre>
1260</div>
1261
1262<div class="method">
1263    <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
1264  <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
1265
1266Args:
1267  resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
1268  body: object, The request body. (required)
1269    The object takes the form of:
1270
1271{ # Request message for SetIamPolicy method.
1272    "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.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.
1273        # {
1274        #   "bindings": [
1275        #     {
1276        #       "role": "roles/owner",
1277        #       "members": [
1278        #         "user:mike@example.com",
1279        #         "group:admins@example.com",
1280        #         "domain:google.com",
1281        #         "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1282        #       ]
1283        #     },
1284        #     {
1285        #       "role": "roles/viewer",
1286        #       "members": ["user:sean@example.com"]
1287        #     }
1288        #   ]
1289        # }
1290        # YAML Example
1291        # bindings:
1292        # - members:
1293        #   - user:mike@example.com
1294        #   - group:admins@example.com
1295        #   - domain:google.com
1296        #   - serviceAccount:my-other-app@appspot.gserviceaccount.com
1297        #   role: roles/owner
1298        # - members:
1299        #   - user:sean@example.com
1300        #   role: roles/viewer
1301        # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
1302      "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
1303        { # Associates members with a role.
1304          "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1305          "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1306              # allUsers: A special identifier that represents anyone who is  on the internet; with or without a Google account.
1307              # allAuthenticatedUsers: A special identifier that represents anyone  who is authenticated with a Google account or a service account.
1308              # user:{emailid}: An email address that represents a specific Google  account. For example, alice@gmail.com .
1309              # serviceAccount:{emailid}: An email address that represents a service  account. For example, my-other-app@appspot.gserviceaccount.com.
1310              # group:{emailid}: An email address that represents a Google group.  For example, admins@example.com.
1311              # domain:{domain}: The G Suite domain (primary) that represents all the  users of that domain. For example, google.com or example.com.
1312            "A String",
1313          ],
1314          "condition": { # Represents an expression text. Example: # 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.
1315              # title: "User account presence"
1316              # description: "Determines whether the request has a user account"
1317              # expression: "size(request.user) > 0"
1318            "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1319            "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
1320            "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1321            "title": "A String", # An 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.
1322          },
1323        },
1324      ],
1325      "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
1326      "version": 42, # Deprecated.
1327    },
1328  }
1329
1330  x__xgafv: string, V1 error format.
1331    Allowed values
1332      1 - v1 error format
1333      2 - v2 error format
1334
1335Returns:
1336  An object of the form:
1337
1338    { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.JSON Example
1339      # {
1340      #   "bindings": [
1341      #     {
1342      #       "role": "roles/owner",
1343      #       "members": [
1344      #         "user:mike@example.com",
1345      #         "group:admins@example.com",
1346      #         "domain:google.com",
1347      #         "serviceAccount:my-other-app@appspot.gserviceaccount.com"
1348      #       ]
1349      #     },
1350      #     {
1351      #       "role": "roles/viewer",
1352      #       "members": ["user:sean@example.com"]
1353      #     }
1354      #   ]
1355      # }
1356      # YAML Example
1357      # bindings:
1358      # - members:
1359      #   - user:mike@example.com
1360      #   - group:admins@example.com
1361      #   - domain:google.com
1362      #   - serviceAccount:my-other-app@appspot.gserviceaccount.com
1363      #   role: roles/owner
1364      # - members:
1365      #   - user:sean@example.com
1366      #   role: roles/viewer
1367      # For a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam/docs).
1368    "bindings": [ # Associates a list of members to a role. bindings with no members will result in an error.
1369      { # Associates members with a role.
1370        "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1371        "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1372            # allUsers: A special identifier that represents anyone who is  on the internet; with or without a Google account.
1373            # allAuthenticatedUsers: A special identifier that represents anyone  who is authenticated with a Google account or a service account.
1374            # user:{emailid}: An email address that represents a specific Google  account. For example, alice@gmail.com .
1375            # serviceAccount:{emailid}: An email address that represents a service  account. For example, my-other-app@appspot.gserviceaccount.com.
1376            # group:{emailid}: An email address that represents a Google group.  For example, admins@example.com.
1377            # domain:{domain}: The G Suite domain (primary) that represents all the  users of that domain. For example, google.com or example.com.
1378          "A String",
1379        ],
1380        "condition": { # Represents an expression text. Example: # 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.
1381            # title: "User account presence"
1382            # description: "Determines whether the request has a user account"
1383            # expression: "size(request.user) > 0"
1384          "location": "A String", # An optional string indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1385          "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.The application context of the containing message determines which well-known feature set of CEL is supported.
1386          "description": "A String", # An optional description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1387          "title": "A String", # An 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.
1388        },
1389      },
1390    ],
1391    "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.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.
1392    "version": 42, # Deprecated.
1393  }</pre>
1394</div>
1395
1396<div class="method">
1397    <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
1398  <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.
1399
1400Args:
1401  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)
1402  body: object, The request body. (required)
1403    The object takes the form of:
1404
1405{ # Request message for TestIamPermissions method.
1406    "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).
1407      "A String",
1408    ],
1409  }
1410
1411  x__xgafv: string, V1 error format.
1412    Allowed values
1413      1 - v1 error format
1414      2 - v2 error format
1415
1416Returns:
1417  An object of the form:
1418
1419    { # Response message for TestIamPermissions method.
1420    "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
1421      "A String",
1422    ],
1423  }</pre>
1424</div>
1425
1426</body></html>