Blame - docs/dyn/dataproc_v1.projects.regions.clusters.html - platform/external/python/google-api-python-client

2016-02-19 16:02:29 -0800

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

78

<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.v1#clusteroperationmetadata).</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

80

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

81

<code><a href="#delete">delete(projectId, region, clusterName, requestId=None, clusterUuid=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

82

<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.v1#clusteroperationmetadata).</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

83

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

84

<code><a href="#diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

85

<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.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

86

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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

90

<code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

91

<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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

93

<code><a href="#list">list(projectId, region, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

94

<p class="firstline">Lists all regions/{region}/clusters in a project alphabetically.</p>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

95

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

99

<code><a href="#patch">patch(projectId, region, clusterName, body=None, updateMask=None, gracefulDecommissionTimeout=None, requestId=None, x__xgafv=None)</a></code></p>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

100

<p class="firstline">Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

102

<code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

103

<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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

104

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

105

<code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

106

<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>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

107

<h3>Method Details</h3>

108

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

109

<code class="details" id="create">create(projectId, region, body=None, requestId=None, x__xgafv=None)</code>

110

<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.v1#clusteroperationmetadata).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

111

112

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

113

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

region: string, Required. The Dataproc region in which to handle the request. (required)

115

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

116

The object takes the form of:

117

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

118

{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

119

"projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.

120

"clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

121

"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # 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.

122

"yarnMetrics": { # The YARN metrics.

123

"a_key": "A String",

124

},

125

"hdfsMetrics": { # The HDFS metrics.

126

"a_key": "A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

127

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

128

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

129

"statusHistory": [ # Output only. The previous cluster status.

130

{ # The status of a cluster and its instances.

131

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

132

"state": "A String", # Output only. The cluster's state.

133

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

134

"detail": "A String", # Optional. Output only. Details of cluster's state.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

135

},

136

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

137

"config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.

138

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

139

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

140

"A String",

141

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

142

"properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:

143

# capacity-scheduler: capacity-scheduler.xml

144

# core: core-site.xml

145

# distcp: distcp-default.xml

146

# hdfs: hdfs-site.xml

147

# hive: hive-site.xml

148

# mapred: mapred-site.xml

149

# pig: pig.properties

150

# spark: spark-defaults.conf

151

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

152

"a_key": "A String",

153

},

154

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

155

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

156

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

157

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

158

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

159

"secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

160

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

161

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

162

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

163

# 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.

164

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

165

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

166

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

167

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

168

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

169

},

170

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

171

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

172

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

173

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

174

},

175

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

176

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

177

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

178

"A String",

179

],

180

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

181

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

182

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

183

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

184

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

185

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

186

# 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.

187

},

188

],

189

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

190

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

191

# projects/[project_id]/global/images/[image-id]

192

# image-idImage family examples. Dataproc will use the most recent image from the family:

193

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

194

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

195

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

196

"workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

197

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

198

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

199

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

200

# 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.

201

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

202

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

203

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

204

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

205

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

206

},

207

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

208

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

209

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

210

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

211

},

212

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

213

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

214

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

215

"A String",

216

],

217

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

218

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

219

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

220

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

221

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

222

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

223

# 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.

224

},

225

],

226

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

227

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

228

# projects/[project_id]/global/images/[image-id]

229

# image-idImage family examples. Dataproc will use the most recent image from the family:

230

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

231

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

232

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

233

"tempBucket": "A String", # Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket.

234

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

235

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

236

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

237

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

238

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

239

},

240

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

241

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

242

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

243

# projects/[project_id]/zones/[zone]

244

# us-central1-f

245

"metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

246

"a_key": "A String",

247

},

248

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_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.

249

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

250

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

251

# https://www.googleapis.com/auth/devstorage.read_write

252

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

253

# https://www.googleapis.com/auth/bigquery

254

# https://www.googleapis.com/auth/bigtable.admin.table

255

# https://www.googleapis.com/auth/bigtable.data

256

# https://www.googleapis.com/auth/devstorage.full_control

257

"A String",

258

],

259

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

260

"values": [ # Optional. Corresponds to the label values of reservation resource.

261

"A String",

262

],

263

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

264

"consumeReservationType": "A String", # Optional. Type of reservation to consume

265

},

266

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

267

"A String",

268

],

269

"subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:

270

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

271

# projects/[project_id]/regions/us-east1/subnetworks/sub0

272

# sub0

273

"networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

274

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

275

# projects/[project_id]/regions/global/default

