blob: 206a72b7c11ff561ef7bec2d091905addb6b8824 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -08001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectId, region, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a cluster in a project.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, clusterName, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a cluster in a project.</p>
83<p class="toc_element">
84 <code><a href="#diagnose">diagnose(projectId, region, clusterName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -040085<p class="firstline">Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080086<p class="toc_element">
87 <code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the resource representation for a cluster in a project.</p>
89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -080090 <code><a href="#list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -080091<p class="firstline">Lists all regions/{region}/clusters in a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a cluster in a project.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
101 <pre>Creates a cluster in a project.
102
103Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400104 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
105 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400110 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
111 "state": "A String", # Output-only The cluster's state.
112 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700113 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400114 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800115 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400116 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
117 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
118 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
119 "labels": { # Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800120 "a_key": "A String",
121 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400122 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800123 "yarnMetrics": { # The YARN metrics.
124 "a_key": "A String",
125 },
126 "hdfsMetrics": { # The HDFS metrics.
127 "a_key": "A String",
128 },
129 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400130 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800131 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400132 "state": "A String", # Output-only The cluster's state.
133 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700134 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400135 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800136 },
137 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400138 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
139 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
140 "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).
141 "properties": { # Optional The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:
142 # core: core-site.xml
143 # hdfs: hdfs-site.xml
144 # mapred: mapred-site.xml
145 # yarn: yarn-site.xml
146 # hive: hive-site.xml
147 # pig: pig.properties
148 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800149 "a_key": "A String",
150 },
151 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400152 "configBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
153 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine config settings for all instances in a cluster.
154 "internalIpOnly": True or False, # Optional If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
155 "networkUri": "A String", # Optional The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
156 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800157 "A String",
158 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400159 "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:
160 # roles/logging.logWriter
161 # 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
162 "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].
163 "subnetworkUri": "A String", # Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.
164 "serviceAccountScopes": [ # Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:
165 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
166 # https://www.googleapis.com/auth/devstorage.read_write
167 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
168 # https://www.googleapis.com/auth/bigquery
169 # https://www.googleapis.com/auth/bigtable.admin.table
170 # https://www.googleapis.com/auth/bigtable.data
171 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800172 "A String",
173 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400174 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800175 "a_key": "A String",
176 },
177 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400178 "workerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for worker instances in a cluster.
179 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
180 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
181 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800182 "A String",
183 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400184 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
185 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
186 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
187 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
188 "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)
189 },
190 ],
191 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
192 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
193 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800194 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400195 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
196 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
197 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
198 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800199 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800200 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400201 "initializationActions": [ # Optional Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
202 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
203 # if [[ "${ROLE}" == 'Master' ]]; then
204 # ... master specific actions ...
205 # else
206 # ... worker specific actions ...
207 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800208 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400209 "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.
210 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800211 },
212 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400213 "secondaryWorkerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for additional worker instances in a cluster.
214 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
215 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
216 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800217 "A String",
218 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400219 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
220 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
221 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
222 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
223 "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)
224 },
225 ],
226 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
227 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
228 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800229 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400230 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
231 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
232 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
233 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800234 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800235 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400236 "masterConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for the master instance in a cluster.
237 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
238 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
239 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800240 "A String",
241 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400242 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
243 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
244 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
245 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
246 "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)
247 },
248 ],
249 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
250 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
251 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800252 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400253 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
254 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
255 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
256 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800257 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800258 },
259 },
260}
261
262 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400263 Allowed values
264 1 - v1 error format
265 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800266
267Returns:
268 An object of the form:
269
270 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400271 "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 -0800272 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800273 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400274 "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.
275 # Simple to use and understand for most users
276 # 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:
277 # 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.
278 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
279 # 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.
280 # 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.
281 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800282 "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.
283 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
284 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
285 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800286 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800287 },
288 ],
289 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400290 "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.
291 "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 -0800292 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800293 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400294 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800295 }</pre>
296</div>
297
298<div class="method">
299 <code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
300 <pre>Deletes a cluster in a project.
301
302Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400303 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
304 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
305 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800306 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400307 Allowed values
308 1 - v1 error format
309 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800310
311Returns:
312 An object of the form:
313
314 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400315 "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 -0800316 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800317 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400318 "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.
319 # Simple to use and understand for most users
320 # 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:
321 # 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.
322 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
323 # 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.
324 # 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.
325 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800326 "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.
327 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
328 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
329 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800330 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800331 },
332 ],
333 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400334 "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.
335 "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 -0800336 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800337 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400338 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800339 }</pre>
340</div>
341
342<div class="method">
343 <code class="details" id="diagnose">diagnose(projectId, region, clusterName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400344 <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800345
346Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400347 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
348 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
349 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800350 body: object, The request body. (required)
351 The object takes the form of:
352
353{ # A request to collect cluster diagnostic information.
354 }
355
356 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400357 Allowed values
358 1 - v1 error format
359 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800360
361Returns:
362 An object of the form:
363
364 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400365 "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 -0800366 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800367 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400368 "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.
369 # Simple to use and understand for most users
370 # 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:
371 # 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.
372 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
373 # 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.
374 # 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.
375 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800376 "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.
377 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
378 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
379 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800380 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800381 },
382 ],
383 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400384 "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.
385 "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 -0800386 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800387 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400388 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800389 }</pre>
390</div>
391
392<div class="method">
393 <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
394 <pre>Gets the resource representation for a cluster in a project.
395
396Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400397 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
398 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
399 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800400 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400401 Allowed values
402 1 - v1 error format
403 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800404
405Returns:
406 An object of the form:
407
408 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400409 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
410 "state": "A String", # Output-only The cluster's state.
411 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700412 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400413 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800414 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400415 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
416 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
417 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
418 "labels": { # Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800419 "a_key": "A String",
420 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400421 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800422 "yarnMetrics": { # The YARN metrics.
423 "a_key": "A String",
424 },
425 "hdfsMetrics": { # The HDFS metrics.
426 "a_key": "A String",
427 },
428 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400429 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800430 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400431 "state": "A String", # Output-only The cluster's state.
432 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700433 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400434 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800435 },
436 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400437 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
438 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
439 "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).
440 "properties": { # Optional The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:
441 # core: core-site.xml
442 # hdfs: hdfs-site.xml
443 # mapred: mapred-site.xml
444 # yarn: yarn-site.xml
445 # hive: hive-site.xml
446 # pig: pig.properties
447 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800448 "a_key": "A String",
449 },
450 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400451 "configBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
452 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine config settings for all instances in a cluster.
453 "internalIpOnly": True or False, # Optional If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
454 "networkUri": "A String", # Optional The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
455 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800456 "A String",
457 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400458 "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:
459 # roles/logging.logWriter
460 # 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
461 "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].
462 "subnetworkUri": "A String", # Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.
463 "serviceAccountScopes": [ # Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:
464 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
465 # https://www.googleapis.com/auth/devstorage.read_write
466 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
467 # https://www.googleapis.com/auth/bigquery
468 # https://www.googleapis.com/auth/bigtable.admin.table
469 # https://www.googleapis.com/auth/bigtable.data
470 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800471 "A String",
472 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400473 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800474 "a_key": "A String",
475 },
476 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400477 "workerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for worker instances in a cluster.
478 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
479 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
480 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800481 "A String",
482 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400483 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
484 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
485 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
486 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
487 "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)
488 },
489 ],
490 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
491 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
492 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800493 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400494 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
495 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config 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 (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
497 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800498 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800499 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400500 "initializationActions": [ # Optional Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
501 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
502 # if [[ "${ROLE}" == 'Master' ]]; then
503 # ... master specific actions ...
504 # else
505 # ... worker specific actions ...
506 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800507 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400508 "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.
509 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800510 },
511 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400512 "secondaryWorkerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for additional worker instances in a cluster.
513 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
514 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
515 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800516 "A String",
517 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400518 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
519 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
520 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
521 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
522 "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)
523 },
524 ],
525 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
526 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
527 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800528 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400529 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
530 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
531 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
532 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800533 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800534 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400535 "masterConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for the master instance in a cluster.
536 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
537 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
538 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800539 "A String",
540 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400541 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
542 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
543 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
544 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
545 "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)
546 },
547 ],
548 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
549 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
550 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800551 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400552 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
553 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
554 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
555 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800556 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800557 },
558 },
559 }</pre>
560</div>
561
562<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800563 <code class="details" id="list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800564 <pre>Lists all regions/{region}/clusters in a project.
565
566Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400567 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
568 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
569 pageSize: integer, Optional The standard List page size.
570 filter: string, Optional A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *
571 pageToken: string, Optional The standard List page token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800572 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400573 Allowed values
574 1 - v1 error format
575 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800576
577Returns:
578 An object of the form:
579
580 { # The list of all clusters in a project.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400581 "nextPageToken": "A String", # Output-only This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListClustersRequest</code>.
582 "clusters": [ # Output-only The clusters in the project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800583 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400584 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
585 "state": "A String", # Output-only The cluster's state.
586 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700587 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400588 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800589 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400590 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
591 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
592 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
593 "labels": { # Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800594 "a_key": "A String",
595 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400596 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800597 "yarnMetrics": { # The YARN metrics.
598 "a_key": "A String",
599 },
600 "hdfsMetrics": { # The HDFS metrics.
601 "a_key": "A String",
602 },
603 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400604 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800605 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400606 "state": "A String", # Output-only The cluster's state.
607 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700608 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400609 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800610 },
611 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400612 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
613 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
614 "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).
615 "properties": { # Optional The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:
616 # core: core-site.xml
617 # hdfs: hdfs-site.xml
618 # mapred: mapred-site.xml
619 # yarn: yarn-site.xml
620 # hive: hive-site.xml
621 # pig: pig.properties
622 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800623 "a_key": "A String",
624 },
625 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400626 "configBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
627 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine config settings for all instances in a cluster.
628 "internalIpOnly": True or False, # Optional If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
629 "networkUri": "A String", # Optional The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
630 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800631 "A String",
632 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400633 "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:
634 # roles/logging.logWriter
635 # 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
636 "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].
637 "subnetworkUri": "A String", # Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.
638 "serviceAccountScopes": [ # Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:
639 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
640 # https://www.googleapis.com/auth/devstorage.read_write
641 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
642 # https://www.googleapis.com/auth/bigquery
643 # https://www.googleapis.com/auth/bigtable.admin.table
644 # https://www.googleapis.com/auth/bigtable.data
645 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800646 "A String",
647 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400648 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800649 "a_key": "A String",
650 },
651 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400652 "workerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for worker instances in a cluster.
653 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
654 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
655 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800656 "A String",
657 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400658 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
659 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
660 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
661 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
662 "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)
663 },
664 ],
665 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
666 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
667 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800668 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400669 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
670 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
671 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
672 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800673 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800674 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400675 "initializationActions": [ # Optional Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
676 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
677 # if [[ "${ROLE}" == 'Master' ]]; then
678 # ... master specific actions ...
679 # else
680 # ... worker specific actions ...
681 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800682 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400683 "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.
684 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800685 },
686 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400687 "secondaryWorkerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for additional worker instances in a cluster.
688 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
689 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
690 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800691 "A String",
692 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400693 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
694 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
695 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
696 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
697 "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)
698 },
699 ],
700 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
701 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
702 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800703 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400704 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
705 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
706 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
707 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800708 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800709 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400710 "masterConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for the master instance in a cluster.
711 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
712 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
713 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800714 "A String",
715 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400716 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
717 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
718 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
719 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
720 "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)
721 },
722 ],
723 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
724 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
725 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800726 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400727 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
728 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
729 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
730 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800731 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800732 },
733 },
734 },
735 ],
736 }</pre>
737</div>
738
739<div class="method">
740 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
741 <pre>Retrieves the next page of results.
742
743Args:
744 previous_request: The request for the previous page. (required)
745 previous_response: The response from the request for the previous page. (required)
746
747Returns:
748 A request object that you can call 'execute()' on to request the next
749 page. Returns None if there are no more items in the collection.
750 </pre>
751</div>
752
753<div class="method">
754 <code class="details" id="patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
755 <pre>Updates a cluster in a project.
756
757Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400758 projectId: string, Required The ID of the Google Cloud Platform project the cluster belongs to. (required)
759 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
760 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800761 body: object, The request body. (required)
762 The object takes the form of:
763
764{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400765 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
766 "state": "A String", # Output-only The cluster's state.
767 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700768 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400769 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800770 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400771 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
772 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
773 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
774 "labels": { # Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800775 "a_key": "A String",
776 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400777 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800778 "yarnMetrics": { # The YARN metrics.
779 "a_key": "A String",
780 },
781 "hdfsMetrics": { # The HDFS metrics.
782 "a_key": "A String",
783 },
784 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400785 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800786 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400787 "state": "A String", # Output-only The cluster's state.
788 "stateStartTime": "A String", # Output-only Time when this state was entered.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700789 "substate": "A String", # Output-only Additional state information that includes status reported by the agent.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400790 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800791 },
792 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400793 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
794 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
795 "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).
796 "properties": { # Optional The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:
797 # core: core-site.xml
798 # hdfs: hdfs-site.xml
799 # mapred: mapred-site.xml
800 # yarn: yarn-site.xml
801 # hive: hive-site.xml
802 # pig: pig.properties
803 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800804 "a_key": "A String",
805 },
806 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400807 "configBucket": "A String", # Optional A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.
808 "gceClusterConfig": { # Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # Required The shared Google Compute Engine config settings for all instances in a cluster.
809 "internalIpOnly": True or False, # Optional If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
810 "networkUri": "A String", # Optional The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks for more information). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.
811 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800812 "A String",
813 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400814 "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:
815 # roles/logging.logWriter
816 # 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
817 "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].
818 "subnetworkUri": "A String", # Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.
819 "serviceAccountScopes": [ # Optional The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:
820 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
821 # https://www.googleapis.com/auth/devstorage.read_write
822 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
823 # https://www.googleapis.com/auth/bigquery
824 # https://www.googleapis.com/auth/bigtable.admin.table
825 # https://www.googleapis.com/auth/bigtable.data
826 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800827 "A String",
828 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400829 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800830 "a_key": "A String",
831 },
832 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400833 "workerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for worker instances in a cluster.
834 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
835 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
836 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800837 "A String",
838 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400839 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
840 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
841 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
842 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
843 "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)
844 },
845 ],
846 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
847 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
848 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800849 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400850 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
851 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
852 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
853 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800854 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800855 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400856 "initializationActions": [ # Optional Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
857 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
858 # if [[ "${ROLE}" == 'Master' ]]; then
859 # ... master specific actions ...
860 # else
861 # ... worker specific actions ...
862 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800863 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400864 "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.
865 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800866 },
867 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400868 "secondaryWorkerConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for additional worker instances in a cluster.
869 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
870 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
871 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800872 "A String",
873 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400874 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
875 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
876 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
877 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
878 "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)
879 },
880 ],
881 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
882 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
883 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800884 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400885 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
886 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
887 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
888 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800889 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800890 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400891 "masterConfig": { # Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group. # Optional The Google Compute Engine config settings for the master instance in a cluster.
892 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
893 "machineTypeUri": "A String", # Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.
894 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800895 "A String",
896 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400897 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
898 "accelerators": [ # Optional The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.
899 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
900 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
901 "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)
902 },
903 ],
904 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
905 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
906 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800907 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400908 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
909 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
910 "numLocalSsds": 42, # Optional Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
911 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800912 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800913 },
914 },
915}
916
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400917 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>config.worker_config.num_instances</code>, and the PATCH request body would specify the new value, as follows:
918{
919 "config":{
920 "workerConfig":{
921 "numInstances":"5"
922 }
923 }
924}
925Similarly, 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:
926{
927 "config":{
928 "secondaryWorkerConfig":{
929 "numInstances":"5"
930 }
931 }
932}
933<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.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800934 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400935 Allowed values
936 1 - v1 error format
937 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800938
939Returns:
940 An object of the form:
941
942 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400943 "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 -0800944 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800945 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400946 "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.
947 # Simple to use and understand for most users
948 # 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:
949 # 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.
950 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
951 # 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.
952 # 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.
953 # Logging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800954 "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.
955 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
956 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
957 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800958 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800959 },
960 ],
961 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400962 "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.
963 "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 -0800964 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800965 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400966 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800967 }</pre>
968</div>
969
970</body></html>