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

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

Bu Sun Kim

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

[diff] [blame]

80

Bu Sun Kim

2020-05-20 12:08:20 -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.v1beta2#clusteroperationmetadata).</p>

Bu Sun Kim

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

[diff] [blame]

83

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.v1beta2#clusteroperationmetadata). After the operation completes, Operation.response contains Empty.</p>

Bu Sun Kim

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

[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

Dan O'Meara

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

[diff] [blame]

90

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

Bu Sun Kim

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

[diff] [blame]

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-05-20 12:08:20 -0700

[diff] [blame]

93

<code><a href="#list">list(projectId, region, pageToken=None, pageSize=None, filter=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>

Bu Sun Kim

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

[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-05-20 12:08:20 -0700

[diff] [blame]

99

<code><a href="#patch">patch(projectId, region, clusterName, body=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=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.v1beta2#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-20 12:08:20 -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="#start">start(projectId, region, clusterName, body=None, x__xgafv=None)</a></code></p>

106

<p class="firstline">Starts a cluster in a project.</p>

107

108

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

109

<p class="firstline">Stops a cluster in a project.</p>

110

111

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

112

<p class="firstline">Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.</p>

113

<h3>Method Details</h3>

114

Dan O'Meara

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

[diff] [blame]

115

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

116

<pre>Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).

Bu Sun Kim

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

[diff] [blame]

117

118

Args:

119

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]

120

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

121

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

122

The object takes the form of:

123

124

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

Bu Sun Kim

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

[diff] [blame]

125

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

126

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

127

},

Bu Sun Kim

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

[diff] [blame]

128

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

129

"hdfsMetrics": { # The HDFS metrics.

130

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

131

},

Bu Sun Kim

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

[diff] [blame]

132

"yarnMetrics": { # The YARN metrics.

133

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

134

},

135

},

Bu Sun Kim

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

[diff] [blame]

136

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

137

"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)).

138

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

139

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

140

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

141

},

142

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

143

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

144

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

145

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

146

"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).

147

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

148

},

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

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

159

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

160

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

161

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

162

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

163

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

164

},

165

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

166

"A String",

Bu Sun Kim

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

[diff] [blame]

167

],

Bu Sun Kim

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

[diff] [blame]

168

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

169

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

170

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

171

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

172

},

173

],

174

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

175

"minCpuPlatform": "A String", # 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).

176

},

177

"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)).

178

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

179

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

180

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

181

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

182

# sub0

183

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

184

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

185

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

186

# default

187

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

188

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

189

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

190

# us-central1-f

191

"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)).

192

"a_key": "A String",

193

},

194

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

195

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

196

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

197

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

198

"A String",

199

],

200

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

201

},

202

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

203

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

204

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

205

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

206

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

207

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

208

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

209

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

210

"A String",

211

],

212

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

213

"A String",

214

],

215

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

216

},

217

"gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.

218

"namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.

219

"clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.

220

"targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'

221

},

222

},

223

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

224

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

225

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

Bu Sun Kim

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

[diff] [blame]

226

# capacity-scheduler: capacity-scheduler.xml

227

# core: core-site.xml

228

# distcp: distcp-default.xml

229

# hdfs: hdfs-site.xml

230

# hive: hive-site.xml

231

# mapred: mapred-site.xml

232

# pig: pig.properties

233

# spark: spark-defaults.conf

Dan O'Meara

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

[diff] [blame]

234

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

Bu Sun Kim

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

[diff] [blame]

235

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

236

},

Bu Sun Kim

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

[diff] [blame]

237

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

238

"A String",

Bu Sun Kim

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

[diff] [blame]

239

],

Bu Sun Kim

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

[diff] [blame]

240

},

Bu Sun Kim

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

[diff] [blame]

241

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

242

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

Bu Sun Kim

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

[diff] [blame]

243

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

Dan O'Meara

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

[diff] [blame]

244

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

245

},

Bu Sun Kim

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

[diff] [blame]

246

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

247

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

248

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

249

},

Bu Sun Kim

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

[diff] [blame]

250

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

Bu Sun Kim

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

[diff] [blame]

251

},

Bu Sun Kim

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

[diff] [blame]

252

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

253

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

254

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

255

"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).

256

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

Bu Sun Kim

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

[diff] [blame]

257

},

Bu Sun Kim

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

[diff] [blame]

258

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

259

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

Bu Sun Kim

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

[diff] [blame]

260

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

261

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

Dan O'Meara

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

[diff] [blame]

262

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

263

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

Dan O'Meara

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

[diff] [blame]

264

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

265

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

266

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

267

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

268

# 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-20 12:08:20 -0700

[diff] [blame]

269

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

270

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

271

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

272

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

273

},

274

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

275

"A String",

276

],

277

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

Dan O'Meara

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

[diff] [blame]

278

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

Bu Sun Kim

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

[diff] [blame]

279

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

280

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

Bu Sun Kim

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

[diff] [blame]

281

},

282

],

Bu Sun Kim

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

[diff] [blame]

283

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

284

"minCpuPlatform": "A String", # 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).

285

},

286

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

287

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

288

},

289

"securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.

290

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

291

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

292

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

293

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

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

Bu Sun Kim

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

[diff] [blame]

306

},

Bu Sun Kim

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

[diff] [blame]

307

},

Bu Sun Kim

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

[diff] [blame]

308

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

Bu Sun Kim

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

[diff] [blame]

309

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

310

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

Bu Sun Kim

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

[diff] [blame]

311

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

Bu Sun Kim

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

[diff] [blame]

312

# ... master specific actions ...

313

# else

314

# ... worker specific actions ...

315

# fi

316

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

Bu Sun Kim

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

[diff] [blame]

