blob: 0798b5f777691d5c0fe82bf6577a5fdf47dbc6af [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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070081 <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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070093 <code><a href="#list">list(projectId, region, filter=None, pageToken=None, pageSize=None, x__xgafv=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">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070099 <code><a href="#patch">patch(projectId, region, clusterName, body=None, updateMask=None, gracefulDecommissionTimeout=None, requestId=None, x__xgafv=None)</a></code></p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700100<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>
Bu Sun Kim65020912020-05-20 12:08:20 -0700103<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.</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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700125 &quot;statusHistory&quot;: [ # Output only. The previous cluster status.
126 { # The status of a cluster and its instances.
127 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
128 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
129 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
130 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700131 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700132 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700133 &quot;config&quot;: { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700134 &quot;configBucket&quot;: &quot;A String&quot;, # 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&#x27;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)).
135 &quot;gceClusterConfig&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700136 &quot;zoneUri&quot;: &quot;A String&quot;, # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the &quot;global&quot; 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:
137 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
138 # projects/[project_id]/zones/[zone]
139 # us-central1-f
140 &quot;metadata&quot;: { # 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)).
141 &quot;a_key&quot;: &quot;A String&quot;,
142 },
143 &quot;internalIpOnly&quot;: 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.
144 &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
145 &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
146 &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
147 &quot;A String&quot;,
148 ],
149 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
150 },
151 &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
152 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
153 # https://www.googleapis.com/auth/devstorage.read_write
154 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
155 # https://www.googleapis.com/auth/bigquery
156 # https://www.googleapis.com/auth/bigtable.admin.table
157 # https://www.googleapis.com/auth/bigtable.data
158 # https://www.googleapis.com/auth/devstorage.full_control
159 &quot;A String&quot;,
160 ],
161 &quot;tags&quot;: [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
162 &quot;A String&quot;,
163 ],
164 &quot;serviceAccount&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700165 &quot;subnetworkUri&quot;: &quot;A String&quot;, # 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:
166 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
167 # projects/[project_id]/regions/us-east1/subnetworks/sub0
168 # sub0
169 &quot;networkUri&quot;: &quot;A String&quot;, # 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 &quot;default&quot; network of the project is used, if it exists. Cannot be a &quot;Custom Subnet Network&quot; (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
170 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
171 # projects/[project_id]/regions/global/default
172 # default
Bu Sun Kim65020912020-05-20 12:08:20 -0700173 },
174 &quot;softwareConfig&quot;: { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700175 &quot;properties&quot;: { # 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:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700176 # capacity-scheduler: capacity-scheduler.xml
177 # core: core-site.xml
178 # distcp: distcp-default.xml
179 # hdfs: hdfs-site.xml
180 # hive: hive-site.xml
181 # mapred: mapred-site.xml
182 # pig: pig.properties
183 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700184 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim65020912020-05-20 12:08:20 -0700185 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700186 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700187 &quot;optionalComponents&quot;: [ # The set of optional components to activate on the cluster.
188 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700189 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700190 &quot;imageVersion&quot;: &quot;A String&quot;, # 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 &quot;1.2&quot; (including a subminor version, such as &quot;1.2.29&quot;), or the &quot;preview&quot; version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
191 },
192 &quot;gkeClusterConfig&quot;: { # 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.
193 &quot;namespacedGkeDeploymentTarget&quot;: { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
194 &quot;targetGkeCluster&quot;: &quot;A String&quot;, # Optional. The target GKE cluster to deploy to. Format: &#x27;projects/{project}/locations/{location}/clusters/{cluster_id}&#x27;
195 &quot;clusterNamespace&quot;: &quot;A String&quot;, # Optional. A namespace within the GKE cluster to deploy into.
196 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700197 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700198 &quot;autoscalingConfig&quot;: { # 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.
199 &quot;policyUri&quot;: &quot;A String&quot;, # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700200 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700201 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
202 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700203 &quot;endpointConfig&quot;: { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
204 &quot;httpPorts&quot;: { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
205 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700206 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700207 &quot;enableHttpPortAccess&quot;: True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700208 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700209 &quot;masterConfig&quot;: { # 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.
210 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
211 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
212 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
213 &quot;numLocalSsds&quot;: 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 -0700214 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700215 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
216 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700217 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
218 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700219 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700220 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -0700221 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
222 # projects/[project_id]/global/images/[image-id]
223 # image-idImage family examples. Dataproc will use the most recent image from the family:
224 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
225 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700226 &quot;managedGroupConfig&quot;: { # 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.
227 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
228 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
229 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700230 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700231 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
232 &quot;A String&quot;,
233 ],
234 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700235 { # 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 Kim65020912020-05-20 12:08:20 -0700236 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
237 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700238 },
239 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700240 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
241 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
242 },
243 &quot;encryptionConfig&quot;: { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
244 &quot;gcePdKmsKeyName&quot;: &quot;A String&quot;, # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
245 },
246 &quot;securityConfig&quot;: { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
247 &quot;kerberosConfig&quot;: { # Specifies Kerberos related configuration. # Kerberos related configuration.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700248 &quot;crossRealmTrustRealm&quot;: &quot;A String&quot;, # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
249 &quot;rootPrincipalPasswordUri&quot;: &quot;A String&quot;, # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
250 &quot;kmsKeyUri&quot;: &quot;A String&quot;, # Required. The uri of the KMS key used to encrypt various sensitive files.
251 &quot;crossRealmTrustKdc&quot;: &quot;A String&quot;, # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
252 &quot;crossRealmTrustSharedPasswordUri&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700253 &quot;tgtLifetimeHours&quot;: 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.
254 &quot;keystoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
255 &quot;keyPasswordUri&quot;: &quot;A String&quot;, # 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.
256 &quot;keystorePasswordUri&quot;: &quot;A String&quot;, # 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.
257 &quot;crossRealmTrustAdminServer&quot;: &quot;A String&quot;, # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
258 &quot;kdcDbKeyUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
259 &quot;truststorePasswordUri&quot;: &quot;A String&quot;, # 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.
260 &quot;realm&quot;: &quot;A String&quot;, # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
261 &quot;enableKerberos&quot;: 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.
262 &quot;truststoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700263 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700264 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700265 &quot;initializationActions&quot;: [ # 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&#x27;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 -0700266 # ROLE=$(curl -H Metadata-Flavor:Google
267 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
Bu Sun Kim65020912020-05-20 12:08:20 -0700268 # if [[ &quot;${ROLE}&quot; == &#x27;Master&#x27; ]]; then
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700269 # ... master specific actions ...
270 # else
271 # ... worker specific actions ...
272 # fi
273 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700274 &quot;executionTimeout&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -0700275 &quot;executableFile&quot;: &quot;A String&quot;, # Required. Cloud Storage URI of executable file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700276 },
277 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 &quot;lifecycleConfig&quot;: { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Bu Sun Kim65020912020-05-20 12:08:20 -0700279 &quot;idleDeleteTtl&quot;: &quot;A String&quot;, # 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).
280 &quot;autoDeleteTtl&quot;: &quot;A String&quot;, # 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)).
281 &quot;idleStartTime&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -0700282 &quot;autoDeleteTime&quot;: &quot;A String&quot;, # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700283 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700284 &quot;workerConfig&quot;: { # 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.
285 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
286 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
287 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
288 &quot;numLocalSsds&quot;: 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.
289 },
290 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
291 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700292 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
293 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700294 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700295 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -0700296 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700301 &quot;managedGroupConfig&quot;: { # 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.
302 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
303 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
304 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700305 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
306 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
307 &quot;A String&quot;,
308 ],
309 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
310 { # 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/)).
311 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
312 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
313 },
314 ],
315 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
316 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
317 },
318 &quot;secondaryWorkerConfig&quot;: { # 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.
319 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
320 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
321 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
322 &quot;numLocalSsds&quot;: 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.
323 },
324 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
325 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
326 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
327 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
328 # 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.
329 &quot;imageUri&quot;: &quot;A String&quot;, # 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 &quot;managedGroupConfig&quot;: { # 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.
336 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
337 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
338 },
339 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700340 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
341 &quot;A String&quot;,
342 ],
343 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700344 { # 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 Kim65020912020-05-20 12:08:20 -0700345 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
346 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700347 },
348 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700349 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
350 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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 -0700351 },
352 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700353 &quot;clusterName&quot;: &quot;A String&quot;, # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
354 &quot;clusterUuid&quot;: &quot;A String&quot;, # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
355 &quot;projectId&quot;: &quot;A String&quot;, # Required. The Google Cloud Platform project ID that the cluster belongs to.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700356 &quot;labels&quot;: { # 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.
357 &quot;a_key&quot;: &quot;A String&quot;,
358 },
359 &quot;metrics&quot;: { # 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.
360 &quot;hdfsMetrics&quot;: { # The HDFS metrics.
361 &quot;a_key&quot;: &quot;A String&quot;,
362 },
363 &quot;yarnMetrics&quot;: { # The YARN metrics.
364 &quot;a_key&quot;: &quot;A String&quot;,
365 },
366 },
367 &quot;status&quot;: { # The status of a cluster and its instances. # Output only. Cluster status.
368 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
369 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
370 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
371 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
372 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700373}
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 Kim4ed7d3f2020-05-27 12:20:54 -0700385 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700386 &quot;response&quot;: { # 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.
387 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700388 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700389 &quot;name&quot;: &quot;A String&quot;, # 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}.
390 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700391 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700392 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700393 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700394 },
395 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700396 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
397 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700398 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700399 &quot;metadata&quot;: { # 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.
400 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700401 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700402 }</pre>
403</div>
404
405<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700406 <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)
Bu Sun Kim65020912020-05-20 12:08:20 -0700413 clusterUuid: string, Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700414 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700415 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 Kim4ed7d3f2020-05-27 12:20:54 -0700424 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700425 &quot;response&quot;: { # 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.
426 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700427 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700428 &quot;name&quot;: &quot;A String&quot;, # 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}.
429 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700430 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700431 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700432 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700433 },
434 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700435 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
436 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700437 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700438 &quot;metadata&quot;: { # 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.
439 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700440 },
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 Kim4ed7d3f2020-05-27 12:20:54 -0700467 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700468 &quot;response&quot;: { # 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.
469 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700470 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700471 &quot;name&quot;: &quot;A String&quot;, # 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}.
472 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700473 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700474 {
Bu Sun Kim65020912020-05-20 12:08:20 -0700475 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700476 },
477 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700478 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
479 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700480 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700481 &quot;metadata&quot;: { # 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.
482 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -0700483 },
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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700504 &quot;statusHistory&quot;: [ # Output only. The previous cluster status.
505 { # The status of a cluster and its instances.
506 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
507 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
508 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
509 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700510 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700511 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700512 &quot;config&quot;: { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700513 &quot;configBucket&quot;: &quot;A String&quot;, # 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&#x27;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)).
514 &quot;gceClusterConfig&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700515 &quot;zoneUri&quot;: &quot;A String&quot;, # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the &quot;global&quot; 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:
516 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
517 # projects/[project_id]/zones/[zone]
518 # us-central1-f
519 &quot;metadata&quot;: { # 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)).
520 &quot;a_key&quot;: &quot;A String&quot;,
521 },
522 &quot;internalIpOnly&quot;: 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.
523 &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
524 &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
525 &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
526 &quot;A String&quot;,
527 ],
528 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
529 },
530 &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
531 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
532 # https://www.googleapis.com/auth/devstorage.read_write
533 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
534 # https://www.googleapis.com/auth/bigquery
535 # https://www.googleapis.com/auth/bigtable.admin.table
536 # https://www.googleapis.com/auth/bigtable.data
537 # https://www.googleapis.com/auth/devstorage.full_control
538 &quot;A String&quot;,
539 ],
540 &quot;tags&quot;: [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
541 &quot;A String&quot;,
542 ],
543 &quot;serviceAccount&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700544 &quot;subnetworkUri&quot;: &quot;A String&quot;, # 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:
545 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
546 # projects/[project_id]/regions/us-east1/subnetworks/sub0
547 # sub0
548 &quot;networkUri&quot;: &quot;A String&quot;, # 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 &quot;default&quot; network of the project is used, if it exists. Cannot be a &quot;Custom Subnet Network&quot; (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
549 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
550 # projects/[project_id]/regions/global/default
551 # default
Bu Sun Kim65020912020-05-20 12:08:20 -0700552 },
553 &quot;softwareConfig&quot;: { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700554 &quot;properties&quot;: { # 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:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700555 # capacity-scheduler: capacity-scheduler.xml
556 # core: core-site.xml
557 # distcp: distcp-default.xml
558 # hdfs: hdfs-site.xml
559 # hive: hive-site.xml
560 # mapred: mapred-site.xml
561 # pig: pig.properties
562 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700563 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim65020912020-05-20 12:08:20 -0700564 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700565 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700566 &quot;optionalComponents&quot;: [ # The set of optional components to activate on the cluster.
567 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700568 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700569 &quot;imageVersion&quot;: &quot;A String&quot;, # 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 &quot;1.2&quot; (including a subminor version, such as &quot;1.2.29&quot;), or the &quot;preview&quot; version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
570 },
571 &quot;gkeClusterConfig&quot;: { # 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.
572 &quot;namespacedGkeDeploymentTarget&quot;: { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
573 &quot;targetGkeCluster&quot;: &quot;A String&quot;, # Optional. The target GKE cluster to deploy to. Format: &#x27;projects/{project}/locations/{location}/clusters/{cluster_id}&#x27;
574 &quot;clusterNamespace&quot;: &quot;A String&quot;, # Optional. A namespace within the GKE cluster to deploy into.
575 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700576 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700577 &quot;autoscalingConfig&quot;: { # 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.
578 &quot;policyUri&quot;: &quot;A String&quot;, # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700579 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700580 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
581 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700582 &quot;endpointConfig&quot;: { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
583 &quot;httpPorts&quot;: { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
584 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700585 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700586 &quot;enableHttpPortAccess&quot;: True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700587 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700588 &quot;masterConfig&quot;: { # 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.
589 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
590 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
591 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
592 &quot;numLocalSsds&quot;: 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 -0700593 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700594 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
595 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700596 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
597 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700598 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700599 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -0700600 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
601 # projects/[project_id]/global/images/[image-id]
602 # image-idImage family examples. Dataproc will use the most recent image from the family:
603 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
604 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700605 &quot;managedGroupConfig&quot;: { # 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.
606 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
607 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
608 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700609 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700610 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
611 &quot;A String&quot;,
612 ],
613 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700614 { # 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 Kim65020912020-05-20 12:08:20 -0700615 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
616 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700617 },
618 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700619 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
620 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
621 },
622 &quot;encryptionConfig&quot;: { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
623 &quot;gcePdKmsKeyName&quot;: &quot;A String&quot;, # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
624 },
625 &quot;securityConfig&quot;: { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
626 &quot;kerberosConfig&quot;: { # Specifies Kerberos related configuration. # Kerberos related configuration.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700627 &quot;crossRealmTrustRealm&quot;: &quot;A String&quot;, # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
628 &quot;rootPrincipalPasswordUri&quot;: &quot;A String&quot;, # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
629 &quot;kmsKeyUri&quot;: &quot;A String&quot;, # Required. The uri of the KMS key used to encrypt various sensitive files.
630 &quot;crossRealmTrustKdc&quot;: &quot;A String&quot;, # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
631 &quot;crossRealmTrustSharedPasswordUri&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700632 &quot;tgtLifetimeHours&quot;: 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.
633 &quot;keystoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
634 &quot;keyPasswordUri&quot;: &quot;A String&quot;, # 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.
635 &quot;keystorePasswordUri&quot;: &quot;A String&quot;, # 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.
636 &quot;crossRealmTrustAdminServer&quot;: &quot;A String&quot;, # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
637 &quot;kdcDbKeyUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
638 &quot;truststorePasswordUri&quot;: &quot;A String&quot;, # 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.
639 &quot;realm&quot;: &quot;A String&quot;, # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
640 &quot;enableKerberos&quot;: 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.
641 &quot;truststoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700642 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700643 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700644 &quot;initializationActions&quot;: [ # 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&#x27;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 -0700645 # ROLE=$(curl -H Metadata-Flavor:Google
646 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
Bu Sun Kim65020912020-05-20 12:08:20 -0700647 # if [[ &quot;${ROLE}&quot; == &#x27;Master&#x27; ]]; then
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700648 # ... master specific actions ...
649 # else
650 # ... worker specific actions ...
651 # fi
652 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700653 &quot;executionTimeout&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -0700654 &quot;executableFile&quot;: &quot;A String&quot;, # Required. Cloud Storage URI of executable file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700655 },
656 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700657 &quot;lifecycleConfig&quot;: { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Bu Sun Kim65020912020-05-20 12:08:20 -0700658 &quot;idleDeleteTtl&quot;: &quot;A String&quot;, # 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).
659 &quot;autoDeleteTtl&quot;: &quot;A String&quot;, # 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)).
660 &quot;idleStartTime&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -0700661 &quot;autoDeleteTime&quot;: &quot;A String&quot;, # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700662 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700663 &quot;workerConfig&quot;: { # 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.
664 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
665 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
666 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
667 &quot;numLocalSsds&quot;: 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.
668 },
669 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
670 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700671 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
672 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700673 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700674 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -0700675 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700680 &quot;managedGroupConfig&quot;: { # 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.
681 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
682 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
683 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700684 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
685 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
686 &quot;A String&quot;,
687 ],
688 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
689 { # 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/)).
690 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
691 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
692 },
693 ],
694 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
695 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
696 },
697 &quot;secondaryWorkerConfig&quot;: { # 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.
698 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
699 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
700 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
701 &quot;numLocalSsds&quot;: 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.
702 },
703 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
704 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
705 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
706 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
707 # 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.
708 &quot;imageUri&quot;: &quot;A String&quot;, # 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 &quot;managedGroupConfig&quot;: { # 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.
715 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
716 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
717 },
718 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700719 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
720 &quot;A String&quot;,
721 ],
722 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700723 { # 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 Kim65020912020-05-20 12:08:20 -0700724 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
725 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700726 },
727 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700728 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
729 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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 -0700730 },
731 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700732 &quot;clusterName&quot;: &quot;A String&quot;, # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
733 &quot;clusterUuid&quot;: &quot;A String&quot;, # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
734 &quot;projectId&quot;: &quot;A String&quot;, # Required. The Google Cloud Platform project ID that the cluster belongs to.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700735 &quot;labels&quot;: { # 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.
736 &quot;a_key&quot;: &quot;A String&quot;,
737 },
738 &quot;metrics&quot;: { # 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.
739 &quot;hdfsMetrics&quot;: { # The HDFS metrics.
740 &quot;a_key&quot;: &quot;A String&quot;,
741 },
742 &quot;yarnMetrics&quot;: { # The YARN metrics.
743 &quot;a_key&quot;: &quot;A String&quot;,
744 },
745 },
746 &quot;status&quot;: { # The status of a cluster and its instances. # Output only. Cluster status.
747 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
748 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
749 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
750 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
751 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700752 }</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)
Bu Sun Kim65020912020-05-20 12:08:20 -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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
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
Bu Sun Kim65020912020-05-20 12:08:20 -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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700771 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700772 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700773 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700774 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
775 # &quot;members&quot;: [
776 # &quot;user:mike@example.com&quot;,
777 # &quot;group:admins@example.com&quot;,
778 # &quot;domain:google.com&quot;,
779 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700780 # ]
781 # },
782 # {
Bu Sun Kim65020912020-05-20 12:08:20 -0700783 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
784 # &quot;members&quot;: [
785 # &quot;user:eve@example.com&quot;
786 # ],
787 # &quot;condition&quot;: {
788 # &quot;title&quot;: &quot;expirable access&quot;,
789 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
790 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700791 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700792 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700793 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700794 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
795 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700796 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700797 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700798 # bindings:
799 # - members:
800 # - user:mike@example.com
801 # - group:admins@example.com
802 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700803 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
804 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700805 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700806 # - user:eve@example.com
807 # role: roles/resourcemanager.organizationViewer
808 # condition:
809 # title: expirable access
810 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -0700811 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -0700812 # - etag: BwWWja0YfJA=
813 # - version: 3
814 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -0700815 &quot;bindings&quot;: [ # 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 -0700816 { # Associates members with a role.
Bu Sun Kim65020912020-05-20 12:08:20 -0700817 &quot;condition&quot;: { # 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.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
818 # title: &quot;Summary size limit&quot;
819 # description: &quot;Determines if a summary is less than 100 chars&quot;
820 # expression: &quot;document.summary.size() &lt; 100&quot;
821 # Example (Equality):
822 # title: &quot;Requestor is owner&quot;
823 # description: &quot;Determines if requestor is the document owner&quot;
824 # expression: &quot;document.owner == request.auth.claims.email&quot;
825 # Example (Logic):
826 # title: &quot;Public documents&quot;
827 # description: &quot;Determine whether the document should be publicly visible&quot;
828 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
829 # Example (Data Manipulation):
830 # title: &quot;Notification string&quot;
831 # description: &quot;Create a notification string with a timestamp.&quot;
832 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
833 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700834 &quot;title&quot;: &quot;A String&quot;, # 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.
835 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700836 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
837 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim65020912020-05-20 12:08:20 -0700838 },
839 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700840 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
841 # 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 -0700842 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700843 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
844 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -0700845 # 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.
846 # 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.
847 # 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 -0700848 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -0700849 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700850 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700851 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700852 },
853 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700854 &quot;etag&quot;: &quot;A String&quot;, # 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.
855 &quot;version&quot;: 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:
856 # Getting a policy that includes a conditional role binding
857 # Adding a conditional role binding to a policy
858 # Changing a conditional role binding in a policy
859 # 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700860 }</pre>
861</div>
862
863<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700864 <code class="details" id="list">list(projectId, region, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -0700865 <pre>Lists all regions/{region}/clusters in a project alphabetically.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700866
867Args:
868 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 -0700869 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700870 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 = *
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700871 pageToken: string, Optional. The standard List page token.
Bu Sun Kim65020912020-05-20 12:08:20 -0700872 pageSize: integer, Optional. The standard List page size.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700873 x__xgafv: string, V1 error format.
874 Allowed values
875 1 - v1 error format
876 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700877
878Returns:
879 An object of the form:
880
881 { # The list of all clusters in a project.
Bu Sun Kim65020912020-05-20 12:08:20 -0700882 &quot;clusters&quot;: [ # Output only. The clusters in the project.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700883 { # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700884 &quot;statusHistory&quot;: [ # Output only. The previous cluster status.
885 { # The status of a cluster and its instances.
886 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
887 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
888 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
889 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700890 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700891 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700892 &quot;config&quot;: { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim65020912020-05-20 12:08:20 -0700893 &quot;configBucket&quot;: &quot;A String&quot;, # 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&#x27;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)).
894 &quot;gceClusterConfig&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700895 &quot;zoneUri&quot;: &quot;A String&quot;, # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the &quot;global&quot; 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:
896 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
897 # projects/[project_id]/zones/[zone]
898 # us-central1-f
899 &quot;metadata&quot;: { # 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)).
900 &quot;a_key&quot;: &quot;A String&quot;,
901 },
902 &quot;internalIpOnly&quot;: 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.
903 &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
904 &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
905 &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
906 &quot;A String&quot;,
907 ],
908 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
909 },
910 &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
911 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
912 # https://www.googleapis.com/auth/devstorage.read_write
913 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
914 # https://www.googleapis.com/auth/bigquery
915 # https://www.googleapis.com/auth/bigtable.admin.table
916 # https://www.googleapis.com/auth/bigtable.data
917 # https://www.googleapis.com/auth/devstorage.full_control
918 &quot;A String&quot;,
919 ],
920 &quot;tags&quot;: [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
921 &quot;A String&quot;,
922 ],
923 &quot;serviceAccount&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700924 &quot;subnetworkUri&quot;: &quot;A String&quot;, # 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:
925 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
926 # projects/[project_id]/regions/us-east1/subnetworks/sub0
927 # sub0
928 &quot;networkUri&quot;: &quot;A String&quot;, # 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 &quot;default&quot; network of the project is used, if it exists. Cannot be a &quot;Custom Subnet Network&quot; (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
929 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
930 # projects/[project_id]/regions/global/default
931 # default
Bu Sun Kim65020912020-05-20 12:08:20 -0700932 },
933 &quot;softwareConfig&quot;: { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -0700934 &quot;properties&quot;: { # 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:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700935 # capacity-scheduler: capacity-scheduler.xml
936 # core: core-site.xml
937 # distcp: distcp-default.xml
938 # hdfs: hdfs-site.xml
939 # hive: hive-site.xml
940 # mapred: mapred-site.xml
941 # pig: pig.properties
942 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -0700943 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim65020912020-05-20 12:08:20 -0700944 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700945 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700946 &quot;optionalComponents&quot;: [ # The set of optional components to activate on the cluster.
947 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700948 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700949 &quot;imageVersion&quot;: &quot;A String&quot;, # 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 &quot;1.2&quot; (including a subminor version, such as &quot;1.2.29&quot;), or the &quot;preview&quot; version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
950 },
951 &quot;gkeClusterConfig&quot;: { # 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.
952 &quot;namespacedGkeDeploymentTarget&quot;: { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
953 &quot;targetGkeCluster&quot;: &quot;A String&quot;, # Optional. The target GKE cluster to deploy to. Format: &#x27;projects/{project}/locations/{location}/clusters/{cluster_id}&#x27;
954 &quot;clusterNamespace&quot;: &quot;A String&quot;, # Optional. A namespace within the GKE cluster to deploy into.
955 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700956 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700957 &quot;autoscalingConfig&quot;: { # 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.
958 &quot;policyUri&quot;: &quot;A String&quot;, # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700959 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -0700960 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
961 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700962 &quot;endpointConfig&quot;: { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
963 &quot;httpPorts&quot;: { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
964 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -0700965 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700966 &quot;enableHttpPortAccess&quot;: True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700967 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700968 &quot;masterConfig&quot;: { # 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.
969 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
970 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
971 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
972 &quot;numLocalSsds&quot;: 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 -0700973 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700974 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
975 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700976 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
977 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -0700978 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700979 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -0700980 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
981 # projects/[project_id]/global/images/[image-id]
982 # image-idImage family examples. Dataproc will use the most recent image from the family:
983 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
984 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700985 &quot;managedGroupConfig&quot;: { # 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.
986 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
987 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
988 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700989 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -0700990 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
991 &quot;A String&quot;,
992 ],
993 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -0700994 { # 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 Kim65020912020-05-20 12:08:20 -0700995 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
996 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700997 },
998 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700999 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1000 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
1001 },
1002 &quot;encryptionConfig&quot;: { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1003 &quot;gcePdKmsKeyName&quot;: &quot;A String&quot;, # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1004 },
1005 &quot;securityConfig&quot;: { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
1006 &quot;kerberosConfig&quot;: { # Specifies Kerberos related configuration. # Kerberos related configuration.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001007 &quot;crossRealmTrustRealm&quot;: &quot;A String&quot;, # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
1008 &quot;rootPrincipalPasswordUri&quot;: &quot;A String&quot;, # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
1009 &quot;kmsKeyUri&quot;: &quot;A String&quot;, # Required. The uri of the KMS key used to encrypt various sensitive files.
1010 &quot;crossRealmTrustKdc&quot;: &quot;A String&quot;, # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1011 &quot;crossRealmTrustSharedPasswordUri&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001012 &quot;tgtLifetimeHours&quot;: 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.
1013 &quot;keystoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1014 &quot;keyPasswordUri&quot;: &quot;A String&quot;, # 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.
1015 &quot;keystorePasswordUri&quot;: &quot;A String&quot;, # 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.
1016 &quot;crossRealmTrustAdminServer&quot;: &quot;A String&quot;, # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1017 &quot;kdcDbKeyUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1018 &quot;truststorePasswordUri&quot;: &quot;A String&quot;, # 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.
1019 &quot;realm&quot;: &quot;A String&quot;, # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
1020 &quot;enableKerberos&quot;: 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.
1021 &quot;truststoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001022 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001023 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001024 &quot;initializationActions&quot;: [ # 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&#x27;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 -07001025 # ROLE=$(curl -H Metadata-Flavor:Google
1026 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
Bu Sun Kim65020912020-05-20 12:08:20 -07001027 # if [[ &quot;${ROLE}&quot; == &#x27;Master&#x27; ]]; then
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001028 # ... master specific actions ...
1029 # else
1030 # ... worker specific actions ...
1031 # fi
1032 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Bu Sun Kim65020912020-05-20 12:08:20 -07001033 &quot;executionTimeout&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -07001034 &quot;executableFile&quot;: &quot;A String&quot;, # Required. Cloud Storage URI of executable file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001035 },
1036 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001037 &quot;lifecycleConfig&quot;: { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Bu Sun Kim65020912020-05-20 12:08:20 -07001038 &quot;idleDeleteTtl&quot;: &quot;A String&quot;, # 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).
1039 &quot;autoDeleteTtl&quot;: &quot;A String&quot;, # 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)).
1040 &quot;idleStartTime&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -07001041 &quot;autoDeleteTime&quot;: &quot;A String&quot;, # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001042 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001043 &quot;workerConfig&quot;: { # 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.
1044 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1045 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
1046 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
1047 &quot;numLocalSsds&quot;: 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.
1048 },
1049 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
1050 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001051 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1052 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001053 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001054 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -07001055 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1056 # projects/[project_id]/global/images/[image-id]
1057 # image-idImage family examples. Dataproc will use the most recent image from the family:
1058 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1059 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001060 &quot;managedGroupConfig&quot;: { # 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.
1061 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
1062 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
1063 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001064 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
1065 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
1066 &quot;A String&quot;,
1067 ],
1068 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
1069 { # 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/)).
1070 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
1071 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
1072 },
1073 ],
1074 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1075 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
1076 },
1077 &quot;secondaryWorkerConfig&quot;: { # 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.
1078 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1079 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
1080 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
1081 &quot;numLocalSsds&quot;: 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.
1082 },
1083 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
1084 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1085 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1086 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1087 # 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.
1088 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1089 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1090 # projects/[project_id]/global/images/[image-id]
1091 # image-idImage family examples. Dataproc will use the most recent image from the family:
1092 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1093 # 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.
1094 &quot;managedGroupConfig&quot;: { # 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.
1095 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
1096 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
1097 },
1098 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -07001099 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
1100 &quot;A String&quot;,
1101 ],
1102 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -07001103 { # 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 Kim65020912020-05-20 12:08:20 -07001104 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
1105 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001106 },
1107 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001108 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1109 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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 -07001110 },
1111 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001112 &quot;clusterName&quot;: &quot;A String&quot;, # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
1113 &quot;clusterUuid&quot;: &quot;A String&quot;, # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
1114 &quot;projectId&quot;: &quot;A String&quot;, # Required. The Google Cloud Platform project ID that the cluster belongs to.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001115 &quot;labels&quot;: { # 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.
1116 &quot;a_key&quot;: &quot;A String&quot;,
1117 },
1118 &quot;metrics&quot;: { # 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.
1119 &quot;hdfsMetrics&quot;: { # The HDFS metrics.
1120 &quot;a_key&quot;: &quot;A String&quot;,
1121 },
1122 &quot;yarnMetrics&quot;: { # The YARN metrics.
1123 &quot;a_key&quot;: &quot;A String&quot;,
1124 },
1125 },
1126 &quot;status&quot;: { # The status of a cluster and its instances. # Output only. Cluster status.
1127 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
1128 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
1129 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1130 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
1131 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001132 },
1133 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001134 &quot;nextPageToken&quot;: &quot;A String&quot;, # 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 -07001135 }</pre>
1136</div>
1137
1138<div class="method">
1139 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
1140 <pre>Retrieves the next page of results.
1141
1142Args:
1143 previous_request: The request for the previous page. (required)
1144 previous_response: The response from the request for the previous page. (required)
1145
1146Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -07001147 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001148 page. Returns None if there are no more items in the collection.
1149 </pre>
1150</div>
1151
1152<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001153 <code class="details" id="patch">patch(projectId, region, clusterName, body=None, updateMask=None, gracefulDecommissionTimeout=None, requestId=None, x__xgafv=None)</code>
Dan O'Mearadd494642020-05-01 07:42:23 -07001154 <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 -07001155
1156Args:
1157 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001158 region: string, Required. The Dataproc region in which to handle the request. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001159 clusterName: string, Required. The cluster name. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -07001160 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001161 The object takes the form of:
1162
1163{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001164 &quot;statusHistory&quot;: [ # Output only. The previous cluster status.
1165 { # The status of a cluster and its instances.
1166 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
1167 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
1168 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1169 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001170 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001171 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001172 &quot;config&quot;: { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.
Bu Sun Kim65020912020-05-20 12:08:20 -07001173 &quot;configBucket&quot;: &quot;A String&quot;, # 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&#x27;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)).
1174 &quot;gceClusterConfig&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001175 &quot;zoneUri&quot;: &quot;A String&quot;, # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the &quot;global&quot; 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:
1176 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]
1177 # projects/[project_id]/zones/[zone]
1178 # us-central1-f
1179 &quot;metadata&quot;: { # 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)).
1180 &quot;a_key&quot;: &quot;A String&quot;,
1181 },
1182 &quot;internalIpOnly&quot;: 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.
1183 &quot;reservationAffinity&quot;: { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.
1184 &quot;key&quot;: &quot;A String&quot;, # Optional. Corresponds to the label key of reservation resource.
1185 &quot;values&quot;: [ # Optional. Corresponds to the label values of reservation resource.
1186 &quot;A String&quot;,
1187 ],
1188 &quot;consumeReservationType&quot;: &quot;A String&quot;, # Optional. Type of reservation to consume
1189 },
1190 &quot;serviceAccountScopes&quot;: [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
1191 # https://www.googleapis.com/auth/cloud.useraccounts.readonly
1192 # https://www.googleapis.com/auth/devstorage.read_write
1193 # https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:
1194 # https://www.googleapis.com/auth/bigquery
1195 # https://www.googleapis.com/auth/bigtable.admin.table
1196 # https://www.googleapis.com/auth/bigtable.data
1197 # https://www.googleapis.com/auth/devstorage.full_control
1198 &quot;A String&quot;,
1199 ],
1200 &quot;tags&quot;: [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).
1201 &quot;A String&quot;,
1202 ],
1203 &quot;serviceAccount&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001204 &quot;subnetworkUri&quot;: &quot;A String&quot;, # 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:
1205 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0
1206 # projects/[project_id]/regions/us-east1/subnetworks/sub0
1207 # sub0
1208 &quot;networkUri&quot;: &quot;A String&quot;, # 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 &quot;default&quot; network of the project is used, if it exists. Cannot be a &quot;Custom Subnet Network&quot; (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:
1209 # https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default
1210 # projects/[project_id]/regions/global/default
1211 # default
Bu Sun Kim65020912020-05-20 12:08:20 -07001212 },
1213 &quot;softwareConfig&quot;: { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -07001214 &quot;properties&quot;: { # 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:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001215 # capacity-scheduler: capacity-scheduler.xml
1216 # core: core-site.xml
1217 # distcp: distcp-default.xml
1218 # hdfs: hdfs-site.xml
1219 # hive: hive-site.xml
1220 # mapred: mapred-site.xml
1221 # pig: pig.properties
1222 # spark: spark-defaults.conf
Dan O'Mearadd494642020-05-01 07:42:23 -07001223 # yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).
Bu Sun Kim65020912020-05-20 12:08:20 -07001224 &quot;a_key&quot;: &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001225 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001226 &quot;optionalComponents&quot;: [ # The set of optional components to activate on the cluster.
1227 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001228 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001229 &quot;imageVersion&quot;: &quot;A String&quot;, # 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 &quot;1.2&quot; (including a subminor version, such as &quot;1.2.29&quot;), or the &quot;preview&quot; version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
1230 },
1231 &quot;gkeClusterConfig&quot;: { # 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.
1232 &quot;namespacedGkeDeploymentTarget&quot;: { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.
1233 &quot;targetGkeCluster&quot;: &quot;A String&quot;, # Optional. The target GKE cluster to deploy to. Format: &#x27;projects/{project}/locations/{location}/clusters/{cluster_id}&#x27;
1234 &quot;clusterNamespace&quot;: &quot;A String&quot;, # Optional. A namespace within the GKE cluster to deploy into.
1235 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001236 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001237 &quot;autoscalingConfig&quot;: { # 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.
1238 &quot;policyUri&quot;: &quot;A String&quot;, # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001239 # https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]
Dan O'Mearadd494642020-05-01 07:42:23 -07001240 # projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.
1241 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001242 &quot;endpointConfig&quot;: { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster
1243 &quot;httpPorts&quot;: { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.
1244 &quot;a_key&quot;: &quot;A String&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -07001245 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001246 &quot;enableHttpPortAccess&quot;: True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001247 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001248 &quot;masterConfig&quot;: { # 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.
1249 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1250 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
1251 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
1252 &quot;numLocalSsds&quot;: 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 -07001253 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001254 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
1255 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001256 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1257 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001258 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001259 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -07001260 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1261 # projects/[project_id]/global/images/[image-id]
1262 # image-idImage family examples. Dataproc will use the most recent image from the family:
1263 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1264 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001265 &quot;managedGroupConfig&quot;: { # 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.
1266 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
1267 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
1268 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001269 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -07001270 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
1271 &quot;A String&quot;,
1272 ],
1273 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -07001274 { # 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 Kim65020912020-05-20 12:08:20 -07001275 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
1276 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001277 },
1278 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001279 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1280 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
1281 },
1282 &quot;encryptionConfig&quot;: { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.
1283 &quot;gcePdKmsKeyName&quot;: &quot;A String&quot;, # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
1284 },
1285 &quot;securityConfig&quot;: { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.
1286 &quot;kerberosConfig&quot;: { # Specifies Kerberos related configuration. # Kerberos related configuration.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001287 &quot;crossRealmTrustRealm&quot;: &quot;A String&quot;, # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
1288 &quot;rootPrincipalPasswordUri&quot;: &quot;A String&quot;, # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
1289 &quot;kmsKeyUri&quot;: &quot;A String&quot;, # Required. The uri of the KMS key used to encrypt various sensitive files.
1290 &quot;crossRealmTrustKdc&quot;: &quot;A String&quot;, # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1291 &quot;crossRealmTrustSharedPasswordUri&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001292 &quot;tgtLifetimeHours&quot;: 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.
1293 &quot;keystoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
1294 &quot;keyPasswordUri&quot;: &quot;A String&quot;, # 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.
1295 &quot;keystorePasswordUri&quot;: &quot;A String&quot;, # 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.
1296 &quot;crossRealmTrustAdminServer&quot;: &quot;A String&quot;, # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
1297 &quot;kdcDbKeyUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
1298 &quot;truststorePasswordUri&quot;: &quot;A String&quot;, # 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.
1299 &quot;realm&quot;: &quot;A String&quot;, # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
1300 &quot;enableKerberos&quot;: 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.
1301 &quot;truststoreUri&quot;: &quot;A String&quot;, # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001302 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001303 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001304 &quot;initializationActions&quot;: [ # 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&#x27;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 -07001305 # ROLE=$(curl -H Metadata-Flavor:Google
1306 # http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)
Bu Sun Kim65020912020-05-20 12:08:20 -07001307 # if [[ &quot;${ROLE}&quot; == &#x27;Master&#x27; ]]; then
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001308 # ... master specific actions ...
1309 # else
1310 # ... worker specific actions ...
1311 # fi
1312 { # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Bu Sun Kim65020912020-05-20 12:08:20 -07001313 &quot;executionTimeout&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -07001314 &quot;executableFile&quot;: &quot;A String&quot;, # Required. Cloud Storage URI of executable file.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001315 },
1316 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001317 &quot;lifecycleConfig&quot;: { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.
Bu Sun Kim65020912020-05-20 12:08:20 -07001318 &quot;idleDeleteTtl&quot;: &quot;A String&quot;, # 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).
1319 &quot;autoDeleteTtl&quot;: &quot;A String&quot;, # 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)).
1320 &quot;idleStartTime&quot;: &quot;A String&quot;, # 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 Kim4ed7d3f2020-05-27 12:20:54 -07001321 &quot;autoDeleteTime&quot;: &quot;A String&quot;, # Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001322 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001323 &quot;workerConfig&quot;: { # 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.
1324 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1325 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
1326 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
1327 &quot;numLocalSsds&quot;: 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.
1328 },
1329 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
1330 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001331 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1332 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
Dan O'Mearadd494642020-05-01 07:42:23 -07001333 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001334 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
Dan O'Mearadd494642020-05-01 07:42:23 -07001335 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1336 # projects/[project_id]/global/images/[image-id]
1337 # image-idImage family examples. Dataproc will use the most recent image from the family:
1338 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1339 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001340 &quot;managedGroupConfig&quot;: { # 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.
1341 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
1342 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
1343 },
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001344 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
1345 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
1346 &quot;A String&quot;,
1347 ],
1348 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
1349 { # 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/)).
1350 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
1351 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
1352 },
1353 ],
1354 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1355 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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).
1356 },
1357 &quot;secondaryWorkerConfig&quot;: { # 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.
1358 &quot;diskConfig&quot;: { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.
1359 &quot;bootDiskSizeGb&quot;: 42, # Optional. Size in GB of the boot disk (default is 500GB).
1360 &quot;bootDiskType&quot;: &quot;A String&quot;, # Optional. Type of the boot disk (default is &quot;pd-standard&quot;). Valid values: &quot;pd-ssd&quot; (Persistent Disk Solid State Drive) or &quot;pd-standard&quot; (Persistent Disk Hard Disk Drive).
1361 &quot;numLocalSsds&quot;: 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.
1362 },
1363 &quot;preemptibility&quot;: &quot;A String&quot;, # 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.
1364 &quot;machineTypeUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:
1365 # https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1366 # projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2
1367 # 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.
1368 &quot;imageUri&quot;: &quot;A String&quot;, # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:
1369 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]
1370 # projects/[project_id]/global/images/[image-id]
1371 # image-idImage family examples. Dataproc will use the most recent image from the family:
1372 # https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]
1373 # 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.
1374 &quot;managedGroupConfig&quot;: { # 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.
1375 &quot;instanceGroupManagerName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Group Manager for this group.
1376 &quot;instanceTemplateName&quot;: &quot;A String&quot;, # Output only. The name of the Instance Template used for the Managed Instance Group.
1377 },
1378 &quot;isPreemptible&quot;: True or False, # Output only. Specifies that this instance group contains preemptible instances.
Bu Sun Kim65020912020-05-20 12:08:20 -07001379 &quot;instanceNames&quot;: [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.
1380 &quot;A String&quot;,
1381 ],
1382 &quot;accelerators&quot;: [ # Optional. The Compute Engine accelerator configuration for these instances.
Dan O'Mearadd494642020-05-01 07:42:23 -07001383 { # 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 Kim65020912020-05-20 12:08:20 -07001384 &quot;acceleratorTypeUri&quot;: &quot;A String&quot;, # 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.
1385 &quot;acceleratorCount&quot;: 42, # The number of the accelerator cards of this type exposed to this instance.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001386 },
1387 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001388 &quot;numInstances&quot;: 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
1389 &quot;minCpuPlatform&quot;: &quot;A String&quot;, # 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 -07001390 },
1391 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001392 &quot;clusterName&quot;: &quot;A String&quot;, # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
1393 &quot;clusterUuid&quot;: &quot;A String&quot;, # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.
1394 &quot;projectId&quot;: &quot;A String&quot;, # Required. The Google Cloud Platform project ID that the cluster belongs to.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001395 &quot;labels&quot;: { # 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.
1396 &quot;a_key&quot;: &quot;A String&quot;,
1397 },
1398 &quot;metrics&quot;: { # 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.
1399 &quot;hdfsMetrics&quot;: { # The HDFS metrics.
1400 &quot;a_key&quot;: &quot;A String&quot;,
1401 },
1402 &quot;yarnMetrics&quot;: { # The YARN metrics.
1403 &quot;a_key&quot;: &quot;A String&quot;,
1404 },
1405 },
1406 &quot;status&quot;: { # The status of a cluster and its instances. # Output only. Cluster status.
1407 &quot;detail&quot;: &quot;A String&quot;, # Output only. Optional details of cluster&#x27;s state.
1408 &quot;state&quot;: &quot;A String&quot;, # Output only. The cluster&#x27;s state.
1409 &quot;stateStartTime&quot;: &quot;A String&quot;, # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).
1410 &quot;substate&quot;: &quot;A String&quot;, # Output only. Additional state information that includes status reported by the agent.
1411 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001412}
1413
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001414 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:
1415{
Bu Sun Kim65020912020-05-20 12:08:20 -07001416 &quot;config&quot;:{
1417 &quot;workerConfig&quot;:{
1418 &quot;numInstances&quot;:&quot;5&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001419 }
1420 }
1421}
1422Similarly, 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:
1423{
Bu Sun Kim65020912020-05-20 12:08:20 -07001424 &quot;config&quot;:{
1425 &quot;secondaryWorkerConfig&quot;:{
1426 &quot;numInstances&quot;:&quot;5&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001427 }
1428 }
1429}
Dan O'Mearadd494642020-05-01 07:42:23 -07001430&lt;strong&gt;Note:&lt;/strong&gt; currently only the following fields can be updated:
1431&lt;table&gt;
1432&lt;tr&gt;
1433&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;
1434&lt;/tr&gt;
1435&lt;tr&gt;
1436&lt;td&gt;labels&lt;/td&gt;&lt;td&gt;Updates labels&lt;/td&gt;
1437&lt;/tr&gt;
1438&lt;tr&gt;
1439&lt;td&gt;config.worker_config.num_instances&lt;/td&gt;&lt;td&gt;Resize primary worker
1440group&lt;/td&gt;
1441&lt;/tr&gt;
1442&lt;tr&gt;
1443&lt;td&gt;config.secondary_worker_config.num_instances&lt;/td&gt;&lt;td&gt;Resize secondary
1444worker group&lt;/td&gt;
1445&lt;/tr&gt;
1446&lt;tr&gt;
1447&lt;td&gt;config.lifecycle_config.auto_delete_ttl&lt;/td&gt;&lt;td&gt;Reset MAX TTL
1448duration&lt;/td&gt;
1449&lt;/tr&gt;
1450&lt;tr&gt;
1451&lt;td&gt;config.lifecycle_config.auto_delete_time&lt;/td&gt;&lt;td&gt;Update MAX TTL
1452deletion timestamp&lt;/td&gt;
1453&lt;/tr&gt;
1454&lt;tr&gt;
1455&lt;td&gt;config.lifecycle_config.idle_delete_ttl&lt;/td&gt;&lt;td&gt;Update Idle TTL
1456duration&lt;/td&gt;
1457&lt;/tr&gt;
1458&lt;tr&gt;
1459&lt;td&gt;config.autoscaling_config.policy_uri&lt;/td&gt;&lt;td&gt;Use, stop using, or change
1460autoscaling policies&lt;/td&gt;
1461&lt;/tr&gt;
1462&lt;/table&gt;
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001463 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.
1464 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001465 x__xgafv: string, V1 error format.
1466 Allowed values
1467 1 - v1 error format
1468 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001469
1470Returns:
1471 An object of the form:
1472
1473 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001474 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001475 &quot;response&quot;: { # 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.
1476 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001477 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001478 &quot;name&quot;: &quot;A String&quot;, # 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}.
1479 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001480 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001481 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001482 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001483 },
1484 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001485 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1486 &quot;message&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001487 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001488 &quot;metadata&quot;: { # 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.
1489 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001490 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001491 }</pre>
1492</div>
1493
1494<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001495 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -07001496 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001497
1498Args:
1499 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 -07001500 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001501 The object takes the form of:
1502
1503{ # Request message for SetIamPolicy method.
Bu Sun Kim65020912020-05-20 12:08:20 -07001504 &quot;policy&quot;: { # 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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).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 -07001505 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001506 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001507 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001508 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1509 # &quot;members&quot;: [
1510 # &quot;user:mike@example.com&quot;,
1511 # &quot;group:admins@example.com&quot;,
1512 # &quot;domain:google.com&quot;,
1513 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001514 # ]
1515 # },
1516 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001517 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1518 # &quot;members&quot;: [
1519 # &quot;user:eve@example.com&quot;
1520 # ],
1521 # &quot;condition&quot;: {
1522 # &quot;title&quot;: &quot;expirable access&quot;,
1523 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1524 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -07001525 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001526 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001527 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001528 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1529 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001530 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001531 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001532 # bindings:
1533 # - members:
1534 # - user:mike@example.com
1535 # - group:admins@example.com
1536 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001537 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1538 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001539 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001540 # - user:eve@example.com
1541 # role: roles/resourcemanager.organizationViewer
1542 # condition:
1543 # title: expirable access
1544 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -07001545 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -07001546 # - etag: BwWWja0YfJA=
1547 # - version: 3
1548 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -07001549 &quot;bindings&quot;: [ # 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 -07001550 { # Associates members with a role.
Bu Sun Kim65020912020-05-20 12:08:20 -07001551 &quot;condition&quot;: { # 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.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
1552 # title: &quot;Summary size limit&quot;
1553 # description: &quot;Determines if a summary is less than 100 chars&quot;
1554 # expression: &quot;document.summary.size() &lt; 100&quot;
1555 # Example (Equality):
1556 # title: &quot;Requestor is owner&quot;
1557 # description: &quot;Determines if requestor is the document owner&quot;
1558 # expression: &quot;document.owner == request.auth.claims.email&quot;
1559 # Example (Logic):
1560 # title: &quot;Public documents&quot;
1561 # description: &quot;Determine whether the document should be publicly visible&quot;
1562 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1563 # Example (Data Manipulation):
1564 # title: &quot;Notification string&quot;
1565 # description: &quot;Create a notification string with a timestamp.&quot;
1566 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1567 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001568 &quot;title&quot;: &quot;A String&quot;, # 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.
1569 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001570 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1571 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim65020912020-05-20 12:08:20 -07001572 },
1573 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001574 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1575 # 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 -07001576 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001577 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1578 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -07001579 # 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.
1580 # 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.
1581 # 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 -07001582 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -07001583 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001584 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001585 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001586 },
1587 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001588 &quot;etag&quot;: &quot;A String&quot;, # 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.
1589 &quot;version&quot;: 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:
1590 # Getting a policy that includes a conditional role binding
1591 # Adding a conditional role binding to a policy
1592 # Changing a conditional role binding in a policy
1593 # 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001594 },
1595 }
1596
1597 x__xgafv: string, V1 error format.
1598 Allowed values
1599 1 - v1 error format
1600 2 - v2 error format
1601
1602Returns:
1603 An object of the form:
1604
Bu Sun Kim65020912020-05-20 12:08:20 -07001605 { # 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.For some types of Google Cloud resources, a binding can also 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. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001606 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001607 # &quot;bindings&quot;: [
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001608 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001609 # &quot;role&quot;: &quot;roles/resourcemanager.organizationAdmin&quot;,
1610 # &quot;members&quot;: [
1611 # &quot;user:mike@example.com&quot;,
1612 # &quot;group:admins@example.com&quot;,
1613 # &quot;domain:google.com&quot;,
1614 # &quot;serviceAccount:my-project-id@appspot.gserviceaccount.com&quot;
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001615 # ]
1616 # },
1617 # {
Bu Sun Kim65020912020-05-20 12:08:20 -07001618 # &quot;role&quot;: &quot;roles/resourcemanager.organizationViewer&quot;,
1619 # &quot;members&quot;: [
1620 # &quot;user:eve@example.com&quot;
1621 # ],
1622 # &quot;condition&quot;: {
1623 # &quot;title&quot;: &quot;expirable access&quot;,
1624 # &quot;description&quot;: &quot;Does not grant access after Sep 2020&quot;,
1625 # &quot;expression&quot;: &quot;request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)&quot;,
Dan O'Mearadd494642020-05-01 07:42:23 -07001626 # }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001627 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001628 # ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001629 # &quot;etag&quot;: &quot;BwWWja0YfJA=&quot;,
1630 # &quot;version&quot;: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001631 # }
Dan O'Mearadd494642020-05-01 07:42:23 -07001632 # YAML example:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001633 # bindings:
1634 # - members:
1635 # - user:mike@example.com
1636 # - group:admins@example.com
1637 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -07001638 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1639 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001640 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -07001641 # - user:eve@example.com
1642 # role: roles/resourcemanager.organizationViewer
1643 # condition:
1644 # title: expirable access
1645 # description: Does not grant access after Sep 2020
Bu Sun Kim65020912020-05-20 12:08:20 -07001646 # expression: request.time &lt; timestamp(&#x27;2020-10-01T00:00:00.000Z&#x27;)
Dan O'Mearadd494642020-05-01 07:42:23 -07001647 # - etag: BwWWja0YfJA=
1648 # - version: 3
1649 # For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
Bu Sun Kim65020912020-05-20 12:08:20 -07001650 &quot;bindings&quot;: [ # 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 -07001651 { # Associates members with a role.
Bu Sun Kim65020912020-05-20 12:08:20 -07001652 &quot;condition&quot;: { # 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.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
1653 # title: &quot;Summary size limit&quot;
1654 # description: &quot;Determines if a summary is less than 100 chars&quot;
1655 # expression: &quot;document.summary.size() &lt; 100&quot;
1656 # Example (Equality):
1657 # title: &quot;Requestor is owner&quot;
1658 # description: &quot;Determines if requestor is the document owner&quot;
1659 # expression: &quot;document.owner == request.auth.claims.email&quot;
1660 # Example (Logic):
1661 # title: &quot;Public documents&quot;
1662 # description: &quot;Determine whether the document should be publicly visible&quot;
1663 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
1664 # Example (Data Manipulation):
1665 # title: &quot;Notification string&quot;
1666 # description: &quot;Create a notification string with a timestamp.&quot;
1667 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
1668 # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001669 &quot;title&quot;: &quot;A String&quot;, # 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.
1670 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001671 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
1672 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
Bu Sun Kim65020912020-05-20 12:08:20 -07001673 },
1674 &quot;members&quot;: [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001675 # allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.
1676 # 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 -07001677 # user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001678 # serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.
1679 # group:{emailid}: An email address that represents a Google group. For example, admins@example.com.
Dan O'Mearadd494642020-05-01 07:42:23 -07001680 # 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.
1681 # 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.
1682 # 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 -07001683 # domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
Bu Sun Kim65020912020-05-20 12:08:20 -07001684 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001685 ],
Bu Sun Kim65020912020-05-20 12:08:20 -07001686 &quot;role&quot;: &quot;A String&quot;, # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001687 },
1688 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001689 &quot;etag&quot;: &quot;A String&quot;, # 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.
1690 &quot;version&quot;: 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:
1691 # Getting a policy that includes a conditional role binding
1692 # Adding a conditional role binding to a policy
1693 # Changing a conditional role binding in a policy
1694 # 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.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001695 }</pre>
1696</div>
1697
1698<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -07001699 <code class="details" id="start">start(projectId, region, clusterName, body=None, x__xgafv=None)</code>
1700 <pre>Starts a cluster in a project.
1701
1702Args:
1703 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
1704 region: string, Required. The Dataproc region in which to handle the request. (required)
1705 clusterName: string, Required. The cluster name. (required)
1706 body: object, The request body.
1707 The object takes the form of:
1708
1709{ # A request to start a cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -07001710 &quot;clusterUuid&quot;: &quot;A String&quot;, # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001711 &quot;requestId&quot;: &quot;A String&quot;, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001712 }
1713
1714 x__xgafv: string, V1 error format.
1715 Allowed values
1716 1 - v1 error format
1717 2 - v2 error format
1718
1719Returns:
1720 An object of the form:
1721
1722 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001723 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001724 &quot;response&quot;: { # 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.
1725 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001726 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001727 &quot;name&quot;: &quot;A String&quot;, # 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}.
1728 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001729 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Dan O'Mearadd494642020-05-01 07:42:23 -07001730 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001731 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001732 },
1733 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001734 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1735 &quot;message&quot;: &quot;A String&quot;, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001736 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001737 &quot;metadata&quot;: { # 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.
1738 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001739 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001740 }</pre>
1741</div>
1742
1743<div class="method">
1744 <code class="details" id="stop">stop(projectId, region, clusterName, body=None, x__xgafv=None)</code>
1745 <pre>Stops a cluster in a project.
1746
1747Args:
1748 projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)
1749 region: string, Required. The Dataproc region in which to handle the request. (required)
1750 clusterName: string, Required. The cluster name. (required)
1751 body: object, The request body.
1752 The object takes the form of:
1753
1754{ # A request to stop a cluster.
Bu Sun Kim65020912020-05-20 12:08:20 -07001755 &quot;requestId&quot;: &quot;A String&quot;, # 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.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001756 &quot;clusterUuid&quot;: &quot;A String&quot;, # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
Dan O'Mearadd494642020-05-01 07:42:23 -07001757 }
1758
1759 x__xgafv: string, V1 error format.
1760 Allowed values
1761 1 - v1 error format
1762 2 - v2 error format
1763
1764Returns:
1765 An object of the form:
1766
1767 { # This resource represents a long-running operation that is the result of a network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001768 &quot;done&quot;: 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001769 &quot;response&quot;: { # 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.
1770 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001771 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001772 &quot;name&quot;: &quot;A String&quot;, # 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}.
1773 &quot;error&quot;: { # 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.
Bu Sun Kim65020912020-05-20 12:08:20 -07001774 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
Dan O'Mearadd494642020-05-01 07:42:23 -07001775 {
Bu Sun Kim65020912020-05-20 12:08:20 -07001776 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001777 },
1778 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -07001779 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
1780 &quot;message&quot;: &quot;A String&quot;, # 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.
Dan O'Mearadd494642020-05-01 07:42:23 -07001781 },
Bu Sun Kim65020912020-05-20 12:08:20 -07001782 &quot;metadata&quot;: { # 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.
1783 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Dan O'Mearadd494642020-05-01 07:42:23 -07001784 },
Dan O'Mearadd494642020-05-01 07:42:23 -07001785 }</pre>
1786</div>
1787
1788<div class="method">
1789 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -07001790 <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 &quot;fail open&quot; without warning.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001791
1792Args:
1793 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 -07001794 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001795 The object takes the form of:
1796
1797{ # Request message for TestIamPermissions method.
Bu Sun Kim65020912020-05-20 12:08:20 -07001798 &quot;permissions&quot;: [ # The set of permissions to check for the resource. Permissions with wildcards (such as &#x27;*&#x27; or &#x27;storage.*&#x27;) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
1799 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001800 ],
1801 }
1802
1803 x__xgafv: string, V1 error format.
1804 Allowed values
1805 1 - v1 error format
1806 2 - v2 error format
1807
1808Returns:
1809 An object of the form:
1810
1811 { # Response message for TestIamPermissions method.
Bu Sun Kim65020912020-05-20 12:08:20 -07001812 &quot;permissions&quot;: [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
1813 &quot;A String&quot;,
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001814 ],
1815 }</pre>
1816</div>
1817
1818</body></html>