Google Git
Sign in
chromium / external / github.com / google / google-api-python-client / v1.6.0 / . / docs / dyn / dataproc_v1alpha1.projects.regions.clusters.html
blob: 615cf0afefe5401bcd7cd2df368025ca84d13b7c [file] [log] [blame]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="dataproc_v1alpha1.html">Google Cloud Dataproc API</a> . <a href="dataproc_v1alpha1.projects.html">projects</a> . <a href="dataproc_v1alpha1.projects.regions.html">regions</a> . <a href="dataproc_v1alpha1.projects.regions.clusters.html">clusters</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#create">create(projectId, region, body, x__xgafv=None)</a></code></p>
<p class="firstline">Request to create a cluster in a project.</p>
<p class="toc_element">
<code><a href="#delete">delete(projectId, region, clusterName, x__xgafv=None)</a></code></p>
<p class="firstline">Request to delete a cluster in a project.</p>
<p class="toc_element">
<code><a href="#get">get(projectId, region, clusterName, x__xgafv=None)</a></code></p>
<p class="firstline">Request to get the resource representation for a cluster in a project.</p>
<p class="toc_element">
<code><a href="#list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request a list of all regions/{region}/clusters in a project.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Request to update a cluster in a project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="create">create(projectId, region, body, x__xgafv=None)</code>
<pre>Request to create a cluster in a project.
Args:
projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, [Required] The Dataproc region in which to handle the request. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
"statusHistory": [ # [Output-only] Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
],
"clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # [Optional] The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
"imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
"properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
"zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
"initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
},
],
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
},
"createTime": "A String", # [Output-only] The timestamp of cluster creation.
}
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
"name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(projectId, region, clusterName, x__xgafv=None)</code>
<pre>Request to delete a cluster in a project.
Args:
projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, [Required] The Dataproc region in which to handle the request. (required)
clusterName: string, [Required] The cluster name. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
"name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(projectId, region, clusterName, x__xgafv=None)</code>
<pre>Request to get the resource representation for a cluster in a project.
Args:
projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, [Required] The Dataproc region in which to handle the request. (required)
clusterName: string, [Required] The cluster name. (required)
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
"statusHistory": [ # [Output-only] Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
],
"clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # [Optional] The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
"imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
"properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
"zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
"initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
},
],
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
},
"createTime": "A String", # [Output-only] The timestamp of cluster creation.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(projectId, region, pageSize=None, filter=None, pageToken=None, x__xgafv=None)</code>
<pre>Request a list of all regions/{region}/clusters in a project.
Args:
projectId: string, [Required] The ID of the Google Cloud Platform project that the cluster belongs to. (required)
region: string, [Required] The Dataproc region in which to handle the request. (required)
pageSize: integer, The standard List page size.
filter: string, [Optional] A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)
pageToken: string, The standard List page token.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # The list of all clusters in a project.
"nextPageToken": "A String", # The standard List next-page token.
"clusters": [ # [Output-only] The clusters in the project.
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
"statusHistory": [ # [Output-only] Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
],
"clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # [Optional] The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
"imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
"properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
"zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
"initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
},
],
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
},
"createTime": "A String", # [Output-only] The timestamp of cluster creation.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(projectId, region, clusterName, body, updateMask=None, x__xgafv=None)</code>
<pre>Request to update a cluster in a project.
Args:
projectId: string, [Required] The ID of the Google Cloud Platform project the cluster belongs to. (required)
region: string, [Required] The Dataproc region in which to handle the request. (required)
clusterName: string, [Required] The cluster name. (required)
body: object, The request body. (required)
The object takes the form of:
{ # Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.
"status": { # The status of a cluster and its instances. # [Output-only] Cluster status.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
"statusHistory": [ # [Output-only] Previous cluster statuses.
{ # The status of a cluster and its instances.
"state": "A String", # The cluster's state.
"stateStartTime": "A String", # Time when this state was entered.
"detail": "A String", # Optional details of cluster's state.
},
],
"clusterUuid": "A String", # [Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
"clusterName": "A String", # [Required] The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.
"projectId": "A String", # [Required] The Google Cloud Platform project ID that the cluster belongs to.
"labels": { # [Optional] The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \p{Ll}\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 64 labels can be associated with a given cluster.
"a_key": "A String",
},
"metrics": { # Contains cluster daemon metrics, such as HDFS and YARN stats. # Contains cluster daemon metrics such as HDFS and YARN stats.
"yarnMetrics": { # The YARN metrics.
"a_key": "A String",
},
"hdfsMetrics": { # The HDFS metrics.
"a_key": "A String",
},
},
"configuration": { # The cluster configuration. # [Required] The cluster configuration. It may differ from a user's initial configuration due to Cloud Dataproc setting of default values and updating clusters.
"softwareConfiguration": { # Specifies the selection and configuration of software inside the cluster. # [Optional] The configuration settings for software inside the cluster.
"imageVersion": "A String", # [Optional] The version of software inside the cluster. It must match the regular expression [0-9]+\.[0-9]+. If unspecified it will default to latest version.
"properties": { # [Optional] The properties to set on daemon configuration files. Property keys are specified in "prefix:property" format, such as "core:fs.defaultFS". The following are supported prefixes and their mappings: core - core-site.xml hdfs - hdfs-site.xml mapred - mapred-site.xml yarn - yarn-site.xml hive - hive-site.xml pig - pig.properties spark - spark-defaults.conf
"a_key": "A String",
},
},
"workerDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of worker node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workers": [ # [Deprecated] The list of worker node names. Dataproc derives the names from cluster_name and num_workers if not set by user (recommended practice is to let Dataproc derive the name). Derived worker node name example: hadoop-w-0.
"A String",
],
"masterConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for the master instance in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"gceClusterConfiguration": { # Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Optional] The shared Google Compute Engine configuration settings for all instances in a cluster.
"internalIpOnly": True or False, # If true, all instances in the cluser 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 restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.
"networkUri": "A String", # The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a "Custom Subnet Network" (see https://cloud.google.com/compute/docs/subnetworks for more information). Example: `compute.googleapis.com/projects/[project_id]/regions/global/default`.
"tags": [ # The Google Compute Engine tags to add to all instances.
"A String",
],
"zoneUri": "A String", # [Required] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"subnetworkUri": "A String", # The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `compute.googleapis.com/projects/[project_id]/regions/us-east1/sub0`.
"serviceAccountScopes": [ # The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"metadata": { # The Google Compute Engine metadata entries to add to all instances.
"a_key": "A String",
},
},
"masterName": "A String", # [Deprecated] The Master's hostname. Dataproc derives the name from cluster_name if not set by user (recommended practice is to let Dataproc derive the name). Derived master name example: hadoop-m.
"configurationBucket": "A String", # [Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, then it will create and manage this project-level, per-location bucket for you.
"gceConfiguration": { # [Deprecated] Common configuration settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster. # [Deprecated] The Google Compute Engine configuration settings for cluster resources.
"machineTypeUri": "A String", # [Deprecated] The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"networkUri": "A String", # [Deprecated] The Google Compute Engine network to be used for machine communications. Inbound SSH connections are necessary to complete cluster configuration. Example "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/default".
"zoneUri": "A String", # [Deprecated] The zone where the Google Compute Engine cluster will be located. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a".
"serviceAccountScopes": [ # [Deprecated] The service account scopes included in Google Compute Engine instances. Must include devstorage.full_control to enable the Google Cloud Storage connector. Example "auth.googleapis.com/compute" and "auth.googleapis.com/devstorage.full_control".
"A String",
],
"imageUri": "A String", # [Deprecated] The Google Compute Engine image resource used for cluster instances. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
},
"secondaryWorkerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for additional worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
"numWorkers": 42, # [Deprecated] The number of worker nodes in the cluster.
"initializationActions": [ # [Optional] Commands to execute on each node after configuration is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below: ROLE=$(/usr/share/google/get_metadata_value attributes/role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
{ # Specifies an executable to run on a fully configured node and a timeout period for executable completion.
"executionTimeout": "A String", # [Optional] Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.
"executableFile": "A String", # [Required] Google Cloud Storage URI of executable file.
},
],
"masterDiskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # [Deprecated] The configuration settings of master node disk options.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"workerConfiguration": { # The configuration settings for Google Compute Engine resources in an instance group, such as a master or worker group. # [Optional] The Google Compute Engine configuration settings for worker instances in a cluster.
"isPreemptible": True or False, # Specifies that this instance group contains Preemptible Instances.
"machineTypeUri": "A String", # The Google Compute Engine machine type used for cluster instances. Example: "compute.googleapis.com/projects/[project_id] /zones/us-east1-a/machineTypes/n1-standard-2".
"instanceNames": [ # The list of instance names. Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Dataproc derive the name).
"A String",
],
"imageUri": "A String", # [Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfiguration.image_version. Example: "compute.googleapis.com/projects/debian-cloud /global/images/backports-debian-7-wheezy-v20140904".
"numInstances": 42, # The number of VM instances in the instance group. For master instance groups, must be set to 1.
"diskConfiguration": { # Specifies the configuration of disk options for a group of VM instances. # Disk option configuration settings.
"numLocalSsds": 42, # [Optional] Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs, and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic configuration and installed binaries.
"bootDiskSizeGb": 42, # [Optional] Size in GB of the boot disk (default is 500GB).
},
"managedGroupConfiguration": { # Specifies the resources used to actively manage an instance group. # [Output-only] The configuration for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
"instanceTemplateName": "A String", # [Output-only] The name of Instance Template used for Managed Instance Group.
"instanceGroupManagerName": "A String", # [Output-only] The name of Instance Group Manager managing this group.
},
},
},
"createTime": "A String", # [Output-only] The timestamp of cluster creation.
}
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 "configuration.worker_configuration.num_instances," and the PATCH request body would specify the new value, as follows: { "configuration":{ "workerConfiguration":{ "numInstances":"5" } } } Note: Currently, configuration.worker_configuration.num_instances is the only field that can be updated.
x__xgafv: string, V1 error format.
Returns:
An object of the form:
{ # An asynchronous operation in a project that runs over a given cluster. Used to track the progress of a user request that is running asynchronously. Examples include creating a cluster, updating a cluster, and deleting a cluster.
"response": { # The operation response. If the called method returns no data on success, the response is `google.protobuf.Empty`. If the called method is `Get`,`Create` or `Update`, the response is the resource. For all other methods, the response type is a concatenation of the method name and "Response". For example, if the called method is `TakeSnapshot()`, the response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). The error model is designed to be: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `Status` message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers *understand* and *resolve* the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package `google.rpc` which can be used for common error conditions. # Language mapping The `Status` message is the logical representation of the error model, but it is not necessarily the actual wire format. When the `Status` message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C. # Other uses The error model and the `Status` message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments. Example uses of this error model include: - Partial errors. If a service needs to return partial errors to the client, it may embed the `Status` in the normal response to indicate the partial errors. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch operations. If a client uses batch request and batch response, the `Status` message should be used directly inside batch response, one for each error sub-response. - Asynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the `Status` message. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons. # The error result of the operation in case of failure.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There will be a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
},
"done": True or False, # Indicates if the operation is done. If true, the operation is complete and the `result` is available. If false, the operation is still in progress.
"name": "A String", # The name of the operation resource, in the format projects/[project_id]/operations/[operation_id]
"metadata": { # Service-specific metadata associated with the operation.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>