276

# default

277

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

278

},

279

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

280

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

281

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

282

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

283

"truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

284

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

285

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

286

"crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

287

"keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

288

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

289

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

290

"keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

291

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

292

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

293

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

294

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

295

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

296

},

297

},

298

"masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

299

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

300

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

301

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

302

# 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.

303

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

304

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

305

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

306

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

307

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

308

},

309

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

310

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

311

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

312

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

313

},

314

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

315

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

316

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

317

"A String",

318

],

319

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

320

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

321

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

322

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

323

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

324

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

325

# 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.

326

},

327

],

328

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

329

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

330

# projects/[project_id]/global/images/[image-id]

331

# image-idImage family examples. Dataproc will use the most recent image from the family:

332

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

333

# 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.

334

},

335

"endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster

336

"httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.

337

"a_key": "A String",

338

},

339

"enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.

340

},

341

"initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):

342

# ROLE=$(curl -H Metadata-Flavor:Google

343

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

344

# if [[ "${ROLE}" == 'Master' ]]; then

345

# ... master specific actions ...

346

# else

347

# ... worker specific actions ...

348

# fi

349

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

350

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

351

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

352

},

353

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

354

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

355

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

356

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

357

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

358

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

359

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

360

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

361

"clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

362

"labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

363

"a_key": "A String",

364

},

365

"status": { # The status of a cluster and its instances. # Output only. Cluster status.

366

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

367

"state": "A String", # Output only. The cluster's state.

368

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

369

"detail": "A String", # Optional. Output only. Details of cluster's state.

370

},

371

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

372

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

373

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.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

374

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

375

Allowed values

376

1 - v1 error format

377

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

378

379

Returns:

380

An object of the form:

381

382

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

383

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

384

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

385

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

386

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

387

"a_key": "", # Properties of the object. Contains field @type with type URL.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

388

},

389

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

390

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

391

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

392

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

393

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

394

"a_key": "", # Properties of the object. Contains field @type with type URL.

395

},

396

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

397

"a_key": "", # Properties of the object. Contains field @type with type URL.

398

},

399

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

404

<code class="details" id="delete">delete(projectId, region, clusterName, requestId=None, clusterUuid=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

405

<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.v1#clusteroperationmetadata).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

406

407

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

408

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

409

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

410

clusterName: string, Required. The cluster name. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

411

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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

412

clusterUuid: string, Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

413

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

414

Allowed values

415

1 - v1 error format

416

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

417

418

Returns:

419

An object of the form:

420

421

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

422

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

423

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

424

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

425

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

426

"a_key": "", # Properties of the object. Contains field @type with type URL.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

427

},

428

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

429

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

430

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

431

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

432

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

433

"a_key": "", # Properties of the object. Contains field @type with type URL.

434

},

435

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

436

"a_key": "", # Properties of the object. Contains field @type with type URL.

437

},

438

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

443

<code class="details" id="diagnose">diagnose(projectId, region, clusterName, body=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

444

<pre>Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

445

446

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

447

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

448

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

449

clusterName: string, Required. The cluster name. (required)

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

450

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

451

The object takes the form of:

452

453

{ # A request to collect cluster diagnostic information.

454

}

455

456

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

457

Allowed values

458

1 - v1 error format

459

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

460

461

Returns:

462

An object of the form:

463

464

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

465

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

466

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

467

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

468

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

469

"a_key": "", # Properties of the object. Contains field @type with type URL.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

470

},

471

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

472

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

473

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

474

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

475

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

476

"a_key": "", # Properties of the object. Contains field @type with type URL.

477

},

478

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

479

"a_key": "", # Properties of the object. Contains field @type with type URL.

480

},

481

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>

487

<pre>Gets the resource representation for a cluster in a project.

488

489

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

490

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

491

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

492

clusterName: string, Required. The cluster name. (required)

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

493

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

494

Allowed values

495

1 - v1 error format

496

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

497

498

Returns:

499

An object of the form:

500

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

501