317

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

318

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

Bu Sun Kim

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

[diff] [blame]

319

},

320

],

Bu Sun Kim

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

[diff] [blame]

321

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

322

"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)).

323

"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).

324

"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)).

325

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

Bu Sun Kim

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

[diff] [blame]

326

},

Bu Sun Kim

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

[diff] [blame]

327

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

328

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

329

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

330

"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).

331

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

332

},

333

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

334

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

Bu Sun Kim

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

[diff] [blame]

335

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

336

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

Dan O'Meara

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

[diff] [blame]

337

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

338

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

Dan O'Meara

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

[diff] [blame]

339

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

340

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

341

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

342

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

343

# 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-20 12:08:20 -0700

[diff] [blame]

344

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

345

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

346

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

347

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

348

},

349

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

350

"A String",

351

],

352

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

Dan O'Meara

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

[diff] [blame]

353

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

Bu Sun Kim

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

[diff] [blame]

354

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

355

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

Bu Sun Kim

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

[diff] [blame]

356

},

357

],

Bu Sun Kim

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

[diff] [blame]

358

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

359

"minCpuPlatform": "A String", # 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).

Bu Sun Kim

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

[diff] [blame]

360

},

361

},

Bu Sun Kim

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

[diff] [blame]

362

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

363

{ # The status of a cluster and its instances.

364

"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)).

365

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

366

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

367

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

368

},

369

],

370

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

371

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

372

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

Bu Sun Kim

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

[diff] [blame]

373

}

374

375

requestId: string, Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

376

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

383

384

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

Bu Sun Kim

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

[diff] [blame]

385

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

386

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

Bu Sun Kim

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

[diff] [blame]

387

},

Bu Sun Kim

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

[diff] [blame]

388

"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}.

389

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

390

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

391

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

392

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

Bu Sun Kim

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

[diff] [blame]

393

{

Bu Sun Kim

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

[diff] [blame]

394

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

Bu Sun Kim

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

[diff] [blame]

395

},

396

],

397

},

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

Dan O'Meara

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

[diff] [blame]

400

},

Bu Sun Kim

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

[diff] [blame]

401

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

Bu Sun Kim

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

[diff] [blame]

406

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

407

<pre>Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).

Bu Sun Kim

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

[diff] [blame]

408

409

Args:

410

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]

411

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

Bu Sun Kim

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

[diff] [blame]

412

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

Bu Sun Kim

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

[diff] [blame]

413

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-05-20 12:08:20 -0700

[diff] [blame]

414

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

Bu Sun Kim

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

[diff] [blame]

415

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

422

423

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

Bu Sun Kim

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

[diff] [blame]

424

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

425

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

Bu Sun Kim

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

[diff] [blame]

426

},

Bu Sun Kim

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

[diff] [blame]

427

"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}.

428

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

429

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

430

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

431

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

Bu Sun Kim

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

[diff] [blame]

432

{

Bu Sun Kim

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

[diff] [blame]

433

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

Bu Sun Kim

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

[diff] [blame]

434

},

435

],

436

},

Bu Sun Kim

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

[diff] [blame]

437

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

438

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

Dan O'Meara

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

[diff] [blame]

439

},

Bu Sun Kim

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

[diff] [blame]

440

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

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

446

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

Bu Sun Kim

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

[diff] [blame]

447

448

Args:

449

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]

450

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

Bu Sun Kim

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

[diff] [blame]

451

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

452

body: object, The request body.

453

The object takes the form of:

454

455

{ # A request to collect cluster diagnostic information.

456

}

457

458

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

465

466

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

Bu Sun Kim

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

[diff] [blame]

467

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

468

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

Bu Sun Kim

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

[diff] [blame]

469

},

Bu Sun Kim

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

[diff] [blame]

470

"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}.

471

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

472

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

473

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

474

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

Bu Sun Kim

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

[diff] [blame]

475

{

Bu Sun Kim

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

[diff] [blame]

476

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

Bu Sun Kim

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

[diff] [blame]

477

},

478

],

479

},

Bu Sun Kim

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

[diff] [blame]

480

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

481

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

Dan O'Meara

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

[diff] [blame]

482

},

Bu Sun Kim

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

[diff] [blame]

483

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

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

489

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

490

491

Args:

492

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]

493

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

Bu Sun Kim

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

[diff] [blame]

494

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

495

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

502

503

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

Bu Sun Kim

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

[diff] [blame]

504

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

505

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

506

},

Bu Sun Kim

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

[diff] [blame]

507

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

508

"hdfsMetrics": { # The HDFS metrics.

509

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

510

},

Bu Sun Kim

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

[diff] [blame]

511

"yarnMetrics": { # The YARN metrics.

512

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

513

},

514

},

Bu Sun Kim

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

[diff] [blame]

515

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

516

"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)).

517

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

518

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

519

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

520

},

521

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

522

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

523

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

524

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

525

"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).

526

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

527

},

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

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

538

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

539

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

540

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

541

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

542

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

543

},

544

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

545

"A String",

Bu Sun Kim

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

[diff] [blame]

546

],

Bu Sun Kim

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

[diff] [blame]

547

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

548

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

549

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

550

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

551

},

552

],

553

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

554

"minCpuPlatform": "A String", # 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).

555

},

556

"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)).

557

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

558

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

559

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

560

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

561

# sub0

562

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

563

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

564

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

565

# default

566

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

567

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

568

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

569

# us-central1-f

570

"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)).

571

"a_key": "A String",

572

},

573

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

574

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

575

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

576

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

577

"A String",

578

],

579

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

580

},

581

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

582

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

583

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

584

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

585

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

586

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

587

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

588

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

589

"A String",

590

],

591

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

592

"A String",

593

],

