package google.cloud.dataproc.v1
Get desktop application:
View/edit binary Protocol Buffers messages
The ClusterControllerService provides methods to manage clusters of Google Compute Engine instances.
rpc CreateCluster (, )
clusters.proto:36Creates a cluster in a project.
message
clusters.proto:427A request to create a cluster.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
optional cluster = 2
Required. The cluster to create.
rpc DeleteCluster (, )
clusters.proto:46Deletes a cluster in a project.
message
clusters.proto:505A request to delete a cluster.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string cluster_name = 2
Required. The cluster name.
rpc DiagnoseCluster (, )
clusters.proto:63Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.
message
clusters.proto:579A request to collect cluster diagnostic information.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string cluster_name = 2
Required. The cluster name.
rpc GetCluster (, )
clusters.proto:51Gets the resource representation for a cluster in a project.
message
clusters.proto:518Request to get the resource representation for a cluster in a project.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string cluster_name = 2
Required. The cluster name.
rpc ListClusters (, )
clusters.proto:56Lists all regions/{region}/clusters in a project.
message
clusters.proto:531A request to list the clusters in a project.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the cluster belongs to.
string region = 4
Required. The Cloud Dataproc region in which to handle the request.
string filter = 5
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 = *
int32 page_size = 2
Optional. The standard List page size.
string page_token = 3
Optional. The standard List page token.
message
clusters.proto:568The list of all clusters in a project.
repeated clusters = 1
Output-only. The clusters in the project.
string next_page_token = 2
Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the `page_token` in a subsequent `ListClustersRequest`.
rpc UpdateCluster (, )
clusters.proto:41Updates a cluster in a project.
message
clusters.proto:440A request to update a cluster.
string project_id = 1
Required. The ID of the Google Cloud Platform project the cluster belongs to.
string region = 5
Required. The Cloud Dataproc region in which to handle the request.
string cluster_name = 2
Required. The cluster name.
optional cluster = 3
Required. The changes to the cluster.
optional update_mask = 4
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: { "config":{ "workerConfig":{ "numInstances":"5" } } } 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: { "config":{ "secondaryWorkerConfig":{ "numInstances":"5" } } } <strong>Note:</strong> Currently, only the following fields can be updated: <table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> </tbody> </table>
service JobController
jobs.proto:31The JobController provides methods to manage jobs.
rpc CancelJob (, )
jobs.proto:56Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).
message
jobs.proto:717A request to cancel a job.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string job_id = 2
Required. The job ID.
rpc DeleteJob (, )
jobs.proto:62Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
message
jobs.proto:730A request to delete a job.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string job_id = 2
Required. The job ID.
rpc GetJob (, )
jobs.proto:38Gets the resource representation for a job in a project.
message
jobs.proto:613A request to get the resource representation for a job in a project.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
string job_id = 2
Required. The job ID.
rpc ListJobs (, )
jobs.proto:43Lists regions/{region}/jobs in a project.
message
jobs.proto:626A request to list jobs in a project.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 6
Required. The Cloud Dataproc region in which to handle the request.
int32 page_size = 2
Optional. The number of results to return in each response.
string page_token = 3
Optional. The page token, returned by a previous call, to request the next page of results.
string cluster_name = 4
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
ListJobsRequest.JobStateMatcher job_state_matcher = 5
Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If `filter` is provided, `jobStateMatcher` will be ignored.
string filter = 7
Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: [field = value] AND [field [= value]] ... where **field** is `status.state` or `labels.[KEY]`, and `[KEY]` is a label key. **value** can be `*` to match all values. `status.state` can be either `ACTIVE` or `NON_ACTIVE`. Only the logical `AND` operator is supported; space-separated items are treated as having an implicit `AND` operator. Example filter: status.state = ACTIVE AND labels.env = staging AND labels.starred = *
message
jobs.proto:706A list of jobs in a project.
repeated jobs = 1
Output-only. Jobs list.
string next_page_token = 2
Optional. 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>ListJobsRequest</code>.
rpc SubmitJob (, )
jobs.proto:33Submits a job to a cluster.
message
jobs.proto:600A request to submit a job.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 3
Required. The Cloud Dataproc region in which to handle the request.
optional job = 2
Required. The job resource.
rpc UpdateJob (, )
jobs.proto:48Updates a job in a project.
message
jobs.proto:682A request to update a job.
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string region = 2
Required. The Cloud Dataproc region in which to handle the request.
string job_id = 3
Required. The job ID.
optional job = 4
Required. The changes to the job.
optional update_mask = 5
Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the `PATCH` request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.
message
clusters.proto:290Specifies the type and number of accelerator cards attached to the instances of an instance group (see [GPUs on Compute Engine](/compute/docs/gpus/)).
Used in:
string accelerator_type_uri = 1
Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See [Google Compute Engine AcceleratorTypes]( /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-k80`
int32 accelerator_count = 2
The number of the accelerator cards of this type exposed to this instance.
message
clusters.proto:70Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.
Used as response type in: ClusterController.GetCluster
Used as field type in: , ,
string project_id = 1
Required. The Google Cloud Platform project ID that the cluster belongs to.
string cluster_name = 2
Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.
optional config = 3
Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.
map<string, string> labels = 8
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.
optional status = 4
Output-only. Cluster status.
repeated status_history = 7
Output-only. The previous cluster status.
string cluster_uuid = 6
Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.
optional metrics = 9
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.
message
clusters.proto:108The cluster config.
Used in:
string config_bucket = 1
Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. 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, and then it will create and manage this project-level, per-location bucket for you.
optional gce_cluster_config = 8
Required. The shared Google Compute Engine config settings for all instances in a cluster.
optional master_config = 9
Optional. The Google Compute Engine config settings for the master instance in a cluster.
optional worker_config = 10
Optional. The Google Compute Engine config settings for worker instances in a cluster.
optional secondary_worker_config = 12
Optional. The Google Compute Engine config settings for additional worker instances in a cluster.
optional software_config = 13
Optional. The config settings for software inside the cluster.
repeated initialization_actions = 11
Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's `role` metadata to run an executable on a master or worker node, as shown below using `curl` (you can also use `wget`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ "${ROLE}" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi
message
clusters.proto:418Contains 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.
Used in:
map<string, int64> hdfs_metrics = 1
The HDFS metrics.
map<string, int64> yarn_metrics = 2
The YARN metrics.
message
operations.proto:61Metadata describing the operation.
string cluster_name = 7
Output-only. Name of the cluster for the operation.
string cluster_uuid = 8
Output-only. Cluster UUID for the operation.
optional status = 9
Output-only. Current operation status.
repeated status_history = 10
Output-only. The previous operation status.
string operation_type = 11
Output-only. The operation type.
string description = 12
Output-only. Short description of operation.
map<string, string> labels = 13
Output-only. Labels associated with the operation
repeated string warnings = 14
Output-only. Errors encountered during operation execution.
message
operations.proto:31The status of the operation.
Used in:
ClusterOperationStatus.State state = 1
Output-only. A message containing the operation state.
string inner_state = 2
Output-only. A message containing the detailed operation state.
string details = 3
Output-only.A message containing any operation metadata details.
optional state_start_time = 4
Output-only. The time this state was entered.
The operation state.
Used in:
UNKNOWN = 0
Unused.
PENDING = 1
The operation has been created.
RUNNING = 2
The operation is running.
DONE = 3
The operation is done; either cancelled or completed.
message
clusters.proto:333The status of a cluster and its instances.
Used in:
ClusterStatus.State state = 1
Output-only. The cluster's state.
string detail = 2
Output-only. Optional details of cluster's state.
optional state_start_time = 3
Output-only. Time when this state was entered.
ClusterStatus.Substate substate = 4
Output-only. Additional state information that includes status reported by the agent.
The cluster state.
Used in:
UNKNOWN = 0
The cluster state is unknown.
CREATING = 1
The cluster is being created and set up. It is not ready for use.
RUNNING = 2
The cluster is currently running and healthy. It is ready for use.
ERROR = 3
The cluster encountered an error. It is not ready for use.
DELETING = 4
The cluster is being deleted. It cannot be used.
UPDATING = 5
The cluster is being updated. It continues to accept and process jobs.
Used in:
UNSPECIFIED = 0
UNHEALTHY = 1
The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted). Applies to RUNNING state.
STALE_STATUS = 2
The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent). Applies to RUNNING state.
message
clusters.proto:592The location of diagnostic output.
string output_uri = 1
Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.
message
clusters.proto:306Specifies the config of disk options for a group of VM instances.
Used in:
int32 boot_disk_size_gb = 1
Optional. Size in GB of the boot disk (default is 500GB).
int32 num_local_ssds = 2
Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and [HDFS](https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.
message
clusters.proto:152Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.
Used in:
string zone_uri = 1
Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Cloud 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: * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]` * `projects/[project_id]/zones/[zone]` * `us-central1-f`
string network_uri = 2
Optional. 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 [Using Subnetworks](/compute/docs/subnetworks) for more information). A full URL, partial URI, or short name are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default` * `projects/[project_id]/regions/global/default` * `default`
string subnetwork_uri = 6
Optional. The Google 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: * `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0` * `projects/[project_id]/regions/us-east1/sub0` * `sub0`
bool internal_ip_only = 7
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.
string service_account = 8
Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles: * roles/logging.logWriter * roles/storage.objectAdmin (see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: `[account_id]@[project_id].iam.gserviceaccount.com`
repeated string service_account_scopes = 3
Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control
repeated string tags = 4
The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
map<string, string> metadata = 5
The Google 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)).
message
jobs.proto:111A Cloud Dataproc job for running [Apache Hadoop MapReduce](https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on [Apache Hadoop YARN](https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).
Used in:
oneof driver
Required. Indicates the location of the driver's main class. Specify either the jar file that contains the main class or the main class name. To specify both, add the jar file to `jar_file_uris`, and then specify the main class name in this property.
string main_jar_file_uri = 1
The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'
string main_class = 2
The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in `jar_file_uris`.
repeated string args = 3
Optional. The arguments to pass to the driver. Do not include arguments, such as `-libjars` or `-Dfoo=bar`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
repeated string jar_file_uris = 4
Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.
repeated string file_uris = 5
Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.
repeated string archive_uris = 6
Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.
map<string, string> properties = 7
Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.
optional logging_config = 8
Optional. The runtime log config for job execution.
message
jobs.proto:263A Cloud Dataproc job for running [Apache Hive](https://hive.apache.org/) queries on YARN.
Used in:
oneof queries
Required. The sequence of Hive queries to execute, specified as either an HCFS file URI or a list of queries.
string query_file_uri = 1
The HCFS URI of the script that contains Hive queries.
query_list = 2
A list of queries.
bool continue_on_failure = 3
Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
map<string, string> script_variables = 4
Optional. Mapping of query variable names to values (equivalent to the Hive command: `SET name="value";`).
map<string, string> properties = 5
Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.
repeated string jar_file_uris = 6
Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.
message
clusters.proto:236Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.
Used in:
int32 num_instances = 1
Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.
repeated string instance_names = 2
Optional. The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).
string image_uri = 3
Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.
string machine_type_uri = 4
Optional. The Google Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2` * `projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2` * `n1-standard-2`
optional disk_config = 5
Optional. Disk option config settings.
bool is_preemptible = 6
Optional. Specifies that this instance group contains preemptible instances.
optional managed_group_config = 7
Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
repeated accelerators = 8
Optional. The Google Compute Engine accelerator configuration for these instances. **Beta Feature**: This feature is still under development. It may be changed before final release.
message
jobs.proto:516A Cloud Dataproc job resource.
Used as response type in: JobController.CancelJob, JobController.GetJob, JobController.SubmitJob, JobController.UpdateJob
Used as field type in: , ,
optional reference = 1
Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a <code>job_id</code>.
optional placement = 2
Required. Job information, including how, when, and where to run the job.
oneof type_job
Required. The application/framework-specific portion of the job.
hadoop_job = 3
Job is a Hadoop job.
spark_job = 4
Job is a Spark job.
pyspark_job = 5
Job is a Pyspark job.
hive_job = 6
Job is a Hive job.
pig_job = 7
Job is a Pig job.
spark_sql_job = 12
Job is a SparkSql job.
optional status = 8
Output-only. The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> fields.
repeated status_history = 13
Output-only. The previous job status.
repeated yarn_applications = 9
Output-only. The collection of YARN applications spun up by this job. **Beta** Feature: This report is available for testing purposes only. It may be changed before final release.
string driver_output_resource_uri = 17
Output-only. A URI pointing to the location of the stdout of the job's driver program.
string driver_control_files_uri = 15
Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as `driver_output_uri`.
map<string, string> labels = 18
Optional. The labels to associate with this job. 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 job.
optional scheduling = 20
Optional. Job scheduling configuration.
message
jobs.proto:361Cloud Dataproc job config.
Used in:
string cluster_name = 1
Required. The name of the cluster where the job will be submitted.
string cluster_uuid = 2
Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.
message
jobs.proto:449Encapsulates the full scoping used to reference a job.
Used in:
string project_id = 1
Required. The ID of the Google Cloud Platform project that the job belongs to.
string job_id = 2
Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.
message
jobs.proto:587Job scheduling options. **Beta Feature**: These options are available for testing purposes only. They may be changed before final release.
Used in:
int32 max_failures_per_hour = 1
Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed. A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window. Maximum value is 10.
message
jobs.proto:371Cloud Dataproc job status.
Used in:
JobStatus.State state = 1
Output-only. A state message specifying the overall job state.
string details = 2
Output-only. Optional job state details, such as an error description if the state is <code>ERROR</code>.
optional state_start_time = 6
Output-only. The time when this state was entered.
JobStatus.Substate substate = 7
Output-only. Additional state information, which includes status reported by the agent.
The job state.
Used in:
STATE_UNSPECIFIED = 0
The job state is unknown.
PENDING = 1
The job is pending; it has been submitted, but is not yet running.
SETUP_DONE = 8
Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.
RUNNING = 2
The job is running on the cluster.
CANCEL_PENDING = 3
A CancelJob request has been received, but is pending.
CANCEL_STARTED = 7
Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.
CANCELLED = 4
The job cancellation was successful.
DONE = 5
The job has completed successfully.
ERROR = 6
The job has completed, but encountered an error.
ATTEMPT_FAILURE = 9
Job attempt has failed. The detail field contains failure details for this attempt. Applies to restartable jobs only.
Used in:
UNSPECIFIED = 0
SUBMITTED = 1
The Job is submitted to the agent. Applies to RUNNING state.
QUEUED = 2
The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the "details" field for the reason for the delay. Applies to RUNNING state.
STALE_STATUS = 3
The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail. Applies to RUNNING state.
A matcher that specifies categories of job states.
Used in:
ALL = 0
Match all jobs, regardless of state.
ACTIVE = 1
Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.
NON_ACTIVE = 2
Only match jobs in terminal states: CANCELLED, DONE, or ERROR.
message
jobs.proto:68The runtime logging config of the job.
Used in: , , , ,
map<string, LoggingConfig.Level> driver_log_levels = 2
The per-package log levels for the driver. This may include "root" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'
The Log4j level for job execution. When running an [Apache Hive](http://hive.apache.org/) job, Cloud Dataproc configures the Hive client to an equivalent verbosity level.
Used in:
LEVEL_UNSPECIFIED = 0
Level is unspecified. Use default level for log4j.
ALL = 1
Use ALL level for log4j.
TRACE = 2
Use TRACE level for log4j.
DEBUG = 3
Use DEBUG level for log4j.
INFO = 4
Use INFO level for log4j.
WARN = 5
Use WARN level for log4j.
ERROR = 6
Use ERROR level for log4j.
FATAL = 7
Use FATAL level for log4j.
OFF = 8
Turn off log4j.
message
clusters.proto:279Specifies the resources used to actively manage an instance group.
Used in:
string instance_template_name = 1
Output-only. The name of the Instance Template used for the Managed Instance Group.
string instance_group_manager_name = 2
Output-only. The name of the Instance Group Manager for this group.
message
clusters.proto:321Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Used in:
string executable_file = 1
Required. Google Cloud Storage URI of executable file.
optional execution_timeout = 2
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.
message
jobs.proto:326A Cloud Dataproc job for running [Apache Pig](https://pig.apache.org/) queries on YARN.
Used in:
oneof queries
Required. The sequence of Pig queries to execute, specified as an HCFS file URI or a list of queries.
string query_file_uri = 1
The HCFS URI of the script that contains the Pig queries.
query_list = 2
A list of queries.
bool continue_on_failure = 3
Optional. Whether to continue executing queries if a query fails. The default value is `false`. Setting to `true` can be useful when executing independent parallel queries.
map<string, string> script_variables = 4
Optional. Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).
map<string, string> properties = 5
Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.
repeated string jar_file_uris = 6
Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.
optional logging_config = 7
Optional. The runtime log config for job execution.
message
jobs.proto:206A Cloud Dataproc job for running [Apache PySpark](https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.
Used in:
string main_python_file_uri = 1
Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.
repeated string args = 2
Optional. The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
repeated string python_file_uris = 3
Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.
repeated string jar_file_uris = 4
Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.
repeated string file_uris = 5
Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.
repeated string archive_uris = 6
Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.
map<string, string> properties = 7
Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
optional logging_config = 8
Optional. The runtime log config for job execution.
message
jobs.proto:243A list of queries to run on a cluster.
Used in: , ,
repeated string queries = 1
Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob: "hiveJob": { "queryList": { "queries": [ "query1", "query2", "query3;query4", ] } }
message
clusters.proto:387Specifies the selection and config of software inside the cluster.
Used in:
string image_version = 1
Optional. The version of software inside the cluster. It must match the regular expression `[0-9]+\.[0-9]+`. If unspecified, it defaults to the latest version (see [Cloud Dataproc Versioning](/dataproc/versioning)).
map<string, string> properties = 2
Optional. The properties to set on daemon config files. Property keys are specified in `prefix:property` format, such as `core:fs.defaultFS`. The following are supported prefixes and their mappings: * capacity-scheduler: `capacity-scheduler.xml` * core: `core-site.xml` * distcp: `distcp-default.xml` * hdfs: `hdfs-site.xml` * hive: `hive-site.xml` * mapred: `mapred-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf` * yarn: `yarn-site.xml` For more information, see [Cluster properties](/dataproc/docs/concepts/cluster-properties).
message
jobs.proto:161A Cloud Dataproc job for running [Apache Spark](http://spark.apache.org/) applications on YARN.
Used in:
oneof driver
Required. The specification of the main method to call to drive the job. Specify either the jar file that contains the main class or the main class name. To pass both a main jar and a main class in that jar, add the jar to `CommonJob.jar_file_uris`, and then specify the main class name in `main_class`.
string main_jar_file_uri = 1
The HCFS URI of the jar file that contains the main class.
string main_class = 2
The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in `jar_file_uris`.
repeated string args = 3
Optional. The arguments to pass to the driver. Do not include arguments, such as `--conf`, that can be set as job properties, since a collision may occur that causes an incorrect job submission.
repeated string jar_file_uris = 4
Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.
repeated string file_uris = 5
Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.
repeated string archive_uris = 6
Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.
map<string, string> properties = 7
Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.
optional logging_config = 8
Optional. The runtime log config for job execution.
message
jobs.proto:297A Cloud Dataproc job for running [Apache Spark SQL](http://spark.apache.org/sql/) queries.
Used in:
oneof queries
Required. The sequence of Spark SQL queries to execute, specified as either an HCFS file URI or as a list of queries.
string query_file_uri = 1
The HCFS URI of the script that contains SQL queries.
query_list = 2
A list of queries.
map<string, string> script_variables = 3
Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET `name="value";`).
map<string, string> properties = 4
Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.
repeated string jar_file_uris = 56
Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.
optional logging_config = 6
Optional. The runtime log config for job execution.
message
jobs.proto:467A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>. **Beta Feature**: This report is available for testing purposes only. It may be changed before final release.
Used in:
string name = 1
Required. The application name.
YarnApplication.State state = 2
Required. The application state.
float progress = 3
Required. The numerical progress of the application, from 1 to 100.
string tracking_url = 4
Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.
The application state, corresponding to <code>YarnProtos.YarnApplicationStateProto</code>.
Used in:
STATE_UNSPECIFIED = 0
Status is unspecified.
NEW = 1
Status is NEW.
NEW_SAVING = 2
Status is NEW_SAVING.
SUBMITTED = 3
Status is SUBMITTED.
ACCEPTED = 4
Status is ACCEPTED.
RUNNING = 5
Status is RUNNING.
FINISHED = 6
Status is FINISHED.
FAILED = 7
Status is FAILED.
KILLED = 8
Status is KILLED.