{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

502

"projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.

503

"clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

504

"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

505

"yarnMetrics": { # The YARN metrics.

506

"a_key": "A String",

507

},

508

"hdfsMetrics": { # The HDFS metrics.

509

"a_key": "A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

510

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

511

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

512

"statusHistory": [ # Output only. The previous cluster status.

513

{ # The status of a cluster and its instances.

514

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

515

"state": "A String", # Output only. The cluster's state.

516

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

517

"detail": "A String", # Optional. Output only. Details of cluster's state.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

518

},

519

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

520

"config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.

521

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

522

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

523

"A String",

524

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

525

"properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:

526

# capacity-scheduler: capacity-scheduler.xml

527

# core: core-site.xml

528

# distcp: distcp-default.xml

529

# hdfs: hdfs-site.xml

530

# hive: hive-site.xml

531

# mapred: mapred-site.xml

532

# pig: pig.properties

533

# spark: spark-defaults.conf

534

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

535

"a_key": "A String",

536

},

537

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

538

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

539

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

540

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

541

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

542

"secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

543

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

544

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

545

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

546

# 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.

547

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

548

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

549

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

550

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

551

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

552

},

553

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

554

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

555

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

556

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

557

},

558

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

559

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

560

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

561

"A String",

562

],

563

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

564

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

565

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

566

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

567

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

568

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

569

# 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.

570

},

571

],

572

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

573

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

574

# projects/[project_id]/global/images/[image-id]

575

# image-idImage family examples. Dataproc will use the most recent image from the family:

576

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

577

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

578

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

579

"workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

580

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

581

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

582

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

583

# 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.

584

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

585

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

586

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

587

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

588

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

589

},

590

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

591

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

592

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

593

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

594

},

595

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

596

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

597

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

598

"A String",

599

],

600

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

601

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

602

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

603

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

604

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

605

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

606

# 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.

607

},

608

],

609

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

610

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

611

# projects/[project_id]/global/images/[image-id]

612

# image-idImage family examples. Dataproc will use the most recent image from the family:

613

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

614

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

615

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

616

"tempBucket": "A String", # Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket.

617

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

618

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

619

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

620

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

621

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

622

},

623

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

624

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

625

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

626

# projects/[project_id]/zones/[zone]

627

# us-central1-f

628

"metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

629

"a_key": "A String",

630

},

631

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_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.

632

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

633

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

634

# https://www.googleapis.com/auth/devstorage.read_write

635

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

636

# https://www.googleapis.com/auth/bigquery

637

# https://www.googleapis.com/auth/bigtable.admin.table

638

# https://www.googleapis.com/auth/bigtable.data

639

# https://www.googleapis.com/auth/devstorage.full_control

640

"A String",

641

],

642

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

643

"values": [ # Optional. Corresponds to the label values of reservation resource.

644

"A String",

645

],

646

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

647

"consumeReservationType": "A String", # Optional. Type of reservation to consume

648

},

649

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

650

"A String",

651

],

652

"subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:

653

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

654

# projects/[project_id]/regions/us-east1/subnetworks/sub0

655

# sub0

656

"networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

657

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

658

# projects/[project_id]/regions/global/default

659

# default

660

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

661

},

662

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

663

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

664

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

665

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

666

"truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

667

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

668

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

669

"crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

670

"keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

671

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

672

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

673

"keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

674

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

675

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

676

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

677

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

678

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

679

},

680

},

681

"masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

682

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

683

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

684

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

685

# 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.

686

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

687

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

688

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

689

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

690

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

691

},

692

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

693

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

694

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

695

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

696

},

697

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

698

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

699

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

700

"A String",

701

],

702

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

703

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

704

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

705

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

706

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

707

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

708

# 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.

709

},

710

],

711

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

712

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

713

# projects/[project_id]/global/images/[image-id]

714

# image-idImage family examples. Dataproc will use the most recent image from the family:

715

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

716

# 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.

717

},

718

"endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster

719

"httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.

720

"a_key": "A String",

721

},

722

"enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.

723

},

724

"initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):

725

# ROLE=$(curl -H Metadata-Flavor:Google

726

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

727

# if [[ "${ROLE}" == 'Master' ]]; then

728

# ... master specific actions ...

729

# else

730

# ... worker specific actions ...

731

# fi

732

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

733

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

734

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

735

},

736

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

737

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

738

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

739

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

740

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

741

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

742

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

743

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

744

"clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

745

"labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

746

"a_key": "A String",

747

},

748

"status": { # The status of a cluster and its instances. # Output only. Cluster status.

749

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

750

"state": "A String", # Output only. The cluster's state.

751

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

752

"detail": "A String", # Optional. Output only. Details of cluster's state.

753

},

754

}</pre>

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

</div>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

758

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

759

<pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

760

761

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

762

resource: string, REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field. (required)

763

body: object, The request body.

764

The object takes the form of:

765

766

