blob: bdce6498d9ad0e150ee6a3d0616c7166fe67b5a1 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<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_v1beta2.html">Cloud Dataproc API</a> . <a href="dataproc_v1beta2.projects.html">projects</a> . <a href="dataproc_v1beta2.projects.regions.html">regions</a> . <a href="dataproc_v1beta2.projects.regions.clusters.html">clusters</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070078 <code><a href="#create">create(projectId, region, body=None, requestId=None, x__xgafv=None)</a></code></p>
79<p class="firstline">Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070080<p class="toc_element">
81 <code><a href="#delete">delete(projectId, region, clusterName, clusterUuid=None, requestId=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070082<p class="firstline">Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070083<p class="toc_element">
84 <code><a href="#diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070085<p class="firstline">Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata). After the operation completes, Operation.response contains Empty.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070086<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">
Dan O'Mearadd494642020-05-01 07:42:23 -070090 <code><a href="#getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070091<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
92<p class="toc_element">
93 <code><a href="#list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -070094<p class="firstline">Lists all regions/{region}/clusters in a project alphabetically.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070095<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070099 <code><a href="#patch">patch(projectId, region, clusterName, body=None, x__xgafv=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=None)</a></code></p>
100<p class="firstline">Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700102 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700105 <code><a href="#start">start(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>
106<p class="firstline">Starts a cluster in a project.</p>
107<p class="toc_element">
108 <code><a href="#stop">stop(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>
109<p class="firstline">Stops a cluster in a project.</p>
110<p class="toc_element">
111 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700112<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>
113<h3>Method Details</h3>
114<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 <code class="details" id="create">create(projectId, region, body=None, requestId=None, x__xgafv=None)</code>
116 <pre>Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700117
118Args:
119 projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700120 region: string, Required. The Dataproc region in which to handle the request. (required)
121 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700122 The object takes the form of:
123
124{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
125 "status": { # The status of a cluster and its instances. # Output only. Cluster status.
126 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700127 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700128 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700129 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700130 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700131 "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700132 "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
133 "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
134 "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.
135 "a_key": "A String",
136 },
137 "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. # Output only. 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.
138 "yarnMetrics": { # The YARN metrics.
139 "a_key": "A String",
140 },
141 "hdfsMetrics": { # The HDFS metrics.
142 "a_key": "A String",
143 },
144 },
145 "statusHistory": [ # Output only. The previous cluster status.
146 { # The status of a cluster and its instances.
147 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700148 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700149 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700150 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700151 },
152 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700153 "config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700154 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Dan O'Mearadd494642020-05-01 07:42:23 -0700155 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
156 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
157 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
158 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700159 },
160 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700161 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700162 "optionalComponents": [ # The set of optional components to activate on the cluster.
163 "A String",
164 ],
165 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
166 # capacity-scheduler: capacity-scheduler.xml
167 # core: core-site.xml
168 # distcp: distcp-default.xml
169 # hdfs: hdfs-site.xml
170 # hive: hive-site.xml
171 # mapred: mapred-site.xml
172 # pig: pig.properties
173 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700174 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700175 "a_key": "A String",
176 },
177 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700178 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700179 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
180 "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.
181 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
182 "values": [ # Optional. Corresponds to the label values of reservation resource.
183 "A String",
184 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700185 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700186 "consumeReservationType": "A String", # Optional. Type of reservation to consume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700187 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700188 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
190 # projects/[project_id]/regions/global/default
191 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700192 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700193 "A String",
194 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700195 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
196 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700197 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
198 # projects/[project_id]/zones/[zone]
199 # us-central1-f
200 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
201 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
202 # projects/[project_id]/regions/us-east1/subnetworks/sub0
203 # sub0
204 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
205 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
206 # https://www.googleapis.com/auth/devstorage.read_write
207 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
208 # https://www.googleapis.com/auth/bigquery
209 # https://www.googleapis.com/auth/bigtable.admin.table
210 # https://www.googleapis.com/auth/bigtable.data
211 # https://www.googleapis.com/auth/devstorage.full_control
212 "A String",
213 ],
214 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
215 "a_key": "A String",
216 },
217 },
218 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
219 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
220 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700221 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
222 },
223 "gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.
224 "namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
225 "clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.
226 "targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
227 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700228 },
229 "endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
230 "httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
231 "a_key": "A String",
232 },
233 "enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
234 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
236 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
237 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
239 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
240 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700241 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
242 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700243 "A String",
244 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700245 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
246 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
247 # projects/[project_id]/global/images/[image-id]
248 # image-idImage family examples. Dataproc will use the most recent image from the family:
249 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
250 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
251 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
252 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700253 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700254 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700255 },
256 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700257 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700258 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
259 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
260 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
261 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700262 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700264 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700265 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
266 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
267 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700268 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700269 "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 &lt;code&gt;role&lt;/code&gt; metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700270 # ROLE=$(curl -H Metadata-Flavor:Google
271 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
272 # if [[ "${ROLE}" == 'Master' ]]; then
273 # ... master specific actions ...
274 # else
275 # ... worker specific actions ...
276 # fi
277 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700278 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700279 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
280 },
281 ],
282 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
283 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
284 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700285 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
286 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
287 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
289 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
290 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700291 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
292 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700293 "A String",
294 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700295 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
296 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
297 # projects/[project_id]/global/images/[image-id]
298 # image-idImage family examples. Dataproc will use the most recent image from the family:
299 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
300 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
301 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
302 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700303 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700304 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700305 },
306 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700307 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700308 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
309 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
310 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
311 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700312 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700313 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700314 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700315 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
316 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
317 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700318 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700319 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
320 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
321 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700322 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
323 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
324 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700325 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
326 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700327 "A String",
328 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700329 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
330 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
331 # projects/[project_id]/global/images/[image-id]
332 # image-idImage family examples. Dataproc will use the most recent image from the family:
333 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
334 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
335 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
336 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700337 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700338 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700339 },
340 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700341 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
343 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
344 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
345 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700346 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700347 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700348 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700349 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
350 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
351 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700352 },
353 "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
354 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
355 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
356 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700357 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700359 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700360 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700361 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
362 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700363 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
364 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
365 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700366 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700367 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
Dan O'Mearadd494642020-05-01 07:42:23 -0700368 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
369 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700370 },
371 },
372 },
373}
374
375 requestId: string, Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
376 x__xgafv: string, V1 error format.
377 Allowed values
378 1 - v1 error format
379 2 - v2 error format
380
381Returns:
382 An object of the form:
383
384 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700385 "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.
386 "a_key": "", # Properties of the object. Contains field @type with type URL.
387 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700388 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
389 "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.
390 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
391 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
392 {
393 "a_key": "", # Properties of the object. Contains field @type with type URL.
394 },
395 ],
396 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700397 "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.
398 "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.
399 "a_key": "", # Properties of the object. Contains field @type with type URL.
400 },
401 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700402 }</pre>
403</div>
404
405<div class="method">
406 <code class="details" id="delete">delete(projectId, region, clusterName, clusterUuid=None, requestId=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700407 <pre>Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700408
409Args:
410 projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700411 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700412 clusterName: string, Required. The cluster name. (required)
413 clusterUuid: string, Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
414 requestId: string, Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
415 x__xgafv: string, V1 error format.
416 Allowed values
417 1 - v1 error format
418 2 - v2 error format
419
420Returns:
421 An object of the form:
422
423 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700424 "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.
425 "a_key": "", # Properties of the object. Contains field @type with type URL.
426 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
428 "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.
429 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
430 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
431 {
432 "a_key": "", # Properties of the object. Contains field @type with type URL.
433 },
434 ],
435 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700436 "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.
437 "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.
438 "a_key": "", # Properties of the object. Contains field @type with type URL.
439 },
440 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700441 }</pre>
442</div>
443
444<div class="method">
445 <code class="details" id="diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700446 <pre>Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata). After the operation completes, Operation.response contains Empty.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700447
448Args:
449 projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700450 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700451 clusterName: string, Required. The cluster name. (required)
452 body: object, The request body.
453 The object takes the form of:
454
455{ # A request to collect cluster diagnostic information.
456 }
457
458 x__xgafv: string, V1 error format.
459 Allowed values
460 1 - v1 error format
461 2 - v2 error format
462
463Returns:
464 An object of the form:
465
466 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700467 "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.
468 "a_key": "", # Properties of the object. Contains field @type with type URL.
469 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700470 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
471 "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.
472 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
473 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
474 {
475 "a_key": "", # Properties of the object. Contains field @type with type URL.
476 },
477 ],
478 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700479 "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.
480 "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.
481 "a_key": "", # Properties of the object. Contains field @type with type URL.
482 },
483 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700484 }</pre>
485</div>
486
487<div class="method">
488 <code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
489 <pre>Gets the resource representation for a cluster in a project.
490
491Args:
492 projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700493 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700494 clusterName: string, Required. The cluster name. (required)
495 x__xgafv: string, V1 error format.
496 Allowed values
497 1 - v1 error format
498 2 - v2 error format
499
500Returns:
501 An object of the form:
502
503 { # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
504 "status": { # The status of a cluster and its instances. # Output only. Cluster status.
505 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700506 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700507 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700508 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700509 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700510 "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700511 "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
512 "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
513 "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.
514 "a_key": "A String",
515 },
516 "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. # Output only. 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.
517 "yarnMetrics": { # The YARN metrics.
518 "a_key": "A String",
519 },
520 "hdfsMetrics": { # The HDFS metrics.
521 "a_key": "A String",
522 },
523 },
524 "statusHistory": [ # Output only. The previous cluster status.
525 { # The status of a cluster and its instances.
526 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700527 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700528 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700529 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700530 },
531 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700532 "config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700533 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Dan O'Mearadd494642020-05-01 07:42:23 -0700534 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
535 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
536 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
537 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700538 },
539 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700540 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700541 "optionalComponents": [ # The set of optional components to activate on the cluster.
542 "A String",
543 ],
544 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
545 # capacity-scheduler: capacity-scheduler.xml
546 # core: core-site.xml
547 # distcp: distcp-default.xml
548 # hdfs: hdfs-site.xml
549 # hive: hive-site.xml
550 # mapred: mapred-site.xml
551 # pig: pig.properties
552 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700553 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700554 "a_key": "A String",
555 },
556 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700557 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700558 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
559 "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.
560 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
561 "values": [ # Optional. Corresponds to the label values of reservation resource.
562 "A String",
563 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700564 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700565 "consumeReservationType": "A String", # Optional. Type of reservation to consume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700566 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700567 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700568 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
569 # projects/[project_id]/regions/global/default
570 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700571 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700572 "A String",
573 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700574 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
575 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700576 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
577 # projects/[project_id]/zones/[zone]
578 # us-central1-f
579 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
580 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
581 # projects/[project_id]/regions/us-east1/subnetworks/sub0
582 # sub0
583 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
584 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
585 # https://www.googleapis.com/auth/devstorage.read_write
586 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
587 # https://www.googleapis.com/auth/bigquery
588 # https://www.googleapis.com/auth/bigtable.admin.table
589 # https://www.googleapis.com/auth/bigtable.data
590 # https://www.googleapis.com/auth/devstorage.full_control
591 "A String",
592 ],
593 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
594 "a_key": "A String",
595 },
596 },
597 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
598 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
599 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700600 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
601 },
602 "gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.
603 "namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
604 "clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.
605 "targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
606 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700607 },
608 "endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
609 "httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
610 "a_key": "A String",
611 },
612 "enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
613 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700614 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
615 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
616 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
618 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
619 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700620 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
621 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700622 "A String",
623 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700624 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
625 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
626 # projects/[project_id]/global/images/[image-id]
627 # image-idImage family examples. Dataproc will use the most recent image from the family:
628 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
629 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
630 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
631 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700632 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700633 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700634 },
635 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700636 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700637 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
638 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
639 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
640 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700641 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700642 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700643 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700644 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
645 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
646 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700647 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700648 "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 &lt;code&gt;role&lt;/code&gt; metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700649 # ROLE=$(curl -H Metadata-Flavor:Google
650 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
651 # if [[ "${ROLE}" == 'Master' ]]; then
652 # ... master specific actions ...
653 # else
654 # ... worker specific actions ...
655 # fi
656 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -0700657 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700658 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
659 },
660 ],
661 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
662 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
663 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700664 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
665 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
666 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700667 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
668 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
669 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700670 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
671 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700672 "A String",
673 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700674 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
675 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
676 # projects/[project_id]/global/images/[image-id]
677 # image-idImage family examples. Dataproc will use the most recent image from the family:
678 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
679 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
680 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
681 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700682 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700683 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700684 },
685 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700686 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700687 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
688 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
689 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
690 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700691 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700692 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700693 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700694 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
695 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
696 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700697 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700698 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
699 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
700 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700701 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
702 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
703 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700704 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
705 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700706 "A String",
707 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700708 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
709 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
710 # projects/[project_id]/global/images/[image-id]
711 # image-idImage family examples. Dataproc will use the most recent image from the family:
712 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
713 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
714 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
715 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700716 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -0700717 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700718 },
719 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700720 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700721 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
722 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
723 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
724 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700725 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700726 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -0700727 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700728 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
729 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
730 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700731 },
732 "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
733 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
734 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
735 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -0700736 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700737 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -0700738 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700739 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700740 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
741 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700742 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
743 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
744 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -0700745 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700746 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
Dan O'Mearadd494642020-05-01 07:42:23 -0700747 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
748 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700749 },
750 },
751 },
752 }</pre>
753</div>
754
755<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700756 <code class="details" id="getIamPolicy">getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700757 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
758
759Args:
760 resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700761 options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700762 x__xgafv: string, V1 error format.
763 Allowed values
764 1 - v1 error format
765 2 - v2 error format
766
767Returns:
768 An object of the form:
769
Dan O'Mearadd494642020-05-01 07:42:23 -0700770 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700771 # {
772 # "bindings": [
773 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700774 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700775 # "members": [
776 # "user:mike@example.com",
777 # "group:admins@example.com",
778 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700779 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700780 # ]
781 # },
782 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700783 # "role": "roles/resourcemanager.organizationViewer",
784 # "members": ["user:eve@example.com"],
785 # "condition": {
786 # "title": "expirable access",
787 # "description": "Does not grant access after Sep 2020",
788 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
789 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700790 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700791 # ],
792 # "etag": "BwWWja0YfJA=",
793 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700794 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700795 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700796 # bindings:
797 # - members:
798 # - user:mike@example.com
799 # - group:admins@example.com
800 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700801 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
802 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700803 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700804 # - user:eve@example.com
805 # role: roles/resourcemanager.organizationViewer
806 # condition:
807 # title: expirable access
808 # description: Does not grant access after Sep 2020
809 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
810 # - etag: BwWWja0YfJA=
811 # - version: 3
812 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
813 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700814 { # Associates members with a role.
815 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
816 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
817 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
818 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -0700819 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700820 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
821 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700822 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
823 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
824 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700825 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
826 "A String",
827 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700828 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
829 # title: "Summary size limit"
830 # description: "Determines if a summary is less than 100 chars"
831 # expression: "document.summary.size() &lt; 100"
832 # Example (Equality):
833 # title: "Requestor is owner"
834 # description: "Determines if requestor is the document owner"
835 # expression: "document.owner == request.auth.claims.email"
836 # Example (Logic):
837 # title: "Public documents"
838 # description: "Determine whether the document should be publicly visible"
839 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
840 # Example (Data Manipulation):
841 # title: "Notification string"
842 # description: "Create a notification string with a timestamp."
843 # expression: "'New message received at ' + string(document.create_time)"
844 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
845 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
846 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
847 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
848 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700849 },
850 },
851 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700852 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
853 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
854 # Getting a policy that includes a conditional role binding
855 # Adding a conditional role binding to a policy
856 # Changing a conditional role binding in a policy
857 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700858 }</pre>
859</div>
860
861<div class="method">
862 <code class="details" id="list">list(projectId, region, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700863 <pre>Lists all regions/{region}/clusters in a project alphabetically.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700864
865Args:
866 projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700867 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700868 pageSize: integer, Optional. The standard List page size.
869 pageToken: string, Optional. The standard List page token.
870 x__xgafv: string, V1 error format.
871 Allowed values
872 1 - v1 error format
873 2 - v2 error format
874 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 = *
875
876Returns:
877 An object of the form:
878
879 { # The list of all clusters in a project.
Dan O'Mearadd494642020-05-01 07:42:23 -0700880 "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 &lt;code&gt;ListClustersRequest&lt;/code&gt;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700881 "clusters": [ # Output only. The clusters in the project.
882 { # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
883 "status": { # The status of a cluster and its instances. # Output only. Cluster status.
884 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700885 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700886 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700887 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700888 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700889 "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700890 "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
891 "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
892 "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.
893 "a_key": "A String",
894 },
895 "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. # Output only. 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.
896 "yarnMetrics": { # The YARN metrics.
897 "a_key": "A String",
898 },
899 "hdfsMetrics": { # The HDFS metrics.
900 "a_key": "A String",
901 },
902 },
903 "statusHistory": [ # Output only. The previous cluster status.
904 { # The status of a cluster and its instances.
905 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -0700906 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700907 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -0700908 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700909 },
910 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700911 "config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700912 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Dan O'Mearadd494642020-05-01 07:42:23 -0700913 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
914 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
915 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
916 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700917 },
918 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -0700919 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700920 "optionalComponents": [ # The set of optional components to activate on the cluster.
921 "A String",
922 ],
923 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
924 # capacity-scheduler: capacity-scheduler.xml
925 # core: core-site.xml
926 # distcp: distcp-default.xml
927 # hdfs: hdfs-site.xml
928 # hive: hive-site.xml
929 # mapred: mapred-site.xml
930 # pig: pig.properties
931 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700932 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700933 "a_key": "A String",
934 },
935 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700936 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700937 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
938 "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.
939 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
940 "values": [ # Optional. Corresponds to the label values of reservation resource.
941 "A String",
942 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700943 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
Dan O'Mearadd494642020-05-01 07:42:23 -0700944 "consumeReservationType": "A String", # Optional. Type of reservation to consume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700945 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700946 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700947 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
948 # projects/[project_id]/regions/global/default
949 # default
Dan O'Mearadd494642020-05-01 07:42:23 -0700950 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700951 "A String",
952 ],
Dan O'Mearadd494642020-05-01 07:42:23 -0700953 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
954 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700955 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
956 # projects/[project_id]/zones/[zone]
957 # us-central1-f
958 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
959 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
960 # projects/[project_id]/regions/us-east1/subnetworks/sub0
961 # sub0
962 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
963 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
964 # https://www.googleapis.com/auth/devstorage.read_write
965 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
966 # https://www.googleapis.com/auth/bigquery
967 # https://www.googleapis.com/auth/bigtable.admin.table
968 # https://www.googleapis.com/auth/bigtable.data
969 # https://www.googleapis.com/auth/devstorage.full_control
970 "A String",
971 ],
972 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
973 "a_key": "A String",
974 },
975 },
976 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
977 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
978 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700979 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
980 },
981 "gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.
982 "namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
983 "clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.
984 "targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
985 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700986 },
987 "endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
988 "httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
989 "a_key": "A String",
990 },
991 "enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
992 },
Dan O'Mearadd494642020-05-01 07:42:23 -0700993 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
994 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
995 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700996 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
997 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
998 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700999 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1000 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001001 "A String",
1002 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001003 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1004 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1005 # projects/[project_id]/global/images/[image-id]
1006 # image-idImage family examples. Dataproc will use the most recent image from the family:
1007 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1008 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1009 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1010 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001011 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001012 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001013 },
1014 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001015 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001016 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1017 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1018 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1019 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001020 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001021 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001022 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001023 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1024 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1025 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001026 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001027 "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 &lt;code&gt;role&lt;/code&gt; metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001028 # ROLE=$(curl -H Metadata-Flavor:Google
1029 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
1030 # if [[ "${ROLE}" == 'Master' ]]; then
1031 # ... master specific actions ...
1032 # else
1033 # ... worker specific actions ...
1034 # fi
1035 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -07001036 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001037 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
1038 },
1039 ],
1040 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1041 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1042 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001043 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
1044 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1045 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001046 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1047 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1048 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001049 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1050 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001051 "A String",
1052 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001053 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1054 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1055 # projects/[project_id]/global/images/[image-id]
1056 # image-idImage family examples. Dataproc will use the most recent image from the family:
1057 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1058 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1059 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1060 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001061 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001062 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001063 },
1064 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001065 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001066 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1067 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1068 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1069 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001070 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001071 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001072 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001073 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1074 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1075 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001076 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001077 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
1078 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1079 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001080 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1081 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1082 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001083 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1084 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001085 "A String",
1086 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001087 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1088 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1089 # projects/[project_id]/global/images/[image-id]
1090 # image-idImage family examples. Dataproc will use the most recent image from the family:
1091 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1092 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1093 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1094 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001095 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001096 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001097 },
1098 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001099 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001100 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1101 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1102 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1103 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001104 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001105 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001106 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001107 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1108 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1109 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001110 },
1111 "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
1112 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
1113 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
1114 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -07001115 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001116 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -07001117 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001118 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -07001119 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1120 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001121 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
1122 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
1123 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -07001124 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001125 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
Dan O'Mearadd494642020-05-01 07:42:23 -07001126 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1127 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001128 },
1129 },
1130 },
1131 },
1132 ],
1133 }</pre>
1134</div>
1135
1136<div class="method">
1137 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1138 <pre>Retrieves the next page of results.
1139
1140Args:
1141 previous_request: The request for the previous page. (required)
1142 previous_response: The response from the request for the previous page. (required)
1143
1144Returns:
1145 A request object that you can call 'execute()' on to request the next
1146 page. Returns None if there are no more items in the collection.
1147 </pre>
1148</div>
1149
1150<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001151 <code class="details" id="patch">patch(projectId, region, clusterName, body=None, x__xgafv=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=None)</code>
1152 <pre>Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001153
1154Args:
1155 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001156 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001157 clusterName: string, Required. The cluster name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001158 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001159 The object takes the form of:
1160
1161{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
1162 "status": { # The status of a cluster and its instances. # Output only. Cluster status.
1163 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -07001164 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001165 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -07001166 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001167 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001168 "clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001169 "clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
1170 "projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.
1171 "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.
1172 "a_key": "A String",
1173 },
1174 "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. # Output only. 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.
1175 "yarnMetrics": { # The YARN metrics.
1176 "a_key": "A String",
1177 },
1178 "hdfsMetrics": { # The HDFS metrics.
1179 "a_key": "A String",
1180 },
1181 },
1182 "statusHistory": [ # Output only. The previous cluster status.
1183 { # The status of a cluster and its instances.
1184 "state": "A String", # Output only. The cluster's state.
Dan O'Mearadd494642020-05-01 07:42:23 -07001185 "stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001186 "substate": "A String", # Output only. Additional state information that includes status reported by the agent.
Dan O'Mearadd494642020-05-01 07:42:23 -07001187 "detail": "A String", # Output only. Optional details of cluster's state.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001188 },
1189 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001190 "config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001191 "lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Dan O'Mearadd494642020-05-01 07:42:23 -07001192 "autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1193 "idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).
1194 "autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1195 "idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001196 },
1197 "softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Dan O'Mearadd494642020-05-01 07:42:23 -07001198 "imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001199 "optionalComponents": [ # The set of optional components to activate on the cluster.
1200 "A String",
1201 ],
1202 "properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:
1203 # capacity-scheduler: capacity-scheduler.xml
1204 # core: core-site.xml
1205 # distcp: distcp-default.xml
1206 # hdfs: hdfs-site.xml
1207 # hive: hive-site.xml
1208 # mapred: mapred-site.xml
1209 # pig: pig.properties
1210 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -07001211 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001212 "a_key": "A String",
1213 },
1214 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001215 "configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001216 "gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.
1217 "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.
1218 "reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
1219 "values": [ # Optional. Corresponds to the label values of reservation resource.
1220 "A String",
1221 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001222 "key": "A String", # Optional. Corresponds to the label key of reservation resource.
Dan O'Mearadd494642020-05-01 07:42:23 -07001223 "consumeReservationType": "A String", # Optional. Type of reservation to consume
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001224 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001225 "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001226 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
1227 # projects/[project_id]/regions/global/default
1228 # default
Dan O'Mearadd494642020-05-01 07:42:23 -07001229 "tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001230 "A String",
1231 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001232 "serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.
1233 "zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001234 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
1235 # projects/[project_id]/zones/[zone]
1236 # us-central1-f
1237 "subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:
1238 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
1239 # projects/[project_id]/regions/us-east1/subnetworks/sub0
1240 # sub0
1241 "serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
1242 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
1243 # https://www.googleapis.com/auth/devstorage.read_write
1244 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
1245 # https://www.googleapis.com/auth/bigquery
1246 # https://www.googleapis.com/auth/bigtable.admin.table
1247 # https://www.googleapis.com/auth/bigtable.data
1248 # https://www.googleapis.com/auth/devstorage.full_control
1249 "A String",
1250 ],
1251 "metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
1252 "a_key": "A String",
1253 },
1254 },
1255 "autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
1256 "policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
1257 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -07001258 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
1259 },
1260 "gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.
1261 "namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
1262 "clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.
1263 "targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'
1264 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001265 },
1266 "endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
1267 "httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
1268 "a_key": "A String",
1269 },
1270 "enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
1271 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001272 "workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.
1273 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1274 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001275 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1276 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1277 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001278 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1279 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001280 "A String",
1281 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001282 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1283 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1284 # projects/[project_id]/global/images/[image-id]
1285 # image-idImage family examples. Dataproc will use the most recent image from the family:
1286 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1287 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1288 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1289 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001290 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001291 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001292 },
1293 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001294 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001295 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1296 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1297 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1298 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001299 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001300 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001301 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001302 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1303 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1304 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001305 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001306 "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 &lt;code&gt;role&lt;/code&gt; metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001307 # ROLE=$(curl -H Metadata-Flavor:Google
1308 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
1309 # if [[ "${ROLE}" == 'Master' ]]; then
1310 # ... master specific actions ...
1311 # else
1312 # ... worker specific actions ...
1313 # fi
1314 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Dan O'Mearadd494642020-05-01 07:42:23 -07001315 "executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001316 "executableFile": "A String", # Required. Cloud Storage URI of executable file.
1317 },
1318 ],
1319 "encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1320 "gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1321 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001322 "secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.
1323 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1324 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001325 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1326 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1327 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001328 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1329 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001330 "A String",
1331 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001332 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1333 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1334 # projects/[project_id]/global/images/[image-id]
1335 # image-idImage family examples. Dataproc will use the most recent image from the family:
1336 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1337 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1338 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1339 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001340 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001341 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001342 },
1343 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001344 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001345 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1346 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1347 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1348 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001349 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001350 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001351 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001352 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1353 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1354 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001355 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001356 "masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.
1357 "isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.
1358 "preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001359 "machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1360 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1361 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001362 # n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.
1363 "instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001364 "A String",
1365 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001366 "imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1367 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1368 # projects/[project_id]/global/images/[image-id]
1369 # image-idImage family examples. Dataproc will use the most recent image from the family:
1370 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1371 # projects/[project_id]/global/images/family/[custom-image-family-name]If the URI is unspecified, it will be inferred from SoftwareConfig.image_version or the system default.
1372 "accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.
1373 { # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001374 "acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.
Dan O'Mearadd494642020-05-01 07:42:23 -07001375 "acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001376 },
1377 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001378 "minCpuPlatform": "A String", # Specifies the minimum cpu platform for the Instance Group. See Dataproc -&amp;gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001379 "managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
1380 "instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.
1381 "instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.
1382 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001383 "numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001384 "diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
Dan O'Mearadd494642020-05-01 07:42:23 -07001385 "numLocalSsds": 42, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001386 "bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
1387 "bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
1388 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001389 },
1390 "securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
1391 "kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.
1392 "truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
1393 "crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
Dan O'Mearadd494642020-05-01 07:42:23 -07001394 "realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001395 "keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
Dan O'Mearadd494642020-05-01 07:42:23 -07001396 "enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001397 "crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -07001398 "kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1399 "keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001400 "keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
1401 "crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
1402 "crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
Dan O'Mearadd494642020-05-01 07:42:23 -07001403 "tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001404 "kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.
Dan O'Mearadd494642020-05-01 07:42:23 -07001405 "truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1406 "rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001407 },
1408 },
1409 },
1410}
1411
1412 x__xgafv: string, V1 error format.
1413 Allowed values
1414 1 - v1 error format
1415 2 - v2 error format
Dan O'Mearadd494642020-05-01 07:42:23 -07001416 gracefulDecommissionTimeout: string, Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001417 requestId: string, Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1418 updateMask: string, Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:
1419{
1420 "config":{
1421 "workerConfig":{
1422 "numInstances":"5"
1423 }
1424 }
1425}
1426Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:
1427{
1428 "config":{
1429 "secondaryWorkerConfig":{
1430 "numInstances":"5"
1431 }
1432 }
1433}
Dan O'Mearadd494642020-05-01 07:42:23 -07001434&lt;strong&gt;Note:&lt;/strong&gt; currently only the following fields can be updated:
1435&lt;table&gt;
1436&lt;tr&gt;
1437&lt;td&gt;&lt;strong&gt;Mask&lt;/strong&gt;&lt;/td&gt;&lt;td&gt;&lt;strong&gt;Purpose&lt;/strong&gt;&lt;/td&gt;
1438&lt;/tr&gt;
1439&lt;tr&gt;
1440&lt;td&gt;labels&lt;/td&gt;&lt;td&gt;Updates labels&lt;/td&gt;
1441&lt;/tr&gt;
1442&lt;tr&gt;
1443&lt;td&gt;config.worker_config.num_instances&lt;/td&gt;&lt;td&gt;Resize primary worker
1444group&lt;/td&gt;
1445&lt;/tr&gt;
1446&lt;tr&gt;
1447&lt;td&gt;config.secondary_worker_config.num_instances&lt;/td&gt;&lt;td&gt;Resize secondary
1448worker group&lt;/td&gt;
1449&lt;/tr&gt;
1450&lt;tr&gt;
1451&lt;td&gt;config.lifecycle_config.auto_delete_ttl&lt;/td&gt;&lt;td&gt;Reset MAX TTL
1452duration&lt;/td&gt;
1453&lt;/tr&gt;
1454&lt;tr&gt;
1455&lt;td&gt;config.lifecycle_config.auto_delete_time&lt;/td&gt;&lt;td&gt;Update MAX TTL
1456deletion timestamp&lt;/td&gt;
1457&lt;/tr&gt;
1458&lt;tr&gt;
1459&lt;td&gt;config.lifecycle_config.idle_delete_ttl&lt;/td&gt;&lt;td&gt;Update Idle TTL
1460duration&lt;/td&gt;
1461&lt;/tr&gt;
1462&lt;tr&gt;
1463&lt;td&gt;config.autoscaling_config.policy_uri&lt;/td&gt;&lt;td&gt;Use, stop using, or change
1464autoscaling policies&lt;/td&gt;
1465&lt;/tr&gt;
1466&lt;/table&gt;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001467
1468Returns:
1469 An object of the form:
1470
1471 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001472 "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.
1473 "a_key": "", # Properties of the object. Contains field @type with type URL.
1474 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001475 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
1476 "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.
1477 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1478 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1479 {
1480 "a_key": "", # Properties of the object. Contains field @type with type URL.
1481 },
1482 ],
1483 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001484 "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.
1485 "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.
1486 "a_key": "", # Properties of the object. Contains field @type with type URL.
1487 },
1488 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001489 }</pre>
1490</div>
1491
1492<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001493 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
1494 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return Public Errors: NOT_FOUND, INVALID_ARGUMENT and PERMISSION_DENIED
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001495
1496Args:
1497 resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001498 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001499 The object takes the form of:
1500
1501{ # Request message for SetIamPolicy method.
Dan O'Mearadd494642020-05-01 07:42:23 -07001502 "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example: # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001503 # {
1504 # "bindings": [
1505 # {
Dan O'Mearadd494642020-05-01 07:42:23 -07001506 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001507 # "members": [
1508 # "user:mike@example.com",
1509 # "group:admins@example.com",
1510 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -07001511 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001512 # ]
1513 # },
1514 # {
Dan O'Mearadd494642020-05-01 07:42:23 -07001515 # "role": "roles/resourcemanager.organizationViewer",
1516 # "members": ["user:eve@example.com"],
1517 # "condition": {
1518 # "title": "expirable access",
1519 # "description": "Does not grant access after Sep 2020",
1520 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1521 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001522 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001523 # ],
1524 # "etag": "BwWWja0YfJA=",
1525 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001526 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001527 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001528 # bindings:
1529 # - members:
1530 # - user:mike@example.com
1531 # - group:admins@example.com
1532 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001533 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1534 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001535 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001536 # - user:eve@example.com
1537 # role: roles/resourcemanager.organizationViewer
1538 # condition:
1539 # title: expirable access
1540 # description: Does not grant access after Sep 2020
1541 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1542 # - etag: BwWWja0YfJA=
1543 # - version: 3
1544 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
1545 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001546 { # Associates members with a role.
1547 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1548 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1549 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1550 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -07001551 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001552 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1553 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -07001554 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
1555 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
1556 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001557 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1558 "A String",
1559 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001560 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1561 # title: "Summary size limit"
1562 # description: "Determines if a summary is less than 100 chars"
1563 # expression: "document.summary.size() &lt; 100"
1564 # Example (Equality):
1565 # title: "Requestor is owner"
1566 # description: "Determines if requestor is the document owner"
1567 # expression: "document.owner == request.auth.claims.email"
1568 # Example (Logic):
1569 # title: "Public documents"
1570 # description: "Determine whether the document should be publicly visible"
1571 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1572 # Example (Data Manipulation):
1573 # title: "Notification string"
1574 # description: "Create a notification string with a timestamp."
1575 # expression: "'New message received at ' + string(document.create_time)"
1576 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1577 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1578 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
1579 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1580 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001581 },
1582 },
1583 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001584 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
1585 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
1586 # Getting a policy that includes a conditional role binding
1587 # Adding a conditional role binding to a policy
1588 # Changing a conditional role binding in a policy
1589 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001590 },
1591 }
1592
1593 x__xgafv: string, V1 error format.
1594 Allowed values
1595 1 - v1 error format
1596 2 - v2 error format
1597
1598Returns:
1599 An object of the form:
1600
Dan O'Mearadd494642020-05-01 07:42:23 -07001601 { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.Optionally, a binding can specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both.JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001602 # {
1603 # "bindings": [
1604 # {
Dan O'Mearadd494642020-05-01 07:42:23 -07001605 # "role": "roles/resourcemanager.organizationAdmin",
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001606 # "members": [
1607 # "user:mike@example.com",
1608 # "group:admins@example.com",
1609 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -07001610 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001611 # ]
1612 # },
1613 # {
Dan O'Mearadd494642020-05-01 07:42:23 -07001614 # "role": "roles/resourcemanager.organizationViewer",
1615 # "members": ["user:eve@example.com"],
1616 # "condition": {
1617 # "title": "expirable access",
1618 # "description": "Does not grant access after Sep 2020",
1619 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1620 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001621 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001622 # ],
1623 # "etag": "BwWWja0YfJA=",
1624 # "version": 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001625 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001626 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001627 # bindings:
1628 # - members:
1629 # - user:mike@example.com
1630 # - group:admins@example.com
1631 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001632 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1633 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001634 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001635 # - user:eve@example.com
1636 # role: roles/resourcemanager.organizationViewer
1637 # condition:
1638 # title: expirable access
1639 # description: Does not grant access after Sep 2020
1640 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1641 # - etag: BwWWja0YfJA=
1642 # - version: 3
1643 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
1644 "bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001645 { # Associates members with a role.
1646 "role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
1647 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
1648 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1649 # allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.
Dan O'Mearadd494642020-05-01 07:42:23 -07001650 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001651 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1652 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -07001653 # deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding.
1654 # deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding.
1655 # deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001656 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
1657 "A String",
1658 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001659 "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding. NOTE: An unsatisfied condition will not allow user access via current binding. Different bindings, including their conditions, are examined independently.
1660 # title: "Summary size limit"
1661 # description: "Determines if a summary is less than 100 chars"
1662 # expression: "document.summary.size() &lt; 100"
1663 # Example (Equality):
1664 # title: "Requestor is owner"
1665 # description: "Determines if requestor is the document owner"
1666 # expression: "document.owner == request.auth.claims.email"
1667 # Example (Logic):
1668 # title: "Public documents"
1669 # description: "Determine whether the document should be publicly visible"
1670 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1671 # Example (Data Manipulation):
1672 # title: "Notification string"
1673 # description: "Create a notification string with a timestamp."
1674 # expression: "'New message received at ' + string(document.create_time)"
1675 # The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
1676 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
1677 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
1678 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1679 "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001680 },
1681 },
1682 ],
Dan O'Mearadd494642020-05-01 07:42:23 -07001683 "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
1684 "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:
1685 # Getting a policy that includes a conditional role binding
1686 # Adding a conditional role binding to a policy
1687 # Changing a conditional role binding in a policy
1688 # Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001689 }</pre>
1690</div>
1691
1692<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001693 <code class="details" id="start">start(projectId, region, clusterName, body=None, x__xgafv=None)</code>
1694 <pre>Starts a cluster in a project.
1695
1696Args:
1697 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
1698 region: string, Required. The Dataproc region in which to handle the request. (required)
1699 clusterName: string, Required. The cluster name. (required)
1700 body: object, The request body.
1701 The object takes the form of:
1702
1703{ # A request to start a cluster.
1704 "clusterUuid": "A String", # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
1705 "requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two StartClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1706 }
1707
1708 x__xgafv: string, V1 error format.
1709 Allowed values
1710 1 - v1 error format
1711 2 - v2 error format
1712
1713Returns:
1714 An object of the form:
1715
1716 { # This resource represents a long-running operation that is the result of a network API call.
1717 "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.
1718 "a_key": "", # Properties of the object. Contains field @type with type URL.
1719 },
1720 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
1721 "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.
1722 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1723 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1724 {
1725 "a_key": "", # Properties of the object. Contains field @type with type URL.
1726 },
1727 ],
1728 },
1729 "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.
1730 "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.
1731 "a_key": "", # Properties of the object. Contains field @type with type URL.
1732 },
1733 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
1734 }</pre>
1735</div>
1736
1737<div class="method">
1738 <code class="details" id="stop">stop(projectId, region, clusterName, body=None, x__xgafv=None)</code>
1739 <pre>Stops a cluster in a project.
1740
1741Args:
1742 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
1743 region: string, Required. The Dataproc region in which to handle the request. (required)
1744 clusterName: string, Required. The cluster name. (required)
1745 body: object, The request body.
1746 The object takes the form of:
1747
1748{ # A request to stop a cluster.
1749 "clusterUuid": "A String", # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
1750 "requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two StopClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
1751 }
1752
1753 x__xgafv: string, V1 error format.
1754 Allowed values
1755 1 - v1 error format
1756 2 - v2 error format
1757
1758Returns:
1759 An object of the form:
1760
1761 { # This resource represents a long-running operation that is the result of a network API call.
1762 "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.
1763 "a_key": "", # Properties of the object. Contains field @type with type URL.
1764 },
1765 "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
1766 "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.
1767 "code": 42, # The status code, which should be an enum value of google.rpc.Code.
1768 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
1769 {
1770 "a_key": "", # Properties of the object. Contains field @type with type URL.
1771 },
1772 ],
1773 },
1774 "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.
1775 "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.
1776 "a_key": "", # Properties of the object. Contains field @type with type URL.
1777 },
1778 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
1779 }</pre>
1780</div>
1781
1782<div class="method">
1783 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001784 <pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
1785
1786Args:
1787 resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001788 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001789 The object takes the form of:
1790
1791{ # Request message for TestIamPermissions method.
1792 "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
1793 "A String",
1794 ],
1795 }
1796
1797 x__xgafv: string, V1 error format.
1798 Allowed values
1799 1 - v1 error format
1800 2 - v2 error format
1801
1802Returns:
1803 An object of the form:
1804
1805 { # Response message for TestIamPermissions method.
1806 "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
1807 "A String",
1808 ],
1809 }</pre>
1810</div>
1811
1812</body></html>