594

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

595

},

596

"gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.

597

"namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.

598

"clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.

599

"targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'

600

},

601

},

602

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

603

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

604

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

Bu Sun Kim

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

[diff] [blame]

605

# capacity-scheduler: capacity-scheduler.xml

606

# core: core-site.xml

607

# distcp: distcp-default.xml

608

# hdfs: hdfs-site.xml

609

# hive: hive-site.xml

610

# mapred: mapred-site.xml

611

# pig: pig.properties

612

# spark: spark-defaults.conf

Dan O'Meara

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

[diff] [blame]

613

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

Bu Sun Kim

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

[diff] [blame]

614

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

615

},

Bu Sun Kim

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

[diff] [blame]

616

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

617

"A String",

Bu Sun Kim

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

[diff] [blame]

618

],

Bu Sun Kim

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

[diff] [blame]

619

},

Bu Sun Kim

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

[diff] [blame]

620

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

621

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

Bu Sun Kim

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

[diff] [blame]

622

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

Dan O'Meara

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

[diff] [blame]

623

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

624

},

Bu Sun Kim

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

[diff] [blame]

625

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

626

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

627

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

628

},

Bu Sun Kim

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

[diff] [blame]

629

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

Bu Sun Kim

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

[diff] [blame]

630

},

Bu Sun Kim

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

[diff] [blame]

631

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

632

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

633

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

634

"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).

635

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

Bu Sun Kim

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

[diff] [blame]

636

},

Bu Sun Kim

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

[diff] [blame]

637

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

638

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

Bu Sun Kim

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

[diff] [blame]

639

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

640

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

Dan O'Meara

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

[diff] [blame]

641

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

642

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

Dan O'Meara

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

[diff] [blame]

643

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

644

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

645

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

646

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

647

# 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-20 12:08:20 -0700

[diff] [blame]

648

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

649

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

650

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

651

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

652

},

653

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

654

"A String",

655

],

656

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

Dan O'Meara

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

[diff] [blame]

657

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

Bu Sun Kim

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

[diff] [blame]

658

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

659

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

Bu Sun Kim

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

[diff] [blame]

660

},

661

],

Bu Sun Kim

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

[diff] [blame]

662

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

663

"minCpuPlatform": "A String", # 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).

664

},

665

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

666

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

667

},

668

"securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.

669

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

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

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

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

680

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

681

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

682

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

683

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

684

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

Bu Sun Kim

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

[diff] [blame]

685

},

Bu Sun Kim

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

[diff] [blame]

686

},

Bu Sun Kim

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

[diff] [blame]

687

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

Bu Sun Kim

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

[diff] [blame]

688

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

689

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

Bu Sun Kim

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

[diff] [blame]

690

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

Bu Sun Kim

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

[diff] [blame]

691

# ... master specific actions ...

692

# else

693

# ... worker specific actions ...

694

# fi

695

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

Bu Sun Kim

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

[diff] [blame]

696

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

697

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

Bu Sun Kim

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

[diff] [blame]

698

},

699

],

Bu Sun Kim

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

[diff] [blame]

700

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

701

"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)).

702

"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).

703

"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)).

704

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

Bu Sun Kim

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

[diff] [blame]

705

},

Bu Sun Kim

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

[diff] [blame]

706

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

707

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

708

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

709

"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).

710

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

711

},

712

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

713

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

Bu Sun Kim

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

[diff] [blame]

714

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

715

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

Dan O'Meara

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

[diff] [blame]

716

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

717

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

Dan O'Meara

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

[diff] [blame]

718

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

719

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

720

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

721

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

722

# 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-20 12:08:20 -0700

[diff] [blame]

723

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

724

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

725

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

726

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

727

},

728

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

729

"A String",

730

],

731

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

Dan O'Meara

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

[diff] [blame]

732

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

Bu Sun Kim

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

[diff] [blame]

733

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

734

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

Bu Sun Kim

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

[diff] [blame]

735

},

736

],

Bu Sun Kim

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

[diff] [blame]

737

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

738

"minCpuPlatform": "A String", # 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).

Bu Sun Kim

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

[diff] [blame]

739

},

740

},

Bu Sun Kim

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

[diff] [blame]

741

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

742

{ # The status of a cluster and its instances.

743

"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)).

744

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

745

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

746

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

747

},

748

],

749

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

750

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

751

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

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]

756

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

Bu Sun Kim

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

[diff] [blame]

757

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

758

759

Args:

760

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

Bu Sun Kim

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

[diff] [blame]

761

options_requestedPolicyVersion: integer, Optional. The policy format version to be returned.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

762

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

769

Bu Sun Kim

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

[diff] [blame]

770

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

771

# {

Bu Sun Kim

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

[diff] [blame]

772

# "bindings": [

Bu Sun Kim

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

[diff] [blame]

773

# {

Bu Sun Kim

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

[diff] [blame]

774

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

775

# "members": [

776

# "user:mike@example.com",

777

# "group:admins@example.com",

778

# "domain:google.com",

779

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

Bu Sun Kim

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

[diff] [blame]

780

# ]

781

# },

782

# {

Bu Sun Kim

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

[diff] [blame]

783

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

784

# "members": [

785

# "user:eve@example.com"

786

# ],

787

# "condition": {

788

# "title": "expirable access",

789

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

790

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

Dan O'Meara

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

[diff] [blame]

791

# }

Bu Sun Kim

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

[diff] [blame]

792

# }

Dan O'Meara

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

[diff] [blame]

793

# ],

Bu Sun Kim

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

[diff] [blame]

794

# "etag": "BwWWja0YfJA=",

795

# "version": 3

Bu Sun Kim

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

[diff] [blame]

796

# }