{ # Request message for GetIamPolicy method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

767

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A GetPolicyOptions object for specifying options to GetIamPolicy.

768

"requestedPolicyVersion": 42, # 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).

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

769

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

770

}

771

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

772

x__xgafv: string, V1 error format.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

773

Allowed values

774

1 - v1 error format

775

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

776

777

Returns:

778

An object of the form:

779

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

780

{ # 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

781

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

782

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

783

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

784

# "role": "roles/resourcemanager.organizationAdmin",

785

# "members": [

786

# "user:mike@example.com",

787

# "group:admins@example.com",

788

# "domain:google.com",

789

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

790

# ]

791

# },

792

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

793

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

794

# "members": [

795

# "user:eve@example.com"

796

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

797

# "condition": {

798

# "title": "expirable access",

799

# "description": "Does not grant access after Sep 2020",

800

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

801

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

802

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

803

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

804

# "etag": "BwWWja0YfJA=",

805

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

806

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

807

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

808

# bindings:

809

# - members:

810

# - user:mike@example.com

811

# - group:admins@example.com

812

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

813

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

814

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

815

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

816

# - user:eve@example.com

817

# role: roles/resourcemanager.organizationViewer

818

# condition:

819

# title: expirable access

820

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

821

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

822

# - etag: BwWWja0YfJA=

823

# - version: 3

824

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

825

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

826

# Getting a policy that includes a conditional role binding

827

# Adding a conditional role binding to a policy

828

# Changing a conditional role binding in a policy

829

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

830

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

831

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

832

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

833

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.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).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

834

# title: "Summary size limit"

835

# description: "Determines if a summary is less than 100 chars"

836

# expression: "document.summary.size() < 100"

837

# Example (Equality):

838

# title: "Requestor is owner"

839

# description: "Determines if requestor is the document owner"

840

# expression: "document.owner == request.auth.claims.email"

841

# Example (Logic):

842

# title: "Public documents"

843

# description: "Determine whether the document should be publicly visible"

844

# expression: "document.type != 'private' && document.type != 'internal'"

845

# Example (Data Manipulation):

846

# title: "Notification string"

847

# description: "Create a notification string with a timestamp."

848

# expression: "'New message received at ' + string(document.create_time)"

849

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

850

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

851

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

852

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

853

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

854

},

855

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

856

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

857

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

858

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

859

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

860

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

861

# 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.

862

# 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.

863

# 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

864

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

865

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

866

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

867

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

868

},

869

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

874

<code class="details" id="list">list(projectId, region, filter=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

875

<pre>Lists all regions/{region}/clusters in a project alphabetically.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

876

877

Args:

878

projectId: string, Required. The ID of the Google Cloud Platform project that the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

879

region: string, Required. The Dataproc region in which to handle the request. (required)

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

880

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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

881

pageToken: string, Optional. The standard List page token.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

882

pageSize: integer, Optional. The standard List page size.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

883

x__xgafv: string, V1 error format.

884

Allowed values

885

1 - v1 error format

886

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

887

888

Returns:

889

An object of the form:

890

891

{ # The list of all clusters in a project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

892

"clusters": [ # Output only. The clusters in the project.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

893

{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

894

"projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.

895

"clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

896

"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

897

"yarnMetrics": { # The YARN metrics.

898

"a_key": "A String",

899

},

900

"hdfsMetrics": { # The HDFS metrics.

901

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

902

},

903

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

904

"statusHistory": [ # Output only. The previous cluster status.

905

{ # The status of a cluster and its instances.

906

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

907

"state": "A String", # Output only. The cluster's state.

908

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

909

"detail": "A String", # Optional. Output only. Details of cluster's state.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

910

},

911

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

912

"config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.

913

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

914

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

915

"A String",

916

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

917

"properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:

918

# capacity-scheduler: capacity-scheduler.xml

919

# core: core-site.xml

920

# distcp: distcp-default.xml

921

# hdfs: hdfs-site.xml

922

# hive: hive-site.xml

923

# mapred: mapred-site.xml

924

# pig: pig.properties

925

# spark: spark-defaults.conf

926

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

927

"a_key": "A String",

928

},

929

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

930

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

931

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

932

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

933

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

934

"secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

935

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

936

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

937

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

938

# 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.

939

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

940

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

941

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

942

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

943

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

944

},

945

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

946

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

947

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

948

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

949

},

950

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

951

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

952

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

953

"A String",

954

],

955

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

956

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

957

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

958

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

959

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

960

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

961

# 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.

962

},

