Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 692617a6eea5e47e71e221c9e73f5f2d5534e3bf / . / docs / dyn / dataproc_v1.projects.regions.clusters.html
blob: c8fcdcd7c0fe8c0f4d148cda3c252edcf3b9f496 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1.html">Google 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, 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, 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, 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">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]90 <code><a href="#list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Lists all regions/{region}/clusters in a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a cluster in a project.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
101 <pre>Creates a cluster in a project.
102
103Args:
104 projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]105 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
110 "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]111 "state": "A String", # [Output-only] The cluster's state.
112 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
113 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114 },
115 "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]116 "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]117 "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]118 "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.
119 "a_key": "A String",
120 },
121 "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.
122 "yarnMetrics": { # The YARN metrics.
123 "a_key": "A String",
124 },
125 "hdfsMetrics": { # The HDFS metrics.
126 "a_key": "A String",
127 },
128 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]129 "statusHistory": [ # [Output-only] The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 { # The status of a cluster and its instances.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]131 "state": "A String", # [Output-only] The cluster's state.
132 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
133 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]134 },
135 ],
136 "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
137 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
138 "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]139 "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]140 "a_key": "A String",
141 },
142 },
143 "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate 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 it will create and manage this project-level, per-location bucket for you.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]144 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]145 "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.
146 "networkUri": "A String", # [Optional] The Google 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](/compute/docs/subnetworks) for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
147 "tags": [ # The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]148 "A String",
149 ],
150 "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]151 "subnetworkUri": "A String", # [Optional] The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
152 "serviceAccountScopes": [ # [Optional] The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]153 "A String",
154 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]155 "metadata": { # The Google 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)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]156 "a_key": "A String",
157 },
158 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]159 "workerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
160 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
161 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
162 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]163 "A String",
164 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]165 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
166 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]167 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
168 },
169 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
170 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
171 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
172 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]173 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]174 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
175 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]176 "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`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]177 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
178 "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.
179 "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
180 },
181 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]182 "secondaryWorkerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
183 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
184 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
185 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]186 "A String",
187 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]188 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
189 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]190 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
191 },
192 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
193 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
194 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
195 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]196 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
198 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]199 "masterConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
200 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
201 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
202 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]203 "A String",
204 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]205 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
206 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]207 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
208 },
209 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
210 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
211 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
212 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]213 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]214 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
215 },
216 },
217}
218
219 x__xgafv: string, V1 error format.
220
221Returns:
222 An object of the form:
223
224 { # This resource represents a long-running operation that is the result of a network API call.
225 "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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]226 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]228 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]229 "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.
230 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
231 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
232 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]233 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]234 },
235 ],
236 },
237 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]238 "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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]239 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]240 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]241 },
242 }</pre>
243</div>
244
245<div class="method">
246 <code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
247 <pre>Deletes a cluster in a project.
248
249Args:
250 projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]251 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]252 clusterName: string, [Required] The cluster name. (required)
253 x__xgafv: string, V1 error format.
254
255Returns:
256 An object of the form:
257
258 { # This resource represents a long-running operation that is the result of a network API call.
259 "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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]260 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]261 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]262 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]263 "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.
264 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
265 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
266 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]267 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]268 },
269 ],
270 },
271 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]272 "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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]273 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]274 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]275 },
276 }</pre>
277</div>
278
279<div class="method">
280 <code class="details" id="diagnose">diagnose(projectId, region, clusterName, body, x__xgafv=None)</code>
281 <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.
282
283Args:
284 projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]285 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]286 clusterName: string, [Required] The cluster name. (required)
287 body: object, The request body. (required)
288 The object takes the form of:
289
290{ # A request to collect cluster diagnostic information.
291 }
292
293 x__xgafv: string, V1 error format.
294
295Returns:
296 An object of the form:
297
298 { # This resource represents a long-running operation that is the result of a network API call.
299 "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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]300 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]301 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]302 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]303 "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.
304 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
305 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
306 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]307 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]308 },
309 ],
310 },
311 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]312 "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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]313 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]314 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]315 },
316 }</pre>
317</div>
318
319<div class="method">
320 <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
321 <pre>Gets the resource representation for a cluster in a project.
322
323Args:
324 projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]325 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]326 clusterName: string, [Required] The cluster name. (required)
327 x__xgafv: string, V1 error format.
328
329Returns:
330 An object of the form:
331
332 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
333 "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]334 "state": "A String", # [Output-only] The cluster's state.
335 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
336 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 },
338 "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]339 "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]340 "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]341 "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.
342 "a_key": "A String",
343 },
344 "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.
345 "yarnMetrics": { # The YARN metrics.
346 "a_key": "A String",
347 },
348 "hdfsMetrics": { # The HDFS metrics.
349 "a_key": "A String",
350 },
351 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]352 "statusHistory": [ # [Output-only] The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]353 { # The status of a cluster and its instances.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]354 "state": "A String", # [Output-only] The cluster's state.
355 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
356 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]357 },
358 ],
359 "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
360 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
361 "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]362 "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]363 "a_key": "A String",
364 },
365 },
366 "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate 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 it will create and manage this project-level, per-location bucket for you.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]367 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]368 "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.
369 "networkUri": "A String", # [Optional] The Google 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](/compute/docs/subnetworks) for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
370 "tags": [ # The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]371 "A String",
372 ],
373 "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]374 "subnetworkUri": "A String", # [Optional] The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
375 "serviceAccountScopes": [ # [Optional] The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]376 "A String",
377 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]378 "metadata": { # The Google 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)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]379 "a_key": "A String",
380 },
381 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]382 "workerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
383 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
384 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
385 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]386 "A String",
387 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]388 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
389 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]390 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
391 },
392 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
393 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
394 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
395 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]396 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]397 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
398 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]399 "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`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]400 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
401 "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.
402 "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
403 },
404 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]405 "secondaryWorkerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
406 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
407 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
408 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]409 "A String",
410 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]411 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
412 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]413 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
414 },
415 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
416 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
417 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
418 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]419 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]420 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
421 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]422 "masterConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
423 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
424 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
425 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]426 "A String",
427 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]428 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
429 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]430 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
431 },
432 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
433 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
434 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
435 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]436 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]437 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
438 },
439 },
440 }</pre>
441</div>
442
443<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]444 <code class="details" id="list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]445 <pre>Lists all regions/{region}/clusters in a project.
446
447Args:
448 projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]449 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]450 pageSize: integer, [Optional] The standard List page size.
451 filter: string, [Optional] A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field:value [field:value] ... or 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 valid filters are: status.state:ACTIVE clusterName:mycluster labels.env:staging \ labels.starred:* and status.state = ACTIVE AND clusterName = mycluster \ AND labels.env = staging AND labels.starred = *
452 pageToken: string, [Optional] The standard List page token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]453 x__xgafv: string, V1 error format.
454
455Returns:
456 An object of the form:
457
458 { # The list of all clusters in a project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]459 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]460 "clusters": [ # [Output-only] The clusters in the project.
461 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
462 "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]463 "state": "A String", # [Output-only] The cluster's state.
464 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
465 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]466 },
467 "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]468 "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]469 "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]470 "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.
471 "a_key": "A String",
472 },
473 "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.
474 "yarnMetrics": { # The YARN metrics.
475 "a_key": "A String",
476 },
477 "hdfsMetrics": { # The HDFS metrics.
478 "a_key": "A String",
479 },
480 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]481 "statusHistory": [ # [Output-only] The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]482 { # The status of a cluster and its instances.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]483 "state": "A String", # [Output-only] The cluster's state.
484 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
485 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]486 },
487 ],
488 "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
489 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
490 "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]491 "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]492 "a_key": "A String",
493 },
494 },
495 "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate 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 it will create and manage this project-level, per-location bucket for you.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]496 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]497 "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.
498 "networkUri": "A String", # [Optional] The Google 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](/compute/docs/subnetworks) for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
499 "tags": [ # The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]500 "A String",
501 ],
502 "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]503 "subnetworkUri": "A String", # [Optional] The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
504 "serviceAccountScopes": [ # [Optional] The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]505 "A String",
506 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]507 "metadata": { # The Google 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)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]508 "a_key": "A String",
509 },
510 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]511 "workerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
512 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
513 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
514 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]515 "A String",
516 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]517 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
518 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]519 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
520 },
521 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
522 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
523 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
524 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]525 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]526 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
527 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]528 "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`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]529 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
530 "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.
531 "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
532 },
533 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]534 "secondaryWorkerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
535 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
536 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
537 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]538 "A String",
539 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]540 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
541 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]542 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
543 },
544 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
545 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
546 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
547 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]548 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]549 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
550 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]551 "masterConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
552 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
553 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
554 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]555 "A String",
556 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]557 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
558 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]559 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
560 },
561 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
562 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
563 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
564 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]565 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]566 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
567 },
568 },
569 },
570 ],
571 }</pre>
572</div>
573
574<div class="method">
575 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
576 <pre>Retrieves the next page of results.
577
578Args:
579 previous_request: The request for the previous page. (required)
580 previous_response: The response from the request for the previous page. (required)
581
582Returns:
583 A request object that you can call 'execute()' on to request the next
584 page. Returns None if there are no more items in the collection.
585 </pre>
586</div>
587
588<div class="method">
589 <code class="details" id="patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
590 <pre>Updates a cluster in a project.
591
592Args:
593 projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]594 region: string, [Required] The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]595 clusterName: string, [Required] The cluster name. (required)
596 body: object, The request body. (required)
597 The object takes the form of:
598
599{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
600 "status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]601 "state": "A String", # [Output-only] The cluster's state.
602 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
603 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]604 },
605 "clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]606 "clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]607 "projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]608 "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.
609 "a_key": "A String",
610 },
611 "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.
612 "yarnMetrics": { # The YARN metrics.
613 "a_key": "A String",
614 },
615 "hdfsMetrics": { # The HDFS metrics.
616 "a_key": "A String",
617 },
618 },
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]619 "statusHistory": [ # [Output-only] The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]620 { # The status of a cluster and its instances.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]621 "state": "A String", # [Output-only] The cluster's state.
622 "stateStartTime": "A String", # [Output-only] Time when this state was entered.
623 "detail": "A String", # [Output-only] Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]624 },
625 ],
626 "config": { # The cluster config. # [Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
627 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # [Optional] The config settings for software inside the cluster.
628 "imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]629 "properties": { # [Optional] The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]630 "a_key": "A String",
631 },
632 },
633 "configBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate 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 it will create and manage this project-level, per-location bucket for you.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]634 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Required] The shared Google Compute Engine config settings for all instances in a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]635 "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.
636 "networkUri": "A String", # [Optional] The Google 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](/compute/docs/subnetworks) for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.
637 "tags": [ # The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]638 "A String",
639 ],
640 "zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]641 "subnetworkUri": "A String", # [Optional] The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.
642 "serviceAccountScopes": [ # [Optional] The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]643 "A String",
644 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]645 "metadata": { # The Google 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)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]646 "a_key": "A String",
647 },
648 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]649 "workerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for worker instances in a cluster.
650 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
651 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
652 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]653 "A String",
654 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]655 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
656 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]657 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
658 },
659 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
660 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
661 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
662 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]663 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]664 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
665 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]666 "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`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]667 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
668 "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.
669 "executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
670 },
671 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]672 "secondaryWorkerConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for additional worker instances in a cluster.
673 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
674 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
675 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]676 "A String",
677 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]678 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
679 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]680 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
681 },
682 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
683 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
684 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
685 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]686 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]687 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
688 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]689 "masterConfig": { # [Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine config settings for the master instance in a cluster.
690 "isPreemptible": True or False, # [Optional] Specifies that this instance group contains preemptible instances.
691 "machineTypeUri": "A String", # [Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.
692 "instanceNames": [ # [Optional] The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]693 "A String",
694 ],
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]695 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # [Optional] Disk option config settings.
696 "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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]697 "bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
698 },
699 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # [Output-only] The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
700 "instanceTemplateName": "A String", # [Output-only] The name of the Instance Template used for the Managed Instance Group.
701 "instanceGroupManagerName": "A String", # [Output-only] The name of the Instance Group Manager for this group.
702 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]703 "numInstances": 42, # [Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]704 "imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
705 },
706 },
707}
708
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]709 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: { "config":{ "workerConfig":{ "numInstances":"5" } } } Similarly, 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: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } Note: Currently, config.worker_config.num_instances and config.secondary_worker_config.num_instances are the only fields that can be updated.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]710 x__xgafv: string, V1 error format.
711
712Returns:
713 An object of the form:
714
715 { # This resource represents a long-running operation that is the result of a network API call.
716 "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`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]717 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]718 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]719 "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). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure or cancellation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]720 "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.
721 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
722 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
723 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]724 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]725 },
726 ],
727 },
728 "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.
Jon Wayne Parrott0a471d32016-05-19 10:54:38 -0700[diff] [blame]729 "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 have the format of `operations/some/unique/name`.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]730 "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.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame^]731 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]732 },
733 }</pre>
734</div>
735
736</body></html>