Dan O'Meara

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

[diff] [blame]

797

# YAML example:

Bu Sun Kim

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

[diff] [blame]

798

# bindings:

799

# - members:

800

# - user:mike@example.com

801

# - group:admins@example.com

802

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

803

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

804

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

805

# - members:

Dan O'Meara

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

[diff] [blame]

806

# - user:eve@example.com

807

# role: roles/resourcemanager.organizationViewer

808

# condition:

809

# title: expirable access

810

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

811

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

Dan O'Meara

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

[diff] [blame]

812

# - etag: BwWWja0YfJA=

813

# - version: 3

814

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

Bu Sun Kim

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

[diff] [blame]

815

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

816

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

817

# Getting a policy that includes a conditional role binding

818

# Adding a conditional role binding to a policy

819

# Changing a conditional role binding in a policy

820

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

821

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

822

{ # Associates members with a role.

Bu Sun Kim

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

[diff] [blame]

823

"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).

824

# title: "Summary size limit"

825

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

826

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

827

# Example (Equality):

828

# title: "Requestor is owner"

829

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

830

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

831

# Example (Logic):

832

# title: "Public documents"

833

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

834

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

835

# Example (Data Manipulation):

836

# title: "Notification string"

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

},

845

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

846

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

847

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

848

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

849

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

850

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

851

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

852

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

853

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

854

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

855

"A String",

Bu Sun Kim

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

[diff] [blame]

856

],

Bu Sun Kim

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

[diff] [blame]

857

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

858

},

859

],

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

864

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

Dan O'Meara

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

[diff] [blame]

865

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

Bu Sun Kim

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

[diff] [blame]

866

867

Args:

868

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]

869

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

Bu Sun Kim

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

[diff] [blame]

870

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

Bu Sun Kim

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

[diff] [blame]

871

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

872

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]

873

x__xgafv: string, V1 error format.

874

Allowed values

875

1 - v1 error format

876

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

877

878

Returns:

879

An object of the form:

880

881

{ # The list of all clusters in a project.

Bu Sun Kim

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

[diff] [blame]

882

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

Bu Sun Kim

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

[diff] [blame]

883

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

Bu Sun Kim

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

[diff] [blame]

884

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

885

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

886

},

Bu Sun Kim

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

[diff] [blame]

887

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

888

"hdfsMetrics": { # The HDFS metrics.

889

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

890

},

Bu Sun Kim

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

[diff] [blame]

891

"yarnMetrics": { # The YARN metrics.

892

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

893

},

894

},

Bu Sun Kim

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

[diff] [blame]

895

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

896

"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)).

897

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

898

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

899

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

900

},

901

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

902

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

903

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

904

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

905

"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).

906

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

907

},

908

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

909

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

910

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

911

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

912

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

913

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

914

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

915

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

916

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

917

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

918

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

919

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

920

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

921

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

922

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

923

},

924

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

925

"A String",

Bu Sun Kim

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

[diff] [blame]

926

],

Bu Sun Kim

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

[diff] [blame]

927

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

928

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

929

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

930

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

931

},

932

],

933

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

934

"minCpuPlatform": "A String", # 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).

935

},

936

"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)).

937

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

938

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

939

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

940

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

941

# sub0

942

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

943

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

944

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

945

# default

946

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

947

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

948

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

949

# us-central1-f

950

"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)).

951

"a_key": "A String",

952

},

953

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

954

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

955

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

956

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

957

"A String",

958

],

959

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

960

},

961

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

962

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

963

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

964

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

965

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

966

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

967

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

968

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

969

"A String",

970

],

971

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

972

"A String",

973

],

974

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

975

},

976

"gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.

977

"namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.

978

"clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.

979

"targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'

980

},

981

},

982

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

983

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

984

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

Bu Sun Kim

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

[diff] [blame]

985

# capacity-scheduler: capacity-scheduler.xml

986

# core: core-site.xml

987

# distcp: distcp-default.xml

988

# hdfs: hdfs-site.xml

989

# hive: hive-site.xml

990

# mapred: mapred-site.xml

991

# pig: pig.properties

992

# spark: spark-defaults.conf

Dan O'Meara

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

[diff] [blame]

993

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

Bu Sun Kim

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

[diff] [blame]

994

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

995

},

Bu Sun Kim

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

[diff] [blame]

996

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

997

"A String",

Bu Sun Kim

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

[diff] [blame]

998

],

Bu Sun Kim

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

[diff] [blame]

999

},

Bu Sun Kim

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

[diff] [blame]

1000

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

1001

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

Bu Sun Kim

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

[diff] [blame]

1002

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

Dan O'Meara

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

[diff] [blame]

1003

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

1004

},

Bu Sun Kim

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

[diff] [blame]

1005

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

1006

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

1007

"a_key": "A String",

Dan O'Meara

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

[diff] [blame]

1008

},

Bu Sun Kim

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

[diff] [blame]

1009

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

Bu Sun Kim

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

[diff] [blame]

1010

},

Bu Sun Kim

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

[diff] [blame]

1011

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

1012

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

1013

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

1014

"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).

1015

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

Bu Sun Kim

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

[diff] [blame]

1016

},

Bu Sun Kim

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

[diff] [blame]

1017

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

1018

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

Bu Sun Kim

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

[diff] [blame]

1019

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

1020

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

Dan O'Meara

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

[diff] [blame]

1021

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

1022

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

Dan O'Meara

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

[diff] [blame]

1023

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

1024

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

1025

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

1026

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

1027

# 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-20 12:08:20 -0700

[diff] [blame]

1028

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

1029

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

1030

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

1031

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

1032

},

1033

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

1034

"A String",

1035

],

1036

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

Dan O'Meara

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