963

],

964

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

965

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

966

# projects/[project_id]/global/images/[image-id]

967

# image-idImage family examples. Dataproc will use the most recent image from the family:

968

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

969

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

970

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

971

"workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

972

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

973

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

974

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

975

# 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.

976

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

977

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

978

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

979

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

980

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

981

},

982

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

983

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

984

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

985

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

986

},

987

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

988

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

989

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

990

"A String",

991

],

992

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

993

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

994

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

995

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

996

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

997

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

998

# 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.

999

},

1000

],

1001

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1002

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1003

# projects/[project_id]/global/images/[image-id]

1004

# image-idImage family examples. Dataproc will use the most recent image from the family:

1005

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1006

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1007

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1008

"tempBucket": "A String", # Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket.

1009

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

1010

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

1011

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

1012

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

1013

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

1014

},

1015

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

1016

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

1017

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

1018

# projects/[project_id]/zones/[zone]

1019

# us-central1-f

1020

"metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

1021

"a_key": "A String",

1022

},

1023

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_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.

1024

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

1025

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

1026

# https://www.googleapis.com/auth/devstorage.read_write

1027

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

1028

# https://www.googleapis.com/auth/bigquery

1029

# https://www.googleapis.com/auth/bigtable.admin.table

1030

# https://www.googleapis.com/auth/bigtable.data

1031

# https://www.googleapis.com/auth/devstorage.full_control

1032

"A String",

1033

],

1034

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

1035

"values": [ # Optional. Corresponds to the label values of reservation resource.

1036

"A String",

1037

],

1038

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

1039

"consumeReservationType": "A String", # Optional. Type of reservation to consume

1040

},

1041

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

1042

"A String",

1043

],

1044

"subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:

1045

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

1046

# projects/[project_id]/regions/us-east1/subnetworks/sub0

1047

# sub0

1048

"networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

1049

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

1050

# projects/[project_id]/regions/global/default

1051

# default

1052

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

1053

},

1054

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

1055

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

1056

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

1057

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

1058

"truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

1059

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1060

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

1061

"crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

1062

"keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

1063

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

1064

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1065

"keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

1066

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1067

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

1068

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

1069

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1070

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

1071

},

1072

},

1073

"masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

1074

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1075

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1076

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1077

# 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.

1078

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1079

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1080

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1081

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1082

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1083

},

1084

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1085

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1086

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1087

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1088

},

1089

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1090

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1091

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1092

"A String",

1093

],

1094

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1095

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1096

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1097

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1098

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1099

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1100

# 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.

1101

},

1102

],

1103

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1104

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1105

# projects/[project_id]/global/images/[image-id]

1106

# image-idImage family examples. Dataproc will use the most recent image from the family:

1107

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1108

# 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.

1109

},

1110

"endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster

1111

"httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.

1112

"a_key": "A String",

1113

},

1114

"enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.

1115

},

1116

"initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):

1117

# ROLE=$(curl -H Metadata-Flavor:Google

1118

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

1119

# if [[ "${ROLE}" == 'Master' ]]; then

1120

# ... master specific actions ...

1121

# else

1122

# ... worker specific actions ...

1123

# fi

1124

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

1125

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

1126

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1127

},

1128

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1129

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

1130

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1131

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1132

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1133

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

1134

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1135

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1136

"clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

1137

"labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

1138

"a_key": "A String",

1139

},

1140

