package google.cloud.dataproc.v1
Get desktop application:
View/edit binary Protocol Buffers messages
The API interface for managing autoscaling policies in the Google Cloud Dataproc API.
Creates new autoscaling policy.
message
autoscaling_policies.proto:234A request to create an autoscaling policy.
string parent = 1
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.autoscalingPolicies.create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.autoscalingPolicies.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
optional policy = 2
The autoscaling policy to create.
Updates (replaces) autoscaling policy. Disabled check for update_mask, because all updates will be full replacements.
message
autoscaling_policies.proto:277A request to update an autoscaling policy.
optional policy = 1
Required. The updated autoscaling policy.
Retrieves autoscaling policy.
message
autoscaling_policies.proto:257A request to fetch an autoscaling policy.
string name = 1
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}` * For `projects.locations.autoscalingPolicies.get`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
Lists autoscaling policies in the project.
message
autoscaling_policies.proto:305A request to list autoscaling policies in a project.
string parent = 1
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.autoscalingPolicies.list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.autoscalingPolicies.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
int32 page_size = 2
Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.
string page_token = 3
Optional. The page token, returned by a previous call, to request the next page of results.
message
autoscaling_policies.proto:333A response to a request to list autoscaling policies in a project.
repeated policies = 1
Output only. Autoscaling policies list.
string next_page_token = 2
Output only. This token is included in the response if there are more results to fetch.
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
message
autoscaling_policies.proto:285A request to delete an autoscaling policy. Autoscaling policies in use by one or more clusters will not be deleted.
string name = 1
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}` * For `projects.locations.autoscalingPolicies.delete`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
rpc CreateCluster (, )
clusters.proto:44Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
message
clusters.proto:628A 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.
string request_id = 4
Optional. A unique id used to identify the request. If the server receives two [CreateClusterRequest][google.cloud.dataproc.v1.CreateClusterRequest] requests with the same id, then the second request will be ignored and the first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
rpc UpdateCluster (, )
clusters.proto:59Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
message
clusters.proto:654A 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 graceful_decommission_timeout = 6
Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. Only supported on Dataproc image versions 1.2 and higher.
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> <tr> <td>config.autoscaling_config.policy_uri</td><td>Use, stop using, or change autoscaling policies</td> </tr> </tbody> </table>
string request_id = 7
Optional. A unique id used to identify the request. If the server receives two [UpdateClusterRequest][google.cloud.dataproc.v1.UpdateClusterRequest] requests with the same id, then the second request will be ignored and the first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
rpc DeleteCluster (, )
clusters.proto:73Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).
message
clusters.proto:746A 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.
string cluster_uuid = 4
Optional. Specifying the `cluster_uuid` means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.
string request_id = 5
Optional. A unique id used to identify the request. If the server receives two [DeleteClusterRequest][google.cloud.dataproc.v1.DeleteClusterRequest] requests with the same id, then the second request will be ignored and the first [google.longrunning.Operation][google.longrunning.Operation] created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
rpc GetCluster (, )
clusters.proto:85Gets the resource representation for a cluster in a project.
message
clusters.proto:776Request 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:93Lists all regions/{region}/clusters in a project.
message
clusters.proto:789A 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:826The 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 DiagnoseCluster (, )
clusters.proto:108Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be [ClusterOperationMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, [Operation.response][google.longrunning.Operation.response] contains [DiagnoseClusterResults](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).
message
clusters.proto:837A 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.
service JobController
jobs.proto:33The JobController provides methods to manage jobs.
rpc SubmitJob (, )
jobs.proto:38Submits a job to a cluster.
message
jobs.proto:640A 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.
string request_id = 4
Optional. A unique id used to identify the request. If the server receives two [SubmitJobRequest][google.cloud.dataproc.v1.SubmitJobRequest] requests with the same id, then the second request will be ignored and the first [Job][google.cloud.dataproc.v1.Job] created and stored in the backend is returned. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
rpc GetJob (, )
jobs.proto:47Gets the resource representation for a job in a project.
message
jobs.proto:666A 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:55Lists regions/{region}/jobs in a project.
message
jobs.proto:679A 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:759A 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 UpdateJob (, )
jobs.proto:64Updates a job in a project.
message
jobs.proto:735A 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.
rpc CancelJob (, )
jobs.proto:76Starts 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:770A 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:86Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.
message
jobs.proto:783A 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.
The API interface for managing Workflow Templates in the Cloud Dataproc API.
Creates new workflow template.
message
workflow_templates.proto:581A request to create a workflow template.
string parent = 1
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,create`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.create`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
optional template = 2
Required. The Dataproc workflow template to create.
Retrieves the latest workflow template. Can retrieve previously instantiated template by specifying optional version parameter.
message
workflow_templates.proto:604A request to fetch a workflow template.
string name = 1
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.get`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
int32 version = 2
Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved. If unspecified, retrieves the current version.
Instantiates a template and begins execution. The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished. The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted. The [Operation.metadata][google.longrunning.Operation.metadata] will be [WorkflowMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata). On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].
message
workflow_templates.proto:630A request to instantiate a workflow template.
string name = 1
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
int32 version = 2
Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version. This option cannot be used to instantiate a previous version of workflow template.
string request_id = 5
Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
map<string, string> parameters = 6
Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 100 characters.
Instantiates a template and begins execution. This method is equivalent to executing the sequence [CreateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.CreateWorkflowTemplate], [InstantiateWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.InstantiateWorkflowTemplate], [DeleteWorkflowTemplate][google.cloud.dataproc.v1.WorkflowTemplateService.DeleteWorkflowTemplate]. The returned Operation can be used to track execution of workflow by polling [operations.get][google.longrunning.Operations.GetOperation]. The Operation will complete when entire workflow is finished. The running workflow can be aborted via [operations.cancel][google.longrunning.Operations.CancelOperation]. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted. The [Operation.metadata][google.longrunning.Operation.metadata] will be [WorkflowMetadata](/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see [Using WorkflowMetadata](/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata). On successful completion, [Operation.response][google.longrunning.Operation.response] will be [Empty][google.protobuf.Empty].
message
workflow_templates.proto:673A request to instantiate an inline workflow template.
string parent = 1
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,instantiateinline`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.instantiateinline`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
optional template = 2
Required. The workflow template to instantiate.
string request_id = 3
Optional. A tag that prevents multiple concurrent workflow instances with the same tag from running. This mitigates risk of concurrent instances started due to retries. It is recommended to always set this value to a [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier). The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
message
workflow_templates.proto:707A request to update a workflow template.
optional template = 1
Required. The updated workflow template. The `template.version` field must match the current version.
Lists workflows that match the specified filter in the request.
message
workflow_templates.proto:720A request to list workflow templates in a project.
string parent = 1
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates,list`, the resource name of the region has the following format: `projects/{project_id}/regions/{region}` * For `projects.locations.workflowTemplates.list`, the resource name of the location has the following format: `projects/{project_id}/locations/{location}`
int32 page_size = 2
Optional. The maximum 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.
message
workflow_templates.proto:747A response to a request to list workflow templates in a project.
repeated templates = 1
Output only. WorkflowTemplates list.
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 <code>ListWorkflowTemplatesRequest</code>.
Deletes a workflow template. It does not cancel in-progress workflows.
message
workflow_templates.proto:760A request to delete a workflow template. Currently started workflows will remain running.
string name = 1
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates.delete`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates.instantiate`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
int32 version = 2
Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.
message
clusters.proto:391Specifies the type and number of accelerator cards attached to the instances of an instance. 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 [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` **Auto Zone Exception**: If you are using the Cloud Dataproc [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, `nvidia-tesla-k80`.
int32 accelerator_count = 2
The number of the accelerator cards of this type exposed to this instance.
message
clusters.proto:220Autoscaling Policy config associated with the cluster.
Used in:
string policy_uri = 1
Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples: * `https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` * `projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]` Note that the policy must be in the same project and Cloud Dataproc region.
message
autoscaling_policies.proto:98Describes an autoscaling policy for Dataproc cluster autoscaler.
Used as response type in: AutoscalingPolicyService.CreateAutoscalingPolicy, AutoscalingPolicyService.GetAutoscalingPolicy, AutoscalingPolicyService.UpdateAutoscalingPolicy
Used as field type in: , ,
string id = 1
Required. The policy id. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
string name = 2
Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.autoscalingPolicies`, the resource name of the policy has the following format: `projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id}` * For `projects.locations.autoscalingPolicies`, the resource name of the policy has the following format: `projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}`
oneof algorithm
Autoscaling algorithm for policy.
basic_algorithm = 3
optional worker_config = 4
Required. Describes how the autoscaler will operate for primary workers.
optional secondary_worker_config = 5
Optional. Describes how the autoscaler will operate for secondary workers.
message
autoscaling_policies.proto:137Basic algorithm for autoscaling.
Used in:
optional yarn_config = 1
Required. YARN autoscaling configuration.
optional cooldown_period = 2
Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed. Bounds: [2m, 1d]. Default: 2m.
message
autoscaling_policies.proto:149Basic autoscaling configurations for YARN.
Used in:
optional graceful_decommission_timeout = 5
Required. Timeout for YARN graceful decommissioning of Node Managers. Specifies the duration to wait for jobs to complete before forcefully removing workers (and potentially interrupting jobs). Only applicable to downscaling operations. Bounds: [0s, 1d].
double scale_up_factor = 1
Required. Fraction of average pending memory in the last cooldown period for which to add workers. A scale-up factor of 1.0 will result in scaling up so that there is no pending memory remaining after the update (more aggressive scaling). A scale-up factor closer to 0 will result in a smaller magnitude of scaling up (less aggressive scaling). Bounds: [0.0, 1.0].
double scale_down_factor = 2
Required. Fraction of average pending memory in the last cooldown period for which to remove workers. A scale-down factor of 1 will result in scaling down so that there is no available memory remaining after the update (more aggressive scaling). A scale-down factor of 0 disables removing workers, which can be beneficial for autoscaling a single job. Bounds: [0.0, 1.0].
double scale_up_min_worker_fraction = 3
Optional. Minimum scale-up threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2-worker scale-up for the cluster to scale. A threshold of 0 means the autoscaler will scale up on any recommended change. Bounds: [0.0, 1.0]. Default: 0.0.
double scale_down_min_worker_fraction = 4
Optional. Minimum scale-down threshold as a fraction of total cluster size before scaling occurs. For example, in a 20-worker cluster, a threshold of 0.1 means the autoscaler must recommend at least a 2 worker scale-down for the cluster to scale. A threshold of 0 means the autoscaler will scale down on any recommended change. Bounds: [0.0, 1.0]. Default: 0.0.
message
clusters.proto:123Describes the identifying information, config, and status of a cluster of 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:162The cluster config.
Used in: ,
string config_bucket = 1
Optional. A Google Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see [Cloud Dataproc staging bucket](/dataproc/docs/concepts/configuring-clusters/staging-bucket)).
optional gce_cluster_config = 8
Optional. The shared Compute Engine config settings for all instances in a cluster.
optional master_config = 9
Optional. The Compute Engine config settings for the master instance in a cluster.
optional worker_config = 10
Optional. The Compute Engine config settings for worker instances in a cluster.
optional secondary_worker_config = 12
Optional. The 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
optional encryption_config = 15
Optional. Encryption settings for the cluster.
optional autoscaling_config = 18
Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset.
optional security_config = 16
Optional. Security settings for the cluster.
message
clusters.proto:619Contains 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
workflow_templates.proto:523The cluster operation triggered by a workflow.
Used in:
string operation_id = 1
Output only. The id of the cluster operation.
string error = 2
Output only. Error, if operation failed.
bool done = 3
Output only. Indicates the operation is done.
message
operations.proto:60Metadata 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:30The 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
workflow_templates.proto:293A selector that chooses target cluster for jobs based on metadata.
Used in:
string zone = 1
Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster. If unspecified, the zone of the first cluster matching the selector is used.
map<string, string> cluster_labels = 2
Required. The cluster labels. Cluster must have all labels to match.
message
clusters.proto:447The status of a cluster and its instances.
Used in:
ClusterStatus.State state = 1
Output only. The cluster's state.
string detail = 2
Optional. Output only. 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.
The cluster substate.
Used in:
UNSPECIFIED = 0
The cluster substate is unknown.
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.
Cluster components that can be activated.
Used in:
COMPONENT_UNSPECIFIED = 0
Unspecified component.
ANACONDA = 5
The Anaconda python distribution.
HIVE_WEBHCAT = 3
The Hive Web HCatalog (the REST service for accessing HCatalog).
JUPYTER = 1
The Jupyter Notebook.
ZEPPELIN = 4
The Zeppelin notebook.
message
clusters.proto:850The location of diagnostic output.
string output_uri = 1
Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.
message
clusters.proto:415Specifies the config of disk options for a group of VM instances.
Used in:
string boot_disk_type = 3
Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-ssd" (Persistent Disk Solid State Drive) or "pd-standard" (Persistent Disk Hard Disk Drive).
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:234Encryption settings for the cluster.
Used in:
string gce_pd_kms_key_name = 1
Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.
message
clusters.proto:242Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.
Used in:
string zone_uri = 1
Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global 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 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 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/subnetworks/sub0` * `projects/[project_id]/regions/us-east1/subnetworks/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 Compute Engine service account. Custom service accounts need permissions equivalent to the following 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 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 Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).
map<string, string> metadata = 5
The Compute Engine metadata entries to add to all instances (see [Project and instance metadata](https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).
message
jobs.proto:140A 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:294A 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
autoscaling_policies.proto:197Configuration for the size bounds of an instance group, including its proportional size to other groups.
Used in:
int32 min_instances = 1
Optional. Minimum number of instances for this group. Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0.
int32 max_instances = 2
Required. Maximum number of instances for this group. Required for primary workers. Note that by default, clusters will not use secondary workers. Required for secondary workers if the minimum secondary instances is set. Primary workers - Bounds: [min_instances, ). Secondary workers - Bounds: [min_instances, ). Default: 0.
int32 weight = 3
Optional. Weight for the instance group, which is used to determine the fraction of total workers in the cluster from this instance group. For example, if primary workers have weight 2, and secondary workers have weight 1, the cluster will have approximately 2 primary workers for each secondary worker. The cluster may not reach the specified balance if constrained by min/max bounds or other autoscaling settings. For example, if `max_instances` for secondary workers is 0, then only primary workers will be added. The cluster can also be out of balance when created. If weight is not set on any instance group, the cluster will default to equal weight for all groups: the cluster will attempt to maintain an equal number of workers in each group within the configured size bounds for each group. If weight is set for one group only, the cluster will default to zero weight on the unset group. For example if weight is set only on primary workers, the cluster will use primary workers only and no secondary workers.
message
clusters.proto:328Optional. The config settings for 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
Output only. The list of instance names. Cloud Dataproc derives the names from `cluster_name`, `num_instances`, and the instance group.
string image_uri = 3
Optional. The Compute Engine image resource used for cluster instances. It can be specified or may be inferred from `SoftwareConfig.image_version`.
string machine_type_uri = 4
Optional. The 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` **Auto Zone Exception**: If you are using the Cloud Dataproc [Auto Zone Placement](/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the machine type resource, for example, `n1-standard-2`.
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 Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.
repeated accelerators = 8
Optional. The Compute Engine accelerator configuration for these instances.
string min_cpu_platform = 9
Optional. Specifies the minimum cpu platform for the Instance Group. See [Cloud Dataproc→Minimum CPU Platform] (/dataproc/docs/concepts/compute/dataproc-min-cpu).
message
jobs.proto:553A 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.
string job_uuid = 22
Output only. A UUID that uniquely identifies a job within the project over time. This is in contrast to a user-settable reference.job_id that may be reused over time.
message
jobs.proto:392Cloud 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:485Encapsulates 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 ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters. If not specified by the caller, the job ID will be provided by the server.
message
jobs.proto:627Job scheduling options.
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:402Cloud Dataproc job status.
Used in:
JobStatus.State state = 1
Output only. A state message specifying the overall job state.
string details = 2
Optional. Output only. 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.
The job substate.
Used in:
UNSPECIFIED = 0
The job substate is unknown.
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.
message
clusters.proto:512Specifies Kerberos related configuration.
Used in:
bool enable_kerberos = 1
Optional. Flag to indicate whether to Kerberize the cluster.
string root_principal_password_uri = 2
Required. The Cloud Storage URI of a KMS encrypted file containing the root principal password.
string kms_key_uri = 3
Required. The uri of the KMS key used to encrypt various sensitive files.
string keystore_uri = 4
Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
string truststore_uri = 5
Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate.
string keystore_password_uri = 6
Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided keystore. For the self-signed certificate, this password is generated by Dataproc.
string key_password_uri = 7
Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided key. For the self-signed certificate, this password is generated by Dataproc.
string truststore_password_uri = 8
Optional. The Cloud Storage URI of a KMS encrypted file containing the password to the user provided truststore. For the self-signed certificate, this password is generated by Dataproc.
string cross_realm_trust_realm = 9
Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust.
string cross_realm_trust_kdc = 10
Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
string cross_realm_trust_admin_server = 11
Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship.
string cross_realm_trust_shared_password_uri = 12
Optional. The Cloud Storage URI of a KMS encrypted file containing the shared password between the on-cluster Kerberos realm and the remote trusted realm, in a cross realm trust relationship.
string kdc_db_key_uri = 13
Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database.
int32 tgt_lifetime_hours = 14
Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used.
string realm = 15
Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm.
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:95The 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
workflow_templates.proto:267Cluster that is managed by the workflow.
Used in:
string cluster_name = 2
Required. The cluster name prefix. A unique cluster name will be formed by appending a random suffix. The name must contain only lower-case letters (a-z), numbers (0-9), and hyphens (-). Must begin with a letter. Cannot begin or end with hyphen. Must consist of between 2 and 35 characters.
optional config = 3
Required. The cluster configuration.
map<string, string> labels = 4
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}][\p{Ll}\p{Lo}\p{N}_-]{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 32 labels can be associated with a given cluster.
message
clusters.proto:380Specifies 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:435Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Used in:
string executable_file = 1
Required. 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
workflow_templates.proto:307A job executed by the workflow.
Used in:
string step_id = 1
Required. The step id. The id must be unique among all jobs within the template. The step id is used as prefix for job id, as job `goog-dataproc-workflow-step-id` label, and in [prerequisiteStepIds][google.cloud.dataproc.v1.OrderedJob.prerequisite_step_ids] field from other steps. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). Cannot begin or end with underscore or hyphen. Must consist of between 3 and 50 characters.
oneof job_type
Required. The job definition.
hadoop_job = 2
Job is a Hadoop job.
spark_job = 3
Job is a Spark job.
pyspark_job = 4
Job is a Pyspark job.
hive_job = 5
Job is a Hive job.
pig_job = 6
Job is a Pig job.
spark_sql_job = 7
Job is a SparkSql job.
map<string, string> labels = 8
Optional. The labels to associate with this job. Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}][\p{Ll}\p{Lo}\p{N}_-]{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [\p{Ll}\p{Lo}\p{N}_-]{0,63} No more than 32 labels can be associated with a given job.
optional scheduling = 9
Optional. Job scheduling configuration.
repeated string prerequisite_step_ids = 10
Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.
message
workflow_templates.proto:436Configuration for parameter validation.
Used in:
oneof validation_type
Required. The type of validation to be performed.
regex = 1
Validation based on regular expressions.
values = 2
Validation based on a list of allowed values.
message
jobs.proto:357A 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:237A 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:274A 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
workflow_templates.proto:448Validation based on regular expressions.
Used in:
repeated string regexes = 1
Required. RE2 regular expressions used to validate the parameter's value. The value must match the regex in its entirety (substring matches are not sufficient).
message
clusters.proto:506Security related configuration, including Kerberos.
Used in:
optional kerberos_config = 1
Kerberos related configuration.
message
clusters.proto:581Specifies 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 be one of the supported [Cloud Dataproc Versions](/dataproc/docs/concepts/versioning/dataproc-versions#supported_cloud_dataproc_versions), such as "1.2" (including a subminor version, such as "1.2.29"), or the ["preview" version](/dataproc/docs/concepts/versioning/dataproc-versions#other_versions). If unspecified, it defaults to the latest Debian version.
map<string, string> properties = 2
Optional. The properties to set on daemon config files. Property keys are specified in `prefix:property` format, for example `core:hadoop.tmp.dir`. The following are supported prefixes and their mappings: * 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).
repeated Component optional_components = 3
Optional. The set of components to activate on the cluster.
message
jobs.proto:190A 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:328A 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
workflow_templates.proto:371A configurable parameter that replaces one or more fields in the template. Parameterizable fields: - Labels - File uris - Job properties - Job arguments - Script variables - Main class (in HadoopJob and SparkJob) - Zone (in ClusterSelector)
Used in:
string name = 1
Required. Parameter name. The parameter name is used as the key, and paired with the parameter value, which are passed to the template when the template is instantiated. The name must contain only capital letters (A-Z), numbers (0-9), and underscores (_), and must not start with a number. The maximum length is 40 characters.
repeated string fields = 2
Required. Paths to all fields that the parameter replaces. A field is allowed to appear in at most one parameter's list of field paths. A field path is similar in syntax to a [google.protobuf.FieldMask][google.protobuf.FieldMask]. For example, a field path that references the zone field of a workflow template's cluster selector would be specified as `placement.clusterSelector.zone`. Also, field paths can reference fields using the following syntax: * Values in maps can be referenced by key: * labels['key'] * placement.clusterSelector.clusterLabels['key'] * placement.managedCluster.labels['key'] * placement.clusterSelector.clusterLabels['key'] * jobs['step-id'].labels['key'] * Jobs in the jobs list can be referenced by step-id: * jobs['step-id'].hadoopJob.mainJarFileUri * jobs['step-id'].hiveJob.queryFileUri * jobs['step-id'].pySparkJob.mainPythonFileUri * jobs['step-id'].hadoopJob.jarFileUris[0] * jobs['step-id'].hadoopJob.archiveUris[0] * jobs['step-id'].hadoopJob.fileUris[0] * jobs['step-id'].pySparkJob.pythonFileUris[0] * Items in repeated fields can be referenced by a zero-based index: * jobs['step-id'].sparkJob.args[0] * Other examples: * jobs['step-id'].hadoopJob.properties['key'] * jobs['step-id'].hadoopJob.args[0] * jobs['step-id'].hiveJob.scriptVariables['key'] * jobs['step-id'].hadoopJob.mainJarFileUri * placement.clusterSelector.zone It may not be possible to parameterize maps and repeated fields in their entirety since only individual map values and individual items in repeated fields can be referenced. For example, the following field paths are invalid: - placement.clusterSelector.clusterLabels - jobs['step-id'].sparkJob.args
string description = 3
Optional. Brief description of the parameter. Must not exceed 1024 characters.
optional validation = 4
Optional. Validation rules to be applied to this parameter's value.
message
workflow_templates.proto:456Validation based on a list of allowed values.
Used in:
repeated string values = 1
Required. List of allowed values for the parameter.
message
workflow_templates.proto:535The workflow graph.
Used in:
repeated nodes = 1
Output only. The workflow nodes.
message
workflow_templates.proto:462A Cloud Dataproc workflow template resource.
string template = 1
Output only. The resource name of the workflow template as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
int32 version = 2
Output only. The version of template at the time of workflow instantiation.
optional create_cluster = 3
Output only. The create cluster operation metadata.
optional graph = 4
Output only. The workflow graph.
optional delete_cluster = 5
Output only. The delete cluster operation metadata.
WorkflowMetadata.State state = 6
Output only. The workflow state.
string cluster_name = 7
Output only. The name of the target cluster.
map<string, string> parameters = 8
Map from parameter names to values that were used for those parameters.
optional start_time = 9
Output only. Workflow start time.
optional end_time = 10
Output only. Workflow end time.
string cluster_uuid = 11
Output only. The UUID of target cluster.
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
workflow_templates.proto:541The workflow node.
Used in:
string step_id = 1
Output only. The name of the node.
repeated string prerequisite_step_ids = 2
Output only. Node's prerequisite nodes.
string job_id = 3
Output only. The job id; populated after the node enters RUNNING state.
WorkflowNode.NodeState state = 5
Output only. The node state.
string error = 6
Output only. The error detail.
The workflow node state.
Used in:
NODE_STATE_UNSPECIFIED = 0
State is unspecified.
BLOCKED = 1
The node is awaiting prerequisite node to finish.
RUNNABLE = 2
The node is runnable but not running.
RUNNING = 3
The node is running.
COMPLETED = 4
The node completed successfully.
FAILED = 5
The node failed. A node can be marked FAILED because its ancestor or peer failed.
message
workflow_templates.proto:183A Cloud Dataproc workflow template resource.
Used as response type in: WorkflowTemplateService.CreateWorkflowTemplate, WorkflowTemplateService.GetWorkflowTemplate, WorkflowTemplateService.UpdateWorkflowTemplate
Used as field type in: , , ,
string id = 2
string name = 1
Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. * For `projects.regions.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/regions/{region}/workflowTemplates/{template_id}` * For `projects.locations.workflowTemplates`, the resource name of the template has the following format: `projects/{project_id}/locations/{location}/workflowTemplates/{template_id}`
int32 version = 3
Optional. Used to perform a consistent read-modify-write. This field should be left blank for a `CreateWorkflowTemplate` request. It is required for an `UpdateWorkflowTemplate` request, and must match the current server version. A typical update template flow would fetch the current template with a `GetWorkflowTemplate` request, which will return the current template with the `version` field filled in with the current server version. The user updates other fields in the template, then returns it as part of the `UpdateWorkflowTemplate` request.
optional create_time = 4
Output only. The time template was created.
optional update_time = 5
Output only. The time template was last updated.
map<string, string> labels = 6
Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance. 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 template.
optional placement = 7
Required. WorkflowTemplate scheduling information.
repeated jobs = 8
Required. The Directed Acyclic Graph of Jobs to submit.
repeated parameters = 9
Optional. emplate parameters whose values are substituted into the template. Values for parameters must be provided when the template is instantiated.
message
workflow_templates.proto:251Specifies workflow execution target. Either `managed_cluster` or `cluster_selector` is required.
Used in:
oneof placement
Required. Specifies where workflow executes; either on a managed cluster or an existing cluster chosen by labels.
managed_cluster = 1
A cluster that is managed by the workflow.
cluster_selector = 2
Optional. A selector that chooses target cluster for jobs based on metadata. The selector is evaluated at the time each job is submitted.
message
jobs.proto:504A 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.