[diff] [blame]

1037

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

Bu Sun Kim

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

[diff] [blame]

1038

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1039

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

Bu Sun Kim

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

[diff] [blame]

1040

},

1041

],

Bu Sun Kim

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

[diff] [blame]

1042

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

1043

"minCpuPlatform": "A String", # 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).

1044

},

1045

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

1046

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

1047

},

1048

"securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.

1049

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

1050

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

1051

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

1052

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

1053

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

1054

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

1055

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

1056

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

1057

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

1058

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

1059

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

1060

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

1061

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

1062

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

1063

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

1064

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

Bu Sun Kim

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

[diff] [blame]

1065

},

Bu Sun Kim

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

[diff] [blame]

1066

},

Bu Sun Kim

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

[diff] [blame]

1067

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

Bu Sun Kim

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

[diff] [blame]

1068

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

1069

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

Bu Sun Kim

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

[diff] [blame]

1070

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

Bu Sun Kim

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

[diff] [blame]

1071

# ... master specific actions ...

1072

# else

1073

# ... worker specific actions ...

1074

# fi

1075

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

Bu Sun Kim

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

[diff] [blame]

1076

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

1077

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

Bu Sun Kim

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

[diff] [blame]

1078

},

1079

],

Bu Sun Kim

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

[diff] [blame]

1080

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

1081

"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)).

1082

"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).

1083

"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)).

1084

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

Bu Sun Kim

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

[diff] [blame]

1085

},

Bu Sun Kim

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

[diff] [blame]

1086

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

1087

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

1088

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

1089

"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).

1090

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

1091

},

1092

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

1093

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

Bu Sun Kim

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

[diff] [blame]

1094

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

1095

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

Dan O'Meara

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

[diff] [blame]

1096

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

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

[diff] [blame]

1097

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

Dan O'Meara

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

[diff] [blame]

1098

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

1099

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

1100

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

1101

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

1102

# 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-20 12:08:20 -0700

[diff] [blame]

1103

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

1104

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

1105

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

1106

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

1107

},

1108

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

1109

"A String",

1110

],

1111

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

Dan O'Meara

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

[diff] [blame]

1112

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

Bu Sun Kim

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

[diff] [blame]

1113

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1114

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

Bu Sun Kim

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

[diff] [blame]

1115

},

1116

],

Bu Sun Kim

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

[diff] [blame]

1117

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

1118

"minCpuPlatform": "A String", # 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).

Bu Sun Kim

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

[diff] [blame]

1119

},

1120

},

Bu Sun Kim

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

[diff] [blame]

1121

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

1122

{ # The status of a cluster and its instances.

1123

"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)).

1124

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

1125

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

1126

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

1127

},

1128

],

1129

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

1130

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

1131

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

Bu Sun Kim

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

[diff] [blame]

1132

},

1133

],

Bu Sun Kim

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

[diff] [blame]

1134

"nextPageToken": "A String", # Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent <code>ListClustersRequest</code>.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1140

<pre>Retrieves the next page of results.

1141

1142

Args:

1143

previous_request: The request for the previous page. (required)

1144

previous_response: The response from the request for the previous page. (required)

1145

1146

Returns:

Bu Sun Kim

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

[diff] [blame]

1147

A request object that you can call 'execute()' on to request the next

Bu Sun Kim

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

[diff] [blame]

1148

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1153

<code class="details" id="patch">patch(projectId, region, clusterName, body=None, gracefulDecommissionTimeout=None, requestId=None, updateMask=None, x__xgafv=None)</code>

Dan O'Meara

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

[diff] [blame]

1154

<pre>Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1beta2#clusteroperationmetadata).

Bu Sun Kim

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

[diff] [blame]

1155

1156

Args:

1157

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]

1158

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

Bu Sun Kim

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

[diff] [blame]

1159

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

Dan O'Meara

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

[diff] [blame]

1160

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

1161

The object takes the form of:

1162

1163

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

Bu Sun Kim

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

[diff] [blame]

1164

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

1165

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1166

},

Bu Sun Kim

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

[diff] [blame]

1167

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

1168

"hdfsMetrics": { # The HDFS metrics.

1169

"a_key": "A String",

Bu Sun Kim

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

[diff] [blame]

1170

},

Bu Sun Kim

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

[diff] [blame]

1171

"yarnMetrics": { # The YARN metrics.

1172

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1173

},

1174

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1175

"status": { # The status of a cluster and its instances. # Output only. Cluster status.

1176

"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)).

1177

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

1178

"detail": "A String", # Output only. Optional details of cluster's state.

1179

"state": "A String", # Output only. The cluster's state.

1180

},

1181

"config": { # The cluster config. # Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated.

1182

"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.

1183

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1184

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1185

"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).

1186

"numLocalSsds": 42, # Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1187

},

1188

"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.

1189

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

1190

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1191

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1192

# 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.

1193

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

1194

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1195

# projects/[project_id]/global/images/[image-id]

1196

# image-idImage family examples. Dataproc will use the most recent image from the family:

1197

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1198

# 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.

1199

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1200

"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.

1201

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1202

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1203

},

1204

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1205

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1206

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1207

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

1208

{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).

1209

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1210

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

1211

},

1212

],

1213

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1214

"minCpuPlatform": "A String", # 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).

1215

},

1216

"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)).

1217

"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.

1218

"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:

1219

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/subnetworks/sub0

1220

# projects/[project_id]/regions/us-east1/subnetworks/sub0

1221

# sub0

1222

"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:

1223

# https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default

1224

# projects/[project_id]/regions/global/default

1225

# default

1226

"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:

1227

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]

1228

# projects/[project_id]/zones/[zone]

1229

# us-central1-f

1230

"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)).