"status": { # The status of a cluster and its instances. # Output only. Cluster status.

1141

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1142

"state": "A String", # Output only. The cluster's state.

1143

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

1144

"detail": "A String", # Optional. Output only. Details of cluster's state.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1145

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1146

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1147

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1148

"nextPageToken": "A String", # Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListClustersRequest.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1154

<pre>Retrieves the next page of results.

1155

1156

Args:

1157

previous_request: The request for the previous page. (required)

1158

previous_response: The response from the request for the previous page. (required)

1159

1160

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1161

A request object that you can call 'execute()' on to request the next

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1162

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1167

<code class="details" id="patch">patch(projectId, region, clusterName, body=None, updateMask=None, gracefulDecommissionTimeout=None, requestId=None, x__xgafv=None)</code>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1168

<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.v1#clusteroperationmetadata).

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1169

1170

Args:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1171

projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1172

region: string, Required. The Dataproc region in which to handle the request. (required)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1173

clusterName: string, Required. The cluster name. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1174

body: object, The request body.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1175

The object takes the form of:

1176

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1177

{ # Describes the identifying information, config, and status of a cluster of Compute Engine instances.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1178

"projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.

1179

"clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

1180

"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release. # Output only. Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.

1181

"yarnMetrics": { # The YARN metrics.

1182

"a_key": "A String",

1183

},

1184

"hdfsMetrics": { # The HDFS metrics.

1185

"a_key": "A String",

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1186

},

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1187

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1188

"statusHistory": [ # Output only. The previous cluster status.

1189

{ # The status of a cluster and its instances.

1190

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1191

"state": "A String", # Output only. The cluster's state.

1192

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

1193

"detail": "A String", # Optional. Output only. Details of cluster's state.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1194

},

1195

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1196

"config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.

1197

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

1198

"optionalComponents": [ # Optional. The set of components to activate on the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1199

"A String",

1200

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1201

"properties": { # Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, for example core:hadoop.tmp.dir. The following are supported prefixes and their mappings:

1202

# capacity-scheduler: capacity-scheduler.xml

1203

# core: core-site.xml

1204

# distcp: distcp-default.xml

1205

# hdfs: hdfs-site.xml

1206

# hive: hive-site.xml

1207

# mapred: mapred-site.xml

1208

# pig: pig.properties

1209

# spark: spark-defaults.conf

1210

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

1211

"a_key": "A String",

1212

},

1213

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1214

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1215

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

1216

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1217

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1218

"secondaryWorkerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for additional worker instances in a cluster.

1219

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1220

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1221

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1222

# 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.

1223

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1224

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1225

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1226

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1227

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1228

},

1229

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1230

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1231

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1232

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1233

},

1234

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1235

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1236

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1237

"A String",

1238

],

1239

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1240

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1241

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1242

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1243

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1244

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1245

# 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.

1246

},

1247

],

1248

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1249

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1250

# projects/[project_id]/global/images/[image-id]

1251

# image-idImage family examples. Dataproc will use the most recent image from the family:

1252

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1253

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1254

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1255

"workerConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for worker instances in a cluster.

1256

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1257

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1258

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1259

# 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.

1260

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1261

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1262

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1263

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1264

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1265

},

1266

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1267

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1268

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1269

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1270

},

1271

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1272

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1273

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1274

"A String",

1275

],

1276

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1277

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1278

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1279

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1280

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1281

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1282

# 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.

1283

},

1284

],

1285

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1286

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1287

# projects/[project_id]/global/images/[image-id]

1288

# image-idImage family examples. Dataproc will use the most recent image from the family:

1289

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1290

# 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 Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1291

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1292

"tempBucket": "A String", # Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket.

1293

"configBucket": "A String", # Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).

1294

"autoscalingConfig": { # Autoscaling Policy config associated with the cluster. # Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.

1295

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

1296

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

1297

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

1298

},

1299

"gceClusterConfig": { # Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster. # Optional. The shared Compute Engine config settings for all instances in a cluster.

1300

"zoneUri": "A String", # Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:

1301

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

1302

# projects/[project_id]/zones/[zone]

1303

# us-central1-f

1304

"metadata": { # The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).

1305

"a_key": "A String",

1306

},

1307

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_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.

1308

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

1309

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

1310

# https://www.googleapis.com/auth/devstorage.read_write

1311

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

1312

# https://www.googleapis.com/auth/bigquery

1313

# https://www.googleapis.com/auth/bigtable.admin.table

1314

# https://www.googleapis.com/auth/bigtable.data

1315

# https://www.googleapis.com/auth/devstorage.full_control

1316

"A String",

1317

],

1318

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

1319

"values": [ # Optional. Corresponds to the label values of reservation resource.

1320

"A String",

1321

],

1322

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

1323

"consumeReservationType": "A String", # Optional. Type of reservation to consume

1324

},

1325

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

1326

"A String",

1327

],

1328

"subnetworkUri": "A String", # Optional. The Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:

1329

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

1330

# projects/[project_id]/regions/us-east1/subnetworks/sub0

1331

# sub0

1332

"networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples:

1333

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

1334

# projects/[project_id]/regions/global/default

1335

# default

1336

"internalIpOnly": True or False, # Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.

1337

},

1338

"securityConfig": { # Security related configuration, including Kerberos. # Optional. Security settings for the cluster.

1339

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

1340

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

1341

"tgtLifetimeHours": 42, # Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.

1342

"truststorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.

1343

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1344

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

1345

"crossRealmTrustSharedPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.

1346

"keystorePasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.

1347

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

1348

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1349

"keyPasswordUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.

1350

"keystoreUri": "A String", # Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1351

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

1352

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

1353

"truststoreUri": "A String", # Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.

1354

"enableKerberos": True or False, # Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster.

1355

},

