Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / c30d2b5d4478b230246dcaaa9f1c533ca3304387 / . / docs / dyn / dataproc_v1.projects.regions.clusters.html
blob: c3b7e95c78519be1d88300c9b5d57d5883e29f5e [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="dataproc_v1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1.projects.html">projects</a> . <a href="dataproc_v1.projects.regions.html">regions</a> . <a href="dataproc_v1.projects.regions.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#create">create(projectId, region, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a cluster in a project.</p>
80<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, clusterName, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a cluster in a project.</p>
83<p class="toc_element">
84 <code><a href="#diagnose">diagnose(projectId, region, clusterName, body, x__xgafv=None)</a></code></p>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]85<p class="firstline">Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.</p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
88<p class="firstline">Gets the resource representation for a cluster in a project.</p>
89<p class="toc_element">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]90 <code><a href="#list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]91<p class="firstline">Lists all regions/{region}/clusters in a project.</p>
92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
96 <code><a href="#patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
97<p class="firstline">Updates a cluster in a project.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
101 <pre>Creates a cluster in a project.
102
103Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]104 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
105 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]106 body: object, The request body. (required)
107 The object takes the form of:
108
109{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]110 "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.
113 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]114 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]115 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
116 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
117 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
118 "labels": { # Optional The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]119 "a_key": "A String",
120 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]121 "metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]122 "yarnMetrics": { # The YARN metrics.
123 "a_key": "A String",
124 },
125 "hdfsMetrics": { # The HDFS metrics.
126 "a_key": "A String",
127 },
128 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]129 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]130 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]131 "state": "A String", # Output-only The cluster's state.
132 "stateStartTime": "A String", # Output-only Time when this state was entered.
133 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]134 },
135 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]136 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
137 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
138 "imageVersion": "A String", # Optional The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).
139 "properties": { # Optional The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:
140 # core: core-site.xml
141 # hdfs: hdfs-site.xml
142 # mapred: mapred-site.xml
143 # yarn: yarn-site.xml
144 # hive: hive-site.xml
145 # pig: pig.properties
146 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]147 "a_key": "A String",
148 },
149 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]150 "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.
151 "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.
152 "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.
153 "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.
154 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]155 "A String",
156 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]157 "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:
158 # roles/logging.logWriter
159 # 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
160 "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].
161 "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.
162 "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:
163 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
164 # https://www.googleapis.com/auth/devstorage.read_write
165 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
166 # https://www.googleapis.com/auth/bigquery
167 # https://www.googleapis.com/auth/bigtable.admin.table
168 # https://www.googleapis.com/auth/bigtable.data
169 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]170 "A String",
171 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]172 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]173 "a_key": "A String",
174 },
175 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]176 "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.
177 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
178 "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.
179 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]180 "A String",
181 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]182 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
183 "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.
184 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
185 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
186 "acceleratorTypeUri": "A String", # Full or partial URI of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)
187 },
188 ],
189 "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.
190 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
191 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]192 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]193 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
194 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
195 "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.
196 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]197 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]198 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]199 "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):
200 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
201 # if [[ "${ROLE}" == 'Master' ]]; then
202 # ... master specific actions ...
203 # else
204 # ... worker specific actions ...
205 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]206 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]207 "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.
208 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]209 },
210 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]211 "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.
212 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
213 "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.
214 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]215 "A String",
216 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]217 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
218 "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.
219 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
220 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
221 "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)
222 },
223 ],
224 "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.
225 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
226 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]227 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]228 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
229 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
230 "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.
231 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]232 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]233 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]234 "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.
235 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
236 "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.
237 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]238 "A String",
239 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]240 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
241 "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.
242 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
243 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
244 "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)
245 },
246 ],
247 "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.
248 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
249 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]250 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]251 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
252 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
253 "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.
254 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]255 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]256 },
257 },
258}
259
260 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]264
265Returns:
266 An object of the form:
267
268 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]269 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]270 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]271 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]272 "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.
273 # Simple to use and understand for most users
274 # 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:
275 # 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.
276 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
277 # 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.
278 # 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.
279 # 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 -0800[diff] [blame]280 "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.
281 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
282 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
283 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]284 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]285 },
286 ],
287 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]288 "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.
289 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]290 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]291 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]292 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]293 }</pre>
294</div>
295
296<div class="method">
297 <code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
298 <pre>Deletes a cluster in a project.
299
300Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]301 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
302 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
303 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]304 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]305 Allowed values
306 1 - v1 error format
307 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]308
309Returns:
310 An object of the form:
311
312 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]313 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]314 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]315 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]316 "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.
317 # Simple to use and understand for most users
318 # 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:
319 # 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.
320 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
321 # 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.
322 # 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.
323 # 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 -0800[diff] [blame]324 "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.
325 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
326 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
327 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]328 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]329 },
330 ],
331 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]332 "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.
333 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]334 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]335 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]336 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]337 }</pre>
338</div>
339
340<div class="method">
341 <code class="details" id="diagnose">diagnose(projectId, region, clusterName, body, x__xgafv=None)</code>
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]342 <pre>Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]343
344Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]345 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
346 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
347 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]348 body: object, The request body. (required)
349 The object takes the form of:
350
351{ # A request to collect cluster diagnostic information.
352 }
353
354 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]355 Allowed values
356 1 - v1 error format
357 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]358
359Returns:
360 An object of the form:
361
362 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]363 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]364 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]365 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]366 "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.
367 # Simple to use and understand for most users
368 # 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:
369 # 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.
370 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
371 # 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.
372 # 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.
373 # 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 -0800[diff] [blame]374 "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.
375 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
376 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
377 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]378 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]379 },
380 ],
381 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]382 "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.
383 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]384 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]385 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]386 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]387 }</pre>
388</div>
389
390<div class="method">
391 <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
392 <pre>Gets the resource representation for a cluster in a project.
393
394Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]395 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
396 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
397 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]398 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]399 Allowed values
400 1 - v1 error format
401 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]402
403Returns:
404 An object of the form:
405
406 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]407 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
408 "state": "A String", # Output-only The cluster's state.
409 "stateStartTime": "A String", # Output-only Time when this state was entered.
410 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]411 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]412 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
413 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
414 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
415 "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 -0800[diff] [blame]416 "a_key": "A String",
417 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]418 "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 -0800[diff] [blame]419 "yarnMetrics": { # The YARN metrics.
420 "a_key": "A String",
421 },
422 "hdfsMetrics": { # The HDFS metrics.
423 "a_key": "A String",
424 },
425 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]426 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]427 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]428 "state": "A String", # Output-only The cluster's state.
429 "stateStartTime": "A String", # Output-only Time when this state was entered.
430 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]431 },
432 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]433 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
434 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
435 "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).
436 "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:
437 # core: core-site.xml
438 # hdfs: hdfs-site.xml
439 # mapred: mapred-site.xml
440 # yarn: yarn-site.xml
441 # hive: hive-site.xml
442 # pig: pig.properties
443 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]444 "a_key": "A String",
445 },
446 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]447 "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.
448 "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.
449 "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.
450 "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.
451 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]452 "A String",
453 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]454 "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:
455 # roles/logging.logWriter
456 # 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
457 "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].
458 "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.
459 "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:
460 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
461 # https://www.googleapis.com/auth/devstorage.read_write
462 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
463 # https://www.googleapis.com/auth/bigquery
464 # https://www.googleapis.com/auth/bigtable.admin.table
465 # https://www.googleapis.com/auth/bigtable.data
466 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]467 "A String",
468 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]469 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]470 "a_key": "A String",
471 },
472 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]473 "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.
474 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
475 "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.
476 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]477 "A String",
478 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]479 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
480 "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.
481 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
482 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
483 "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)
484 },
485 ],
486 "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.
487 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
488 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]489 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]490 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
491 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
492 "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.
493 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]494 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]495 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]496 "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):
497 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
498 # if [[ "${ROLE}" == 'Master' ]]; then
499 # ... master specific actions ...
500 # else
501 # ... worker specific actions ...
502 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]503 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]504 "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.
505 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]506 },
507 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]508 "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.
509 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
510 "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.
511 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]512 "A String",
513 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]514 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
515 "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.
516 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
517 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
518 "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)
519 },
520 ],
521 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
522 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
523 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]524 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]525 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
526 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
527 "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.
528 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]529 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]530 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]531 "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.
532 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
533 "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.
534 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]535 "A String",
536 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]537 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
538 "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.
539 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
540 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
541 "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)
542 },
543 ],
544 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
545 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
546 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]547 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]548 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
549 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
550 "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.
551 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]552 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]553 },
554 },
555 }</pre>
556</div>
557
558<div class="method">
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]559 <code class="details" id="list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]560 <pre>Lists all regions/{region}/clusters in a project.
561
562Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]563 projectId: string, Required The ID of the Google Cloud Platform project that the cluster belongs to. (required)
564 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
565 pageSize: integer, Optional The standard List page size.
566 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 = *
567 pageToken: string, Optional The standard List page token.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]568 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]569 Allowed values
570 1 - v1 error format
571 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]572
573Returns:
574 An object of the form:
575
576 { # The list of all clusters in a project.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]577 "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>.
578 "clusters": [ # Output-only The clusters in the project.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]579 { # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]580 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
581 "state": "A String", # Output-only The cluster's state.
582 "stateStartTime": "A String", # Output-only Time when this state was entered.
583 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]584 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]585 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
586 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
587 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
588 "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 -0800[diff] [blame]589 "a_key": "A String",
590 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]591 "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 -0800[diff] [blame]592 "yarnMetrics": { # The YARN metrics.
593 "a_key": "A String",
594 },
595 "hdfsMetrics": { # The HDFS metrics.
596 "a_key": "A String",
597 },
598 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]599 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]600 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]601 "state": "A String", # Output-only The cluster's state.
602 "stateStartTime": "A String", # Output-only Time when this state was entered.
603 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]604 },
605 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]606 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
607 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
608 "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).
609 "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:
610 # core: core-site.xml
611 # hdfs: hdfs-site.xml
612 # mapred: mapred-site.xml
613 # yarn: yarn-site.xml
614 # hive: hive-site.xml
615 # pig: pig.properties
616 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]617 "a_key": "A String",
618 },
619 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]620 "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.
621 "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.
622 "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.
623 "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.
624 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]625 "A String",
626 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]627 "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:
628 # roles/logging.logWriter
629 # 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
630 "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].
631 "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.
632 "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:
633 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
634 # https://www.googleapis.com/auth/devstorage.read_write
635 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
636 # https://www.googleapis.com/auth/bigquery
637 # https://www.googleapis.com/auth/bigtable.admin.table
638 # https://www.googleapis.com/auth/bigtable.data
639 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]640 "A String",
641 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]642 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]643 "a_key": "A String",
644 },
645 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]646 "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.
647 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
648 "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.
649 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]650 "A String",
651 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]652 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
653 "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.
654 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
655 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
656 "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)
657 },
658 ],
659 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output-only The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
660 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
661 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]662 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]663 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
664 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
665 "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.
666 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]667 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]668 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]669 "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):
670 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
671 # if [[ "${ROLE}" == 'Master' ]]; then
672 # ... master specific actions ...
673 # else
674 # ... worker specific actions ...
675 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]676 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]677 "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.
678 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]679 },
680 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]681 "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.
682 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
683 "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.
684 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]685 "A String",
686 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]687 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
688 "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.
689 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
690 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
691 "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)
692 },
693 ],
694 "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.
695 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
696 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]697 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]698 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
699 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
700 "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.
701 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]702 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]703 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]704 "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.
705 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
706 "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.
707 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]708 "A String",
709 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]710 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
711 "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.
712 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
713 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
714 "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)
715 },
716 ],
717 "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.
718 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
719 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]720 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]721 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
722 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
723 "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.
724 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]725 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]726 },
727 },
728 },
729 ],
730 }</pre>
731</div>
732
733<div class="method">
734 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
735 <pre>Retrieves the next page of results.
736
737Args:
738 previous_request: The request for the previous page. (required)
739 previous_response: The response from the request for the previous page. (required)
740
741Returns:
742 A request object that you can call 'execute()' on to request the next
743 page. Returns None if there are no more items in the collection.
744 </pre>
745</div>
746
747<div class="method">
748 <code class="details" id="patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
749 <pre>Updates a cluster in a project.
750
751Args:
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]752 projectId: string, Required The ID of the Google Cloud Platform project the cluster belongs to. (required)
753 region: string, Required The Cloud Dataproc region in which to handle the request. (required)
754 clusterName: string, Required The cluster name. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]755 body: object, The request body. (required)
756 The object takes the form of:
757
758{ # Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]759 "status": { # The status of a cluster and its instances. # Output-only Cluster status.
760 "state": "A String", # Output-only The cluster's state.
761 "stateStartTime": "A String", # Output-only Time when this state was entered.
762 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]763 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]764 "clusterUuid": "A String", # Output-only A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
765 "clusterName": "A String", # Required The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
766 "projectId": "A String", # Required The Google Cloud Platform project ID that the cluster belongs to.
767 "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 -0800[diff] [blame]768 "a_key": "A String",
769 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]770 "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 -0800[diff] [blame]771 "yarnMetrics": { # The YARN metrics.
772 "a_key": "A String",
773 },
774 "hdfsMetrics": { # The HDFS metrics.
775 "a_key": "A String",
776 },
777 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]778 "statusHistory": [ # Output-only The previous cluster status.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]779 { # The status of a cluster and its instances.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]780 "state": "A String", # Output-only The cluster's state.
781 "stateStartTime": "A String", # Output-only Time when this state was entered.
782 "detail": "A String", # Output-only Optional details of cluster's state.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]783 },
784 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]785 "config": { # The cluster config. # Required The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
786 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional The config settings for software inside the cluster.
787 "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).
788 "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:
789 # core: core-site.xml
790 # hdfs: hdfs-site.xml
791 # mapred: mapred-site.xml
792 # yarn: yarn-site.xml
793 # hive: hive-site.xml
794 # pig: pig.properties
795 # spark: spark-defaults.conf
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]796 "a_key": "A String",
797 },
798 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]799 "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.
800 "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.
801 "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.
802 "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.
803 "tags": [ # The Google Compute Engine tags to add to all instances (see Tagging instances).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]804 "A String",
805 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]806 "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:
807 # roles/logging.logWriter
808 # 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
809 "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].
810 "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.
811 "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:
812 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
813 # https://www.googleapis.com/auth/devstorage.read_write
814 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
815 # https://www.googleapis.com/auth/bigquery
816 # https://www.googleapis.com/auth/bigtable.admin.table
817 # https://www.googleapis.com/auth/bigtable.data
818 # https://www.googleapis.com/auth/devstorage.full_control
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]819 "A String",
820 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]821 "metadata": { # The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]822 "a_key": "A String",
823 },
824 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]825 "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.
826 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
827 "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.
828 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]829 "A String",
830 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]831 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
832 "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.
833 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
834 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
835 "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)
836 },
837 ],
838 "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.
839 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
840 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]841 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]842 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
843 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
844 "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.
845 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]846 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]847 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]848 "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):
849 # ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)
850 # if [[ "${ROLE}" == 'Master' ]]; then
851 # ... master specific actions ...
852 # else
853 # ... worker specific actions ...
854 # fi
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]855 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]856 "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.
857 "executableFile": "A String", # Required Google Cloud Storage URI of executable file.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]858 },
859 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]860 "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.
861 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
862 "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.
863 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]864 "A String",
865 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]866 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
867 "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.
868 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
869 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
870 "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)
871 },
872 ],
873 "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.
874 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
875 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]876 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]877 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
878 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
879 "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.
880 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]881 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]882 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]883 "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.
884 "isPreemptible": True or False, # Optional Specifies that this instance group contains preemptible instances.
885 "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.
886 "instanceNames": [ # Optional The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]887 "A String",
888 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]889 "imageUri": "A String", # Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.
890 "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.
891 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
892 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
893 "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)
894 },
895 ],
896 "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.
897 "instanceTemplateName": "A String", # Output-only The name of the Instance Template used for the Managed Instance Group.
898 "instanceGroupManagerName": "A String", # Output-only The name of the Instance Group Manager for this group.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]899 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]900 "numInstances": 42, # Required The number of VM instances in the instance group. For master instance groups, must be set to 1.
901 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional Disk option config settings.
902 "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.
903 "bootDiskSizeGb": 42, # Optional Size in GB of the boot disk (default is 500GB).
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]904 },
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]905 },
906 },
907}
908
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]909 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:
910{
911 "config":{
912 "workerConfig":{
913 "numInstances":"5"
914 }
915 }
916}
917Similarly, 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:
918{
919 "config":{
920 "secondaryWorkerConfig":{
921 "numInstances":"5"
922 }
923 }
924}
925<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 -0800[diff] [blame]926 x__xgafv: string, V1 error format.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]927 Allowed values
928 1 - v1 error format
929 2 - v2 error format
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]930
931Returns:
932 An object of the form:
933
934 { # This resource represents a long-running operation that is the result of a network API call.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]935 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]936 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]937 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]938 "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.
939 # Simple to use and understand for most users
940 # 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:
941 # 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.
942 # Workflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting purpose.
943 # 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.
944 # 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.
945 # 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 -0800[diff] [blame]946 "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.
947 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
948 "details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
949 {
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]950 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]951 },
952 ],
953 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]954 "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.
955 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]956 "a_key": "", # Properties of the object. Contains field @type with type URL.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]957 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame^]958 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]959 }</pre>
960</div>
961
962</body></html>