1231

"a_key": "A String",

1232

},

1233

"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.

1234

"reservationAffinity": { # Reservation Affinity for consuming Zonal reservation. # Optional. Reservation Affinity for consuming Zonal reservation.

1235

"key": "A String", # Optional. Corresponds to the label key of reservation resource.

1236

"values": [ # Optional. Corresponds to the label values of reservation resource.

1237

"A String",

1238

],

1239

"consumeReservationType": "A String", # Optional. Type of reservation to consume

1240

},

1241

"serviceAccountScopes": [ # Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:

1242

# https://www.googleapis.com/auth/cloud.useraccounts.readonly

1243

# https://www.googleapis.com/auth/devstorage.read_write

1244

# https://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:

1245

# https://www.googleapis.com/auth/bigquery

1246

# https://www.googleapis.com/auth/bigtable.admin.table

1247

# https://www.googleapis.com/auth/bigtable.data

1248

# https://www.googleapis.com/auth/devstorage.full_control

1249

"A String",

1250

],

1251

"tags": [ # The Compute Engine tags to add to all instances (see Tagging instances (https://cloud.google.com/compute/docs/label-or-tag-resources#tags)).

1252

"A String",

1253

],

1254

"serviceAccount": "A String", # Optional. The Dataproc service account (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/service-accounts#service_accounts_in_cloud_dataproc) (also see VM Data Plane identity (https://cloud.google.com/dataproc/docs/concepts/iam/dataproc-principals#vm_service_account_data_plane_identity)) used by Dataproc cluster VM instances to access Google Cloud Platform services.If not specified, the Compute Engine default service account (https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.

1255

},

1256

"gkeClusterConfig": { # The GKE config for this cluster. # Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as gce_cluster_config, master_config, worker_config, secondary_worker_config, and autoscaling_config.

1257

"namespacedGkeDeploymentTarget": { # A full, namespace-isolated deployment target for an existing GKE cluster. # Optional. A target for the deployment.

1258

"clusterNamespace": "A String", # Optional. A namespace within the GKE cluster to deploy into.

1259

"targetGkeCluster": "A String", # Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}'

1260

},

1261

},

1262