1356

},

1357

"masterConfig": { # The config settings for Compute Engine resources in an instance group, such as a master or worker group. # Optional. The Compute Engine config settings for the master instance in a cluster.

1358

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1359

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1360

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1361

# 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.

1362

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1363

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1364

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1365

"bootDiskType": "A String", # Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).

1366

"numLocalSsds": 42, # Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1367

},

1368

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1369

"managedGroupConfig": { # Specifies the resources used to actively manage an instance group. # Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.

1370

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1371

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1372

},

1373

"preemptibility": "A String", # Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE.

1374

"minCpuPlatform": "A String", # Optional. Specifies the minimum cpu platform for the Instance Group. See Dataproc -&gt; Minimum CPU Platform (https://cloud.google.com/dataproc/docs/concepts/compute/dataproc-min-cpu).

1375

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1376

"A String",

1377

],

1378

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1379

{ # Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).

1380

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1381

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples:

1382

# https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1383

# projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80

1384

# 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

},

1386

],

1387

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1388

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1389

# projects/[project_id]/global/images/[image-id]

1390

# image-idImage family examples. Dataproc will use the most recent image from the family:

1391

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1392

# 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.

1393

},

1394

"endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster

1395

"httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.

1396

"a_key": "A String",

1397

},

1398

"enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.

1399

},

1400

"initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):

1401

# ROLE=$(curl -H Metadata-Flavor:Google

1402

# http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)

1403

# if [[ "${ROLE}" == 'Master' ]]; then

1404

# ... master specific actions ...

1405

# else

1406

# ... worker specific actions ...

1407

# fi

1408

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

1409

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

1410

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1411

},

1412

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1413

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. Lifecycle setting for the cluster.

1414

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1415

"autoDeleteTtl": "A String", # Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1416

"autoDeleteTime": "A String", # Optional. The time when cluster will be auto-deleted (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1417

"idleDeleteTtl": "A String", # Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1418

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1419

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1420

"clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

1421

"labels": { # Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.

1422

"a_key": "A String",

1423

},

1424

"status": { # The status of a cluster and its instances. # Output only. Cluster status.

1425

"stateStartTime": "A String", # Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

1426

"state": "A String", # Output only. The cluster's state.

1427

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

1428

"detail": "A String", # Optional. Output only. Details of cluster's state.

1429

},

1430

}

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1431

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1432

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:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1433

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1434

"config":{

1435

"workerConfig":{

1436

"numInstances":"5"

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1437

}

1438

}

1439

}

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1440

Similarly, 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:

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1441

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1442

"config":{

1443

"secondaryWorkerConfig":{

1444

"numInstances":"5"

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1445

}

1446

}

1447

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1448

<strong>Note:</strong> Currently, only the following fields can be updated:<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1449

gracefulDecommissionTimeout: string, Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1450

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 Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1451

x__xgafv: string, V1 error format.

1452

Allowed values

1453

1 - v1 error format

1454

2 - v2 error format

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1455

1456

Returns:

1457

An object of the form:

1458

1459

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1460

"error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1461

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1462

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1463

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1464

"a_key": "", # Properties of the object. Contains field @type with type URL.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1465

},

1466

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1467

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1468

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1469

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

1470

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

1471

"a_key": "", # Properties of the object. Contains field @type with type URL.

1472

},

1473

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1474

"a_key": "", # Properties of the object. Contains field @type with type URL.

1475

},

1476

"done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1481

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1482

<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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1483

1484

Args:

1485

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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1486

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1487

The object takes the form of:

1488

1489

{ # Request message for SetIamPolicy method.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1490

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1491

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1492

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1493

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1494

# "role": "roles/resourcemanager.organizationAdmin",

1495

# "members": [

1496

# "user:mike@example.com",

1497

# "group:admins@example.com",

1498

# "domain:google.com",

1499

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1500

# ]

1501

# },

1502

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1503

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1504

# "members": [

1505

# "user:eve@example.com"

1506

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1507

# "condition": {

1508

# "title": "expirable access",

1509

# "description": "Does not grant access after Sep 2020",

1510

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1511

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1512

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1513

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1514

# "etag": "BwWWja0YfJA=",

1515

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1516

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1517

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1518

# bindings:

1519

# - members:

1520

# - user:mike@example.com

1521

# - group:admins@example.com

1522

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1523

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1524

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1525

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1526

# - user:eve@example.com

1527

# role: roles/resourcemanager.organizationViewer

1528

# condition:

1529

# title: expirable access

1530

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1531

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1532

# - etag: BwWWja0YfJA=

1533

# - version: 3

1534

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1535

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

1536

# Getting a policy that includes a conditional role binding

1537

# Adding a conditional role binding to a policy

1538

# Changing a conditional role binding in a policy

1539

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1540

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1541

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1542

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1543

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.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).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1544

