{
  "id": "string",
  "description": "string",
  "created_at": "google.protobuf.Timestamp",
  "created_by": "string",
  "modified_at": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "cluster_id": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folder_id": "string",
    "created_at": "google.protobuf.Timestamp",
    "name": "string",
    "description": "string",
    "labels": "map<string, string>",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "config": {
      "version_id": "string",
      "hadoop": {
        "services": [
          "Service"
        ],
        "properties": "map<string, string>",
        "ssh_public_keys": [
          "string"
        ],
        "initialization_actions": [
          {
            "uri": "string",
            "args": [
              "string"
            ],
            "timeout": "int64"
          }
        ]
      }
    },
    "health": "Health",
    "status": "Status",
    "zone_id": "string",
    "service_account_id": "string",
    "bucket": "string",
    "ui_proxy": "bool",
    "security_group_ids": [
      "string"
    ],
    "host_group_ids": [
      "string"
    ],
    "deletion_protection": "bool",
    "log_group_id": "string",
    "environment": "Environment"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field	Description
id	string ID of the operation.
description	string Description of the operation. 0-256 characters long.
created_at	google.protobuf.Timestamp Creation timestamp.
created_by	string ID of the user or service account who initiated the operation.
modified_at	google.protobuf.Timestamp The time when the Operation resource was last modified.
done	bool 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.
metadata	StartClusterMetadata Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any.
error	google.rpc.Status The error result of the operation in case of failure or cancellation. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.
response	Cluster 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 the standard Create/Update, the response should be the target resource of the operation. Any method that returns a long-running operation should document the response type, if any. Includes only one of the fields `error`, `response`. The operation result. If `done == false` and there was no failure detected, neither `error` nor `response` is set. If `done == false` and there was a failure detected, `error` is set. If `done == true`, exactly one of `error` or `response` is set.

StartClusterMetadata

Field

Description

cluster_id

string

ID of the Data Proc cluster that is being started.

Cluster

A Data Proc cluster. For details about the concept, see documentation.

Field	Description
id	string ID of the cluster. Generated at creation time.
folder_id	string ID of the folder that the cluster belongs to.
created_at	google.protobuf.Timestamp Creation timestamp.
name	string Name of the cluster. The name is unique within the folder.
description	string Description of the cluster.
labels	object (map<string, string>) Cluster labels as `key:value` pairs.
monitoring[]	Monitoring Monitoring systems relevant to the cluster.
config	ClusterConfig Configuration of the cluster.
health	enum Health Aggregated cluster health. `HEALTH_UNKNOWN`: Object is in unknown state (we have no data). `ALIVE`: Object is alive and well (for example, all hosts of the cluster are alive). `DEAD`: Object is inoperable (it cannot perform any of its essential functions). `DEGRADED`: Object is partially alive (it can perform some of its essential functions).
status	enum Status Cluster status. `STATUS_UNKNOWN`: Cluster state is unknown. `CREATING`: Cluster is being created. `RUNNING`: Cluster is running normally. `ERROR`: Cluster encountered a problem and cannot operate. `STOPPING`: Cluster is stopping. `STOPPED`: Cluster stopped. `STARTING`: Cluster is starting.
zone_id	string ID of the availability zone where the cluster resides.
service_account_id	string ID of service account for the Data Proc manager agent.
bucket	string Object Storage bucket to be used for Data Proc jobs that are run in the cluster.
ui_proxy	bool Whether UI Proxy feature is enabled.
security_group_ids[]	string User security groups.
host_group_ids[]	string Host groups hosting VMs of the cluster.
deletion_protection	bool Deletion Protection inhibits deletion of the cluster
log_group_id	string ID of the cloud logging log group to write logs. If not set, default log group for the folder will be used. To prevent logs from being sent to the cloud set cluster property dataproc:disable_cloud_logging = true
environment	enum Environment Environment of the cluster `ENVIRONMENT_UNSPECIFIED` `PRODUCTION` `PRESTABLE`

Monitoring

Metadata of a monitoring system for a Data Proc cluster.

Field	Description
name	string Name of the monitoring system.
description	string Description of the monitoring system.
link	string Link to the monitoring system.

ClusterConfig

Field

Description

version_id

string

Image version for cluster provisioning.
All available versions are listed in the documentation.

hadoop

HadoopConfig

Data Proc specific configuration options.

HadoopConfig

Hadoop configuration that describes services installed in a cluster,
their properties and settings.

Field	Description
services[]	enum Service Set of services used in the cluster (if empty, the default set is used). `SERVICE_UNSPECIFIED` `HDFS` `YARN` `MAPREDUCE` `HIVE` `TEZ` `ZOOKEEPER` `HBASE` `SQOOP` `FLUME` `SPARK` `ZEPPELIN` `OOZIE` `LIVY`
properties	object (map<string, string>) Properties set for all hosts in `*-site.xml` configurations. The key should indicate the service and the property. For example, use the key 'hdfs:dfs.replication' to set the `dfs.replication` property in the file `/etc/hadoop/conf/hdfs-site.xml`.
ssh_public_keys[]	string List of public SSH keys to access to cluster hosts.
initialization_actions[]	InitializationAction Set of init-actions

InitializationAction

Field	Description
uri	string URI of the executable file
args[]	string Arguments to the initialization action
timeout	int64 Execution timeout

Data Proc API, gRPC: ClusterService.Start

gRPC requestgRPC request

StartClusterRequestStartClusterRequest

operation.Operationoperation.Operation

StartClusterMetadataStartClusterMetadata

ClusterCluster

MonitoringMonitoring

ClusterConfigClusterConfig

HadoopConfigHadoopConfig

InitializationActionInitializationAction

Was the article helpful?

gRPC request

StartClusterRequest