"softwareConfig": { # Specifies the selection and config of software inside the cluster. # Optional. The config settings for software inside the cluster.

1263

"imageVersion": "A String", # Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version (https://cloud.google.com/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.

1264

"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:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1265

# capacity-scheduler: capacity-scheduler.xml

1266

# core: core-site.xml

1267

# distcp: distcp-default.xml

1268

# hdfs: hdfs-site.xml

1269

# hive: hive-site.xml

1270

# mapred: mapred-site.xml

1271

# pig: pig.properties

1272

# spark: spark-defaults.conf

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1273

# yarn: yarn-site.xmlFor more information, see Cluster properties (https://cloud.google.com/dataproc/docs/concepts/cluster-properties).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1274

"a_key": "A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1275

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1276

"optionalComponents": [ # The set of optional components to activate on the cluster.

1277

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1278

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1279

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1280

"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.

1281

"policyUri": "A String", # Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1282

# https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1283

# projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.

1284

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1285

"endpointConfig": { # Endpoint config for this cluster # Optional. Port/endpoint configuration for this cluster

1286

"httpPorts": { # Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true.

1287

"a_key": "A String",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1288

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1289

"enableHttpPortAccess": True or False, # Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1290

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1291

"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.

1292

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1293

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1294

"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).

1295

"numLocalSsds": 42, # Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1296

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1297

"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.

1298

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1299

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1300

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1301

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1302

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1303

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1304

# projects/[project_id]/global/images/[image-id]

1305

# image-idImage family examples. Dataproc will use the most recent image from the family:

1306

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1307

# 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-20 12:08:20 -0700

[diff] [blame]

1308

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1309

"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.

1310

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1311

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1312

},

1313

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1314

"A String",

1315

],

1316

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1317

{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1318

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1319

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1320

},

1321

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1322

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1323

"minCpuPlatform": "A String", # 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).

1324

},

1325

"encryptionConfig": { # Encryption settings for the cluster. # Optional. Encryption settings for the cluster.

1326

"gcePdKmsKeyName": "A String", # Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.

1327

},

1328

"securityConfig": { # Security related configuration, including encryption, Kerberos, etc. # Optional. Security related configuration.

1329

"kerberosConfig": { # Specifies Kerberos related configuration. # Kerberos related configuration.

1330

"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.

1331

"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.

1332

"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.

1333

"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.

1334

"crossRealmTrustAdminServer": "A String", # Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1335

"kdcDbKeyUri": "A String", # Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.

1336

"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.

1337

"realm": "A String", # Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.

1338

"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.

1339

"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.

1340

"crossRealmTrustRealm": "A String", # Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.

1341

"rootPrincipalPasswordUri": "A String", # Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.

1342

"kmsKeyUri": "A String", # Required. The uri of the KMS key used to encrypt various sensitive files.

1343

"crossRealmTrustKdc": "A String", # Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.

1344

"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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1345

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1346

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1347

"initializationActions": [ # Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's <code>role</code> metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1348

# ROLE=$(curl -H Metadata-Flavor:Google

1349

# http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1350

# if [[ "${ROLE}" == 'Master' ]]; then

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1351

# ... master specific actions ...

1352

# else

1353

# ... worker specific actions ...

1354

# fi

1355

{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1356

"executableFile": "A String", # Required. Cloud Storage URI of executable file.

1357

"executionTimeout": "A String", # Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1358

},

1359

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1360

"lifecycleConfig": { # Specifies the cluster auto-delete schedule configuration. # Optional. The config setting for auto delete cluster schedule.

1361

"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)).

1362

"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).

1363

"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)).

1364

"idleStartTime": "A String", # Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1365

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1366

"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.

1367

"diskConfig": { # Specifies the config of disk options for a group of VM instances. # Optional. Disk option config settings.

1368

"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).

1369

"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).

1370

"numLocalSsds": 42, # Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.

1371

},

1372

"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.

1373

"machineTypeUri": "A String", # Optional. The Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1374

# https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

1375

# projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1376

# n1-standard-2Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, n1-standard-2.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1377

"imageUri": "A String", # Optional. The Compute Engine image resource used for cluster instances.The URI can represent an image or image family.Image examples:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1378

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/[image-id]

1379

# projects/[project_id]/global/images/[image-id]

1380

# image-idImage family examples. Dataproc will use the most recent image from the family:

1381

# https://www.googleapis.com/compute/beta/projects/[project_id]/global/images/family/[custom-image-family-name]

1382

# 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-20 12:08:20 -0700

[diff] [blame]

1383

"isPreemptible": True or False, # Output only. Specifies that this instance group contains preemptible instances.

1384

"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.

1385

"instanceGroupManagerName": "A String", # Output only. The name of the Instance Group Manager for this group.

1386

"instanceTemplateName": "A String", # Output only. The name of the Instance Template used for the Managed Instance Group.

1387

},

1388

"instanceNames": [ # Output only. The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group.

1389

"A String",

1390

],

1391

"accelerators": [ # Optional. The Compute Engine accelerator configuration for these instances.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1392

{ # Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/)).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1393

"acceleratorTypeUri": "A String", # Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.

1394

"acceleratorCount": 42, # The number of the accelerator cards of this type exposed to this instance.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1395

},

1396

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1397

"numInstances": 42, # Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.

1398

"minCpuPlatform": "A String", # 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).

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1399

},

1400

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1401

"statusHistory": [ # Output only. The previous cluster status.

1402

{ # The status of a cluster and its instances.

1403

"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)).

1404

"substate": "A String", # Output only. Additional state information that includes status reported by the agent.

1405

"detail": "A String", # Output only. Optional details of cluster's state.

1406

"state": "A String", # Output only. The cluster's state.

1407

},

1408

],

1409

"clusterName": "A String", # Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.

1410

"clusterUuid": "A String", # Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.

1411

"projectId": "A String", # Required. The Google Cloud Platform project ID that the cluster belongs to.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1412

}

1413

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1414

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

2019-06-14 16:50:42 -0700

[diff] [blame]

1415

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.

1416

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:

1417

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1418

"config":{

1419

"workerConfig":{

1420

"numInstances":"5"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}

}

}

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:

1425

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1426

"config":{

1427

"secondaryWorkerConfig":{

1428

"numInstances":"5"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1429

}

1430

}

1431

}

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1432

<strong>Note:</strong> currently only the following fields can be updated:

1433

<table>

1434

<tr>

1435

<td><strong>Mask</strong></td><td><strong>Purpose</strong></td>

1436

</tr>

1437

<tr>

1438

<td>labels</td><td>Updates labels</td>

1439

</tr>

1440

<tr>

1441

<td>config.worker_config.num_instances</td><td>Resize primary worker

group</td>

</tr>

<tr>

<td>config.secondary_worker_config.num_instances</td><td>Resize secondary

worker group</td>

</tr>

<tr>

<td>config.lifecycle_config.auto_delete_ttl</td><td>Reset MAX TTL

duration</td>

</tr>

<tr>

<td>config.lifecycle_config.auto_delete_time</td><td>Update MAX TTL

1454

deletion timestamp</td>

1455

</tr>

1456

<tr>

1457

<td>config.lifecycle_config.idle_delete_ttl</td><td>Update Idle TTL

duration</td>

</tr>

<tr>

<td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change

1462

autoscaling policies</td>

1463

</tr>

1464

</table>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1465

x__xgafv: string, V1 error format.

1466

Allowed values

1467

1 - v1 error format

1468

2 - v2 error format

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1469

1470

Returns:

1471

An object of the form:

1472

1473

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1474

"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.

1475

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1476

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1477

"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}.

1478

"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.

1479

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1480

"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.

1481

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1482

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1483

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1484

},

1485

],

1486

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1487

"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.

1488

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1489

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1490

"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]

1495

<code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1496

<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]

1497

1498

Args:

1499

resource: string, REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1500

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1501

The object takes the form of:

1502

1503

{ # Request message for SetIamPolicy method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1504

"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]

1505

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1506

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1507

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1508

# "role": "roles/resourcemanager.organizationAdmin",

1509

# "members": [

1510

# "user:mike@example.com",

1511

# "group:admins@example.com",

1512

# "domain:google.com",

1513

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1514

# ]

1515

# },

1516

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1517

# "role": "roles/resourcemanager.organizationViewer",

1518

# "members": [

1519

# "user:eve@example.com"

1520

# ],

1521

# "condition": {

1522

# "title": "expirable access",

1523

# "description": "Does not grant access after Sep 2020",

1524

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1525

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1526

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1527

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1528

# "etag": "BwWWja0YfJA=",

1529

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1530

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1531

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1532

# bindings:

1533

# - members:

1534

# - user:mike@example.com

1535

# - group:admins@example.com

1536

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1537

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1538

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1539

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1540

# - user:eve@example.com

1541

# role: roles/resourcemanager.organizationViewer

1542

# condition:

1543

# title: expirable access

1544

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1545

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1546

# - etag: BwWWja0YfJA=

1547

# - version: 3

1548

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1549

"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.

1550

"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:

1551

# Getting a policy that includes a conditional role binding

1552

# Adding a conditional role binding to a policy

1553

# Changing a conditional role binding in a policy

1554

# 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).

1555

"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]

1556

{ # Associates members with a role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1557

"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).

1558

# title: "Summary size limit"

1559

# description: "Determines if a summary is less than 100 chars"

1560

# expression: "document.summary.size() < 100"

1561

# Example (Equality):

1562

# title: "Requestor is owner"

1563

# description: "Determines if requestor is the document owner"

1564

# expression: "document.owner == request.auth.claims.email"

1565

# Example (Logic):

1566

# title: "Public documents"

1567

# description: "Determine whether the document should be publicly visible"

1568

# expression: "document.type != 'private' && document.type != 'internal'"

1569

# Example (Data Manipulation):

1570

# title: "Notification string"

1571

# description: "Create a notification string with a timestamp."

1572

# expression: "'New message received at ' + string(document.create_time)"

1573

# 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.

1574

"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.

1575

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1576

"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.

1577

"location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

1578

},

1579

"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]

1580

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1581

# 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]

1582

# 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]

1583

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1584

# 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]

1585

# 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.

1586

# 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.

1587

# 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]

1588

# 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]

1589

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1590

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1591

"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]

1592

},

