Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 2f245374da9c895dbd8bb0423e98707d51b53414 / . / docs / dyn / dataproc_v1beta1.projects.clusters.html
blob: a00b0e83fb073e280b8c0fe65179fb876c4fef51 [file] [log] [blame]
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1beta1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1beta1.projects.html">projects</a> . <a href="dataproc_v1beta1.projects.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectId, 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, 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, clusterName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]85<p class="firstline">Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(projectId, 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, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]91<p class="firstline">Lists all 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, 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, body, x__xgafv=None)</code>
101 <pre>Creates a cluster in a project.
102
103Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]104 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]105 body: object, The request body. (required)
106 The object takes the form of:
107
108{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]109 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]110 "state": "A String", # The cluster's state.
111 "stateStartTime": "A String", # Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]112 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]113 "detail": "A String", # Optional details of cluster's state.
114 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]115 "configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
116 "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
117 "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).
118 "properties": { # Optional The properties to set on daemon configuration 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
119 "a_key": "A String",
120 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]121 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]122 "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine configuration settings for all instances in a cluster.
123 "internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
124 "networkUri": "A String", # 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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
125 "tags": [ # The Google Compute Engine tags to add to all instances.
126 "A String",
127 ],
128 "serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
129 # roles/logging.logWriter
130 # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
131 "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].
132 "subnetworkUri": "A String", # 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.
133 "serviceAccountScopes": [ # 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 specfied, 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
134 "A String",
135 ],
136 "metadata": { # The Google Compute Engine metadata entries to add to all instances.
137 "a_key": "A String",
138 },
139 },
140 "configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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.
141 "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
142 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
143 "machineTypeUri": "A String", # 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.
144 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
145 "A String",
146 ],
147 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
148 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
149 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
150 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
151 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
152 },
153 ],
154 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
155 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
156 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
157 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
158 },
159 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
160 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
161 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
162 },
163 },
164 "initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
165 # ROLE=$(/usr/share/google/get_metadata_value attributes/role)
166 # if [[ "${ROLE}" == 'Master' ]]; then
167 # ... master specific actions ...
168 # else
169 # ... worker specific actions ...
170 # fi
171 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
172 "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.
173 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
174 },
175 ],
176 "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
177 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
178 "machineTypeUri": "A String", # 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.
179 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
180 "A String",
181 ],
182 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
183 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
184 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
185 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
186 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
187 },
188 ],
189 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
190 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
191 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
192 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
193 },
194 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
195 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
196 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
197 },
198 },
199 "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
200 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
201 "machineTypeUri": "A String", # 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": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
203 "A String",
204 ],
205 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
206 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
207 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
208 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
209 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
210 },
211 ],
212 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
213 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
214 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
215 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
216 },
217 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
218 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
219 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
220 },
221 },
222 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]223 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
224 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
225 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
226 "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
227 "a_key": "A String",
228 },
229 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
230 "yarnMetrics": { # The YARN metrics.
231 "a_key": "A String",
232 },
233 "hdfsMetrics": { # The HDFS metrics.
234 "a_key": "A String",
235 },
236 },
237 "statusHistory": [ # Output-only Previous cluster statuses.
238 { # The status of a cluster and its instances.
239 "state": "A String", # The cluster's state.
240 "stateStartTime": "A String", # Time when this state was entered.
241 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
242 "detail": "A String", # Optional details of cluster's state.
243 },
244 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]245}
246
247 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]248 Allowed values
249 1 - v1 error format
250 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]251
252Returns:
253 An object of the form:
254
255 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]256 "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]257 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]258 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]259 "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: # The error result of the operation in case of failure or cancellation.
260 # Simple to use and understand for most users
261 # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
262 # 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.
263 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
264 # 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.
265 # 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.
266 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]267 "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.
268 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
269 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
270 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]271 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]272 },
273 ],
274 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]275 "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.
276 "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]277 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]278 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]279 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]280 }</pre>
281</div>
282
283<div class="method">
284 <code class="details" id="delete">delete(projectId, clusterName, x__xgafv=None)</code>
285 <pre>Deletes a cluster in a project.
286
287Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]288 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
289 clusterName: string, Required The cluster name. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]290 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]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.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]299 "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]300 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]301 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[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: # The error result of the operation in case of failure or cancellation.
303 # Simple to use and understand for most users
304 # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
305 # 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.
306 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
307 # 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.
308 # 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.
309 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]310 "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.
311 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
312 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
313 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]314 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]315 },
316 ],
317 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]318 "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.
319 "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]320 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]321 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]322 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]323 }</pre>
324</div>
325
326<div class="method">
327 <code class="details" id="diagnose">diagnose(projectId, clusterName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]328 <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]329
330Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]331 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
332 clusterName: string, Required The cluster name. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]333 body: object, The request body. (required)
334 The object takes the form of:
335
336{ # A request to collect cluster diagnostic information.
337 }
338
339 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]340 Allowed values
341 1 - v1 error format
342 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]343
344Returns:
345 An object of the form:
346
347 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]348 "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]349 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]350 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]351 "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: # The error result of the operation in case of failure or cancellation.
352 # Simple to use and understand for most users
353 # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
354 # 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.
355 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
356 # 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.
357 # 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.
358 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]359 "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.
360 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
361 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
362 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]363 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]364 },
365 ],
366 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]367 "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.
368 "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]369 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]370 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]371 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]372 }</pre>
373</div>
374
375<div class="method">
376 <code class="details" id="get">get(projectId, clusterName, x__xgafv=None)</code>
377 <pre>Gets the resource representation for a cluster in a project.
378
379Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]380 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
381 clusterName: string, Required The cluster name. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]382 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]383 Allowed values
384 1 - v1 error format
385 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]386
387Returns:
388 An object of the form:
389
390 { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]391 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]392 "state": "A String", # The cluster's state.
393 "stateStartTime": "A String", # Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]394 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]395 "detail": "A String", # Optional details of cluster's state.
396 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]397 "configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
398 "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
399 "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).
400 "properties": { # Optional The properties to set on daemon configuration 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
401 "a_key": "A String",
402 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]403 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]404 "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine configuration settings for all instances in a cluster.
405 "internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
406 "networkUri": "A String", # 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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
407 "tags": [ # The Google Compute Engine tags to add to all instances.
408 "A String",
409 ],
410 "serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
411 # roles/logging.logWriter
412 # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
413 "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].
414 "subnetworkUri": "A String", # 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.
415 "serviceAccountScopes": [ # 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 specfied, 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
416 "A String",
417 ],
418 "metadata": { # The Google Compute Engine metadata entries to add to all instances.
419 "a_key": "A String",
420 },
421 },
422 "configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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.
423 "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
424 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
425 "machineTypeUri": "A String", # 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.
426 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
427 "A String",
428 ],
429 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
430 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
431 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
432 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
433 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
434 },
435 ],
436 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
437 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
438 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
439 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
440 },
441 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
442 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
443 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
444 },
445 },
446 "initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
447 # ROLE=$(/usr/share/google/get_metadata_value attributes/role)
448 # if [[ "${ROLE}" == 'Master' ]]; then
449 # ... master specific actions ...
450 # else
451 # ... worker specific actions ...
452 # fi
453 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
454 "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.
455 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
456 },
457 ],
458 "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
459 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
460 "machineTypeUri": "A String", # 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.
461 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
462 "A String",
463 ],
464 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
465 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
466 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
467 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
468 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
469 },
470 ],
471 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
472 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
473 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
474 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
475 },
476 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
477 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
478 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
479 },
480 },
481 "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
482 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
483 "machineTypeUri": "A String", # 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.
484 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
485 "A String",
486 ],
487 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
488 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
489 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
490 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
491 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
492 },
493 ],
494 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
495 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
496 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
497 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
498 },
499 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
500 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
501 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
502 },
503 },
504 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]505 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
506 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
507 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
508 "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
509 "a_key": "A String",
510 },
511 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
512 "yarnMetrics": { # The YARN metrics.
513 "a_key": "A String",
514 },
515 "hdfsMetrics": { # The HDFS metrics.
516 "a_key": "A String",
517 },
518 },
519 "statusHistory": [ # Output-only Previous cluster statuses.
520 { # The status of a cluster and its instances.
521 "state": "A String", # The cluster's state.
522 "stateStartTime": "A String", # Time when this state was entered.
523 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
524 "detail": "A String", # Optional details of cluster's state.
525 },
526 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]527 }</pre>
528</div>
529
530<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]531 <code class="details" id="list">list(projectId, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]532 <pre>Lists all clusters in a project.
533
534Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]535 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]536 pageSize: integer, The standard List page size.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]537 filter: string, Optional A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]538 pageToken: string, The standard List page token.
539 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]540 Allowed values
541 1 - v1 error format
542 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]543
544Returns:
545 An object of the form:
546
547 { # The list of all clusters in a project.
548 "nextPageToken": "A String", # The standard List next-page token.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]549 "clusters": [ # Output-only The clusters in the project.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]550 { # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]551 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]552 "state": "A String", # The cluster's state.
553 "stateStartTime": "A String", # Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]554 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]555 "detail": "A String", # Optional details of cluster's state.
556 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]557 "configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
558 "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
559 "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).
560 "properties": { # Optional The properties to set on daemon configuration 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
561 "a_key": "A String",
562 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]563 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]564 "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine configuration settings for all instances in a cluster.
565 "internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
566 "networkUri": "A String", # 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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
567 "tags": [ # The Google Compute Engine tags to add to all instances.
568 "A String",
569 ],
570 "serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
571 # roles/logging.logWriter
572 # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
573 "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].
574 "subnetworkUri": "A String", # 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.
575 "serviceAccountScopes": [ # 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 specfied, 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
576 "A String",
577 ],
578 "metadata": { # The Google Compute Engine metadata entries to add to all instances.
579 "a_key": "A String",
580 },
581 },
582 "configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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.
583 "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
584 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
585 "machineTypeUri": "A String", # 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.
586 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
587 "A String",
588 ],
589 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
590 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
591 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
592 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
593 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
594 },
595 ],
596 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
597 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
598 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
599 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
600 },
601 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
602 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
603 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
604 },
605 },
606 "initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
607 # ROLE=$(/usr/share/google/get_metadata_value attributes/role)
608 # if [[ "${ROLE}" == 'Master' ]]; then
609 # ... master specific actions ...
610 # else
611 # ... worker specific actions ...
612 # fi
613 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
614 "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.
615 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
616 },
617 ],
618 "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
619 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
620 "machineTypeUri": "A String", # 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.
621 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
622 "A String",
623 ],
624 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
625 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
626 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
627 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
628 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
629 },
630 ],
631 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
632 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
633 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
634 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
635 },
636 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
637 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
638 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
639 },
640 },
641 "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
642 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
643 "machineTypeUri": "A String", # 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.
644 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
645 "A String",
646 ],
647 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
648 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
649 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
650 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
651 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
652 },
653 ],
654 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
655 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration 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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
657 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
658 },
659 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration 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 },
663 },
664 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]665 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
666 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
667 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
668 "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
669 "a_key": "A String",
670 },
671 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
672 "yarnMetrics": { # The YARN metrics.
673 "a_key": "A String",
674 },
675 "hdfsMetrics": { # The HDFS metrics.
676 "a_key": "A String",
677 },
678 },
679 "statusHistory": [ # Output-only Previous cluster statuses.
680 { # The status of a cluster and its instances.
681 "state": "A String", # The cluster's state.
682 "stateStartTime": "A String", # Time when this state was entered.
683 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
684 "detail": "A String", # Optional details of cluster's state.
685 },
686 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]687 },
688 ],
689 }</pre>
690</div>
691
692<div class="method">
693 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
694 <pre>Retrieves the next page of results.
695
696Args:
697 previous_request: The request for the previous page. (required)
698 previous_response: The response from the request for the previous page. (required)
699
700Returns:
701 A request object that you can call 'execute()' on to request the next
702 page. Returns None if there are no more items in the collection.
703 </pre>
704</div>
705
706<div class="method">
707 <code class="details" id="patch">patch(projectId, clusterName, body, updateMask=None, x__xgafv=None)</code>
708 <pre>Updates a cluster in a project.
709
710Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]711 projectId: string, Required The ID of the Google Cloud Platform project the cluster belongs to. (required)
712 clusterName: string, Required The cluster name. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]713 body: object, The request body. (required)
714 The object takes the form of:
715
716{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]717 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]718 "state": "A String", # The cluster's state.
719 "stateStartTime": "A String", # Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]720 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]721 "detail": "A String", # Optional details of cluster's state.
722 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]723 "configuration": { # The cluster configuration. # Required The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
724 "softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # Optional The configuration settings for software inside the cluster.
725 "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).
726 "properties": { # Optional The properties to set on daemon configuration 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
727 "a_key": "A String",
728 },
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]729 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]730 "gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine configuration settings for all instances in a cluster.
731 "internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
732 "networkUri": "A String", # 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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
733 "tags": [ # The Google Compute Engine tags to add to all instances.
734 "A String",
735 ],
736 "serviceAccount": "A String", # Optional The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:
737 # roles/logging.logWriter
738 # roles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com
739 "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].
740 "subnetworkUri": "A String", # 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.
741 "serviceAccountScopes": [ # 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 specfied, 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
742 "A String",
743 ],
744 "metadata": { # The Google Compute Engine metadata entries to add to all instances.
745 "a_key": "A String",
746 },
747 },
748 "configurationBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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.
749 "masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for the master instance in a cluster.
750 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
751 "machineTypeUri": "A String", # 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.
752 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
753 "A String",
754 ],
755 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
756 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
757 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
758 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
759 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
760 },
761 ],
762 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
763 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
764 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
765 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
766 },
767 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
768 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
769 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
770 },
771 },
772 "initializationActions": [ # Optional Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below:
773 # ROLE=$(/usr/share/google/get_metadata_value attributes/role)
774 # if [[ "${ROLE}" == 'Master' ]]; then
775 # ... master specific actions ...
776 # else
777 # ... worker specific actions ...
778 # fi
779 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
780 "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.
781 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
782 },
783 ],
784 "secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for additional worker instances in a cluster.
785 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
786 "machineTypeUri": "A String", # 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.
787 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
788 "A String",
789 ],
790 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
791 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
792 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
793 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
794 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
795 },
796 ],
797 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
798 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
799 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
800 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
801 },
802 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
803 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
804 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
805 },
806 },
807 "workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine configuration settings for worker instances in a cluster.
808 "isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
809 "machineTypeUri": "A String", # 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.
810 "instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
811 "A String",
812 ],
813 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version.
814 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.
815 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
816 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
817 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
818 },
819 ],
820 "numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
821 "diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
822 "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 data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
823 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
824 },
825 "managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # Output-only The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
826 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
827 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
828 },
829 },
830 },
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame^]831 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
832 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
833 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
834 "labels": { # Optional The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.
835 "a_key": "A String",
836 },
837 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
838 "yarnMetrics": { # The YARN metrics.
839 "a_key": "A String",
840 },
841 "hdfsMetrics": { # The HDFS metrics.
842 "a_key": "A String",
843 },
844 },
845 "statusHistory": [ # Output-only Previous cluster statuses.
846 { # The status of a cluster and its instances.
847 "state": "A String", # The cluster's state.
848 "stateStartTime": "A String", # Time when this state was entered.
849 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
850 "detail": "A String", # Optional details of cluster's state.
851 },
852 ],
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]853}
854
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]855 updateMask: string, Required Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to change the number of workers in a cluster to 5, the <code>update_mask</code> parameter would be specified as <code>configuration.worker_configuration.num_instances</code>, and the PATCH request body would specify the new value, as follows:
856{
857 "configuration":{
858 "workerConfiguration":{
859 "numInstances":"5"
860 }
861 }
862}
863Similarly, to change the number of preemptible workers in a cluster to 5, the <code>update_mask</code> parameter would be <code>config.secondary_worker_config.num_instances</code>, and the PATCH request body would be set as follows:
864{
865 "config":{
866 "secondaryWorkerConfig":{
867 "numInstances":"5"
868 }
869 }
870}
871<strong>Note:</strong> Currently, <code>config.worker_config.num_instances</code> and <code>config.secondary_worker_config.num_instances</code> are the only fields that can be updated.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]872 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]873 Allowed values
874 1 - v1 error format
875 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]876
877Returns:
878 An object of the form:
879
880 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]881 "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]882 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]883 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]884 "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: # The error result of the operation in case of failure or cancellation.
885 # Simple to use and understand for most users
886 # Flexible enough to meet unexpected needsOverviewThe 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 mappingThe 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 usesThe 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:
887 # 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.
888 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
889 # 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.
890 # 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.
891 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]892 "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.
893 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
894 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
895 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]896 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]897 },
898 ],
899 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]900 "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.
901 "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]902 "a_key": "", # Properties of the object. Contains field @type with type URL.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]903 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]904 "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.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]905 }</pre>
906</div>
907
908</body></html>