# title: "Summary size limit"

1545

# description: "Determines if a summary is less than 100 chars"

1546

# expression: "document.summary.size() < 100"

1547

# Example (Equality):

1548

# title: "Requestor is owner"

1549

# description: "Determines if requestor is the document owner"

1550

# expression: "document.owner == request.auth.claims.email"

1551

# Example (Logic):

1552

# title: "Public documents"

1553

# description: "Determine whether the document should be publicly visible"

1554

# expression: "document.type != 'private' && document.type != 'internal'"

1555

# Example (Data Manipulation):

1556

# title: "Notification string"

1557

# description: "Create a notification string with a timestamp."

1558

# expression: "'New message received at ' + string(document.create_time)"

1559

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1560

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1561

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1562

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1563

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1564

},

1565

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1566

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1567

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1568

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1569

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1570

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1571

# 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.

1572

# 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.

1573

# 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1574

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1575

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1576

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1577

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1578

},

1579

],

Jon Wayne Parrott

2016-02-19 16:02:29 -0800

[diff] [blame]

1580

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1581

}

1582

1583

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1590

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1591

{ # 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1592

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1593

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1594

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1595

# "role": "roles/resourcemanager.organizationAdmin",

1596

# "members": [

1597

# "user:mike@example.com",

1598

# "group:admins@example.com",

1599

# "domain:google.com",

1600

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1601

# ]

1602

# },

1603

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1604

# "role": "roles/resourcemanager.organizationViewer",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1605

# "members": [

1606

# "user:eve@example.com"

1607

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1608

# "condition": {

1609

# "title": "expirable access",

1610

# "description": "Does not grant access after Sep 2020",

1611

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1612

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1613

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1614

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1615

# "etag": "BwWWja0YfJA=",

1616

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1617

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1618

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1619

# bindings:

1620

# - members:

1621

# - user:mike@example.com

1622

# - group:admins@example.com

1623

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1624

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1625

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1626

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1627

# - user:eve@example.com

1628

# role: roles/resourcemanager.organizationViewer

1629

# condition:

1630

# title: expirable access

1631

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1632

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1633

# - etag: BwWWja0YfJA=

1634

# - version: 3

1635

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1636

"version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations:

1637

# Getting a policy that includes a conditional role binding

1638

# Adding a conditional role binding to a policy

1639

# Changing a conditional role binding in a policy

1640

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1641

"etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1642

"bindings": [ # Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1643

{ # Associates members with a role.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1644

"condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): # The condition that is associated with this binding.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).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1645

# title: "Summary size limit"

1646

# description: "Determines if a summary is less than 100 chars"

1647

# expression: "document.summary.size() < 100"

1648

# Example (Equality):

1649

# title: "Requestor is owner"

1650

# description: "Determines if requestor is the document owner"

1651

# expression: "document.owner == request.auth.claims.email"

1652

# Example (Logic):

1653

# title: "Public documents"

1654

# description: "Determine whether the document should be publicly visible"

1655

# expression: "document.type != 'private' && document.type != 'internal'"

1656

# Example (Data Manipulation):

1657

# title: "Notification string"

1658

# description: "Create a notification string with a timestamp."

1659

# expression: "'New message received at ' + string(document.create_time)"

1660

# 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 Kim

2020-07-22 17:02:09 -0700

[diff] [blame^]

1661

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1662

"title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1663

"description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

1664

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1665

},

1666

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1667

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1668

# allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1669

# user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com .

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1670

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1671

# group:{emailid}: An email address that represents a Google group. For example, admins@example.com.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1672

# 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.

1673

# 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.

1674

# 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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1675

# domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1676

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1677

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

1678

"role": "A String", # Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1679

},

1680

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1685

<code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1686

<pre>Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1687

1688

Args:

1689

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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1690

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1691

The object takes the form of:

1692

1693

{ # Request message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1694

"permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).

1695

"A String",

Bu Sun Kim