1593

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1604

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1605

{ # 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]

1606

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1607

# "bindings": [

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1608

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1609

# "role": "roles/resourcemanager.organizationAdmin",

1610

# "members": [

1611

# "user:mike@example.com",

1612

# "group:admins@example.com",

1613

# "domain:google.com",

1614

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1615

# ]

1616

# },

1617

# {

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1618

# "role": "roles/resourcemanager.organizationViewer",

1619

# "members": [

1620

# "user:eve@example.com"

1621

# ],

1622

# "condition": {

1623

# "title": "expirable access",

1624

# "description": "Does not grant access after Sep 2020",

1625

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1626

# }

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1627

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1628

# ],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1629

# "etag": "BwWWja0YfJA=",

1630

# "version": 3

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1631

# }

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1632

# YAML example:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1633

# bindings:

1634

# - members:

1635

# - user:mike@example.com

1636

# - group:admins@example.com

1637

# - domain:google.com

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1638

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1639

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1640

# - members:

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1641

# - user:eve@example.com

1642

# role: roles/resourcemanager.organizationViewer

1643

# condition:

1644

# title: expirable access

1645

# description: Does not grant access after Sep 2020

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1646

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1647

# - etag: BwWWja0YfJA=

1648

# - version: 3

1649

# For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1650

"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.

1651

"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:

1652

# Getting a policy that includes a conditional role binding

1653

# Adding a conditional role binding to a policy

1654

# Changing a conditional role binding in a policy

1655

# 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).

1656

"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]

1657

{ # Associates members with a role.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1658

"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).

1659

# title: "Summary size limit"

1660

# description: "Determines if a summary is less than 100 chars"

1661

# expression: "document.summary.size() < 100"

1662

# Example (Equality):

1663

# title: "Requestor is owner"

1664

# description: "Determines if requestor is the document owner"

1665

# expression: "document.owner == request.auth.claims.email"

1666

# Example (Logic):

1667

# title: "Public documents"

1668

# description: "Determine whether the document should be publicly visible"

1669

# expression: "document.type != 'private' && document.type != 'internal'"

1670

# Example (Data Manipulation):

1671

# title: "Notification string"

1672

# description: "Create a notification string with a timestamp."

1673

# expression: "'New message received at ' + string(document.create_time)"

1674

# 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.

1675

"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.

1676

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

1677

"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.

1678

"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.

1679

},

1680

"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]

1681

# allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.

1682

# 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]

1683

# 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]

1684

# serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.

1685

# 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]

1686

# 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.

1687

# 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.

1688

# 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]

1689

# 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]

1690

"A String",

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1691

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1692

"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]

1693

},

1694

],

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]

1699

<code class="details" id="start">start(projectId, region, clusterName, body=None, x__xgafv=None)</code>

1700

<pre>Starts a cluster in a project.

1701

1702

Args:

1703

projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)

1704

region: string, Required. The Dataproc region in which to handle the request. (required)

1705

clusterName: string, Required. The cluster name. (required)

1706

body: object, The request body.

1707

The object takes the form of:

1708

1709

{ # A request to start a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1710

"requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two StartClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

1711

"clusterUuid": "A String", # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1712

}

1713

1714

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1721

1722

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1723

"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.

1724

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1725

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1726

"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}.

1727

"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.

1728

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1729

"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.

1730

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1731

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1732

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1733

},

1734

],

1735

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1736

"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.

1737

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1738

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1739

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="stop">stop(projectId, region, clusterName, body=None, x__xgafv=None)</code>

1745

<pre>Stops a cluster in a project.

1746

1747

Args:

1748

projectId: string, Required. The ID of the Google Cloud Platform project the cluster belongs to. (required)

1749

region: string, Required. The Dataproc region in which to handle the request. (required)

1750

clusterName: string, Required. The cluster name. (required)

1751

body: object, The request body.

1752

The object takes the form of:

1753

1754

{ # A request to stop a cluster.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1755

"clusterUuid": "A String", # Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.

1756

"requestId": "A String", # Optional. A unique id used to identify the request. If the server receives two StopClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1757

}

1758

1759

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1766

1767

{ # This resource represents a long-running operation that is the result of a network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1768

"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.

1769

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1770

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1771

"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}.

1772

"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.

1773

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

1774

"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.

1775

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1776

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1777

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1778

},

1779

],

1780

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1781

"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.

1782

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1783

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1784

"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.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<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]

1790

<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]

1791

1792

Args:

1793

resource: string, REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1794

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

1795

The object takes the form of:

1796

1797

{ # Request message for TestIamPermissions method.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1798

"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).

1799

"A String",

Bu Sun Kim