Index
AutoscalingPolicyService
(interface)ClusterController
(interface)JobController
(interface)WorkflowTemplateService
(interface)AcceleratorConfig
(message)AutoscalingConfig
(message)AutoscalingPolicy
(message)BasicAutoscalingAlgorithm
(message)BasicYarnAutoscalingConfig
(message)CancelJobRequest
(message)Cluster
(message)ClusterConfig
(message)ClusterMetrics
(message)ClusterOperation
(message)ClusterOperationMetadata
(message)ClusterOperationStatus
(message)ClusterOperationStatus.State
(enum)ClusterSelector
(message)ClusterStatus
(message)ClusterStatus.State
(enum)ClusterStatus.Substate
(enum)Component
(enum)CreateAutoscalingPolicyRequest
(message)CreateClusterRequest
(message)CreateWorkflowTemplateRequest
(message)DeleteAutoscalingPolicyRequest
(message)DeleteClusterRequest
(message)DeleteJobRequest
(message)DeleteWorkflowTemplateRequest
(message)DiagnoseClusterRequest
(message)DiagnoseClusterResults
(message)DiskConfig
(message)EncryptionConfig
(message)EndpointConfig
(message)GceClusterConfig
(message)GceClusterConfig.PrivateIpv6GoogleAccess
(enum)GetAutoscalingPolicyRequest
(message)GetClusterRequest
(message)GetJobRequest
(message)GetWorkflowTemplateRequest
(message)GkeClusterConfig
(message)GkeClusterConfig.NamespacedGkeDeploymentTarget
(message)HadoopJob
(message)HiveJob
(message)InstanceGroupAutoscalingPolicyConfig
(message)InstanceGroupConfig
(message)InstanceGroupConfig.Preemptibility
(enum)InstantiateInlineWorkflowTemplateRequest
(message)InstantiateWorkflowTemplateRequest
(message)Job
(message)JobMetadata
(message)JobPlacement
(message)JobReference
(message)JobScheduling
(message)JobStatus
(message)JobStatus.State
(enum)JobStatus.Substate
(enum)KerberosConfig
(message)LifecycleConfig
(message)ListAutoscalingPoliciesRequest
(message)ListAutoscalingPoliciesResponse
(message)ListClustersRequest
(message)ListClustersResponse
(message)ListJobsRequest
(message)ListJobsRequest.JobStateMatcher
(enum)ListJobsResponse
(message)ListWorkflowTemplatesRequest
(message)ListWorkflowTemplatesResponse
(message)LoggingConfig
(message)LoggingConfig.Level
(enum)ManagedCluster
(message)ManagedGroupConfig
(message)MetastoreConfig
(message)NodeGroupAffinity
(message)NodeInitializationAction
(message)OrderedJob
(message)ParameterValidation
(message)PigJob
(message)PrestoJob
(message)PySparkJob
(message)QueryList
(message)RegexValidation
(message)ReservationAffinity
(message)ReservationAffinity.Type
(enum)SecurityConfig
(message)ShieldedInstanceConfig
(message)SoftwareConfig
(message)SparkJob
(message)SparkRJob
(message)SparkSqlJob
(message)StartClusterRequest
(message)StopClusterRequest
(message)SubmitJobRequest
(message)TemplateParameter
(message)UpdateAutoscalingPolicyRequest
(message)UpdateClusterRequest
(message)UpdateJobRequest
(message)UpdateWorkflowTemplateRequest
(message)ValueValidation
(message)WorkflowGraph
(message)WorkflowMetadata
(message)WorkflowMetadata.State
(enum)WorkflowNode
(message)WorkflowNode.NodeState
(enum)WorkflowTemplate
(message)WorkflowTemplatePlacement
(message)YarnApplication
(message)YarnApplication.State
(enum)
AutoscalingPolicyService
The API interface for managing autoscaling policies in the Cloud Dataproc API.
CreateAutoscalingPolicy | |
---|---|
Creates new autoscaling policy.
|
DeleteAutoscalingPolicy | |
---|---|
Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.
|
GetAutoscalingPolicy | |
---|---|
Retrieves autoscaling policy.
|
ListAutoscalingPolicies | |
---|---|
Lists autoscaling policies in the project.
|
UpdateAutoscalingPolicy | |
---|---|
Updates (replaces) autoscaling policy. Disabled check for update_mask, because all updates will be full replacements.
|
ClusterController
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
CreateCluster | |
---|---|
Creates a cluster in a project. The returned
|
DeleteCluster | |
---|---|
Deletes a cluster in a project. The returned
|
DiagnoseCluster | |
---|---|
Gets cluster diagnostic information. The returned
|
GetCluster | |
---|---|
Gets the resource representation for a cluster in a project.
|
ListClusters | |
---|---|
Lists all regions/{region}/clusters in a project alphabetically.
|
StartCluster | |
---|---|
Starts a cluster in a project.
|
StopCluster | |
---|---|
Stops a cluster in a project.
|
UpdateCluster | |
---|---|
Updates a cluster in a project. The returned
|
JobController
The JobController provides methods to manage jobs.
CancelJob | |
---|---|
Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.
|
DeleteJob | |
---|---|
Deletes the job from the project. If the job is active, the delete fails, and the response returns
|
GetJob | |
---|---|
Gets the resource representation for a job in a project.
|
ListJobs | |
---|---|
Lists regions/{region}/jobs in a project.
|
SubmitJob | |
---|---|
Submits a job to a cluster.
|
SubmitJobAsOperation | |
---|---|
Submits job to a cluster.
|
UpdateJob | |
---|---|
Updates a job in a project.
|
WorkflowTemplateService
The API interface for managing Workflow Templates in the Dataproc API.
CreateWorkflowTemplate | |
---|---|
Creates new workflow template.
|
DeleteWorkflowTemplate | |
---|---|
Deletes a workflow template. It does not cancel in-progress workflows.
|
GetWorkflowTemplate | |
---|---|
Retrieves the latest workflow template. Can retrieve previously instantiated template by specifying optional version parameter.
|
InstantiateInlineWorkflowTemplate | |
---|---|
Instantiates a template and begins execution. This method is equivalent to executing the sequence The returned Operation can be used to track execution of workflow by polling The running workflow can be aborted via The On successful completion,
|
InstantiateWorkflowTemplate | |
---|---|
Instantiates a template and begins execution. The returned Operation can be used to track execution of workflow by polling The running workflow can be aborted via The On successful completion,
|
ListWorkflowTemplates | |
---|---|
Lists workflows that match the specified filter in the request.
|
UpdateWorkflowTemplate | |
---|---|
Updates (replaces) workflow template. The updated template must contain version that matches the current server version.
|
AcceleratorConfig
Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).
Fields | |
---|---|
accelerator_type_uri |
Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes Examples * Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, |
accelerator_count |
The number of the accelerator cards of this type exposed to this instance. |
AutoscalingConfig
Autoscaling Policy config associated with the cluster.
Fields | |
---|---|
policy_uri |
Optional. The autoscaling policy used by the cluster. Only resource names including projectid and location (region) are valid. Examples:
Note that the policy must be in the same project and Dataproc region. |
AutoscalingPolicy
Describes an autoscaling policy for Dataproc cluster autoscaler.
Fields | |
---|---|
id |
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. |
name |
Output only. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
|
worker_config |
Required. Describes how the autoscaler will operate for primary workers. |
secondary_worker_config |
Optional. Describes how the autoscaler will operate for secondary workers. |
basic_algorithm |
BasicAutoscalingAlgorithm
Basic algorithm for autoscaling.
Fields | |
---|---|
yarn_config |
Required. YARN autoscaling configuration. |
cooldown_period |
Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed. Bounds: [2m, 1d]. Default: 2m. |
BasicYarnAutoscalingConfig
Basic autoscaling configurations for YARN.
Fields | |
---|---|
graceful_decommission_timeout |
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]. |
scale_up_factor |
Required. Fraction of average YARN 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). See How autoscaling works for more information. Bounds: [0.0, 1.0]. |
scale_down_factor |
Required. Fraction of average YARN 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. See How autoscaling works for more information. Bounds: [0.0, 1.0]. |
scale_up_min_worker_fraction |
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. |
scale_down_min_worker_fraction |
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. |
CancelJobRequest
A request to cancel a job.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
job_id |
Required. The job ID. Authorization requires the following IAM permission on the specified resource
|
Cluster
Describes the identifying information, config, and status of a cluster of Compute Engine instances.
Fields | |
---|---|
project_id |
Required. The Google Cloud Platform project ID that the cluster belongs to. |
cluster_name |
Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused. |
config |
Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated. |
labels |
Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a cluster. |
status |
Output only. Cluster status. |
status_history[] |
Output only. The previous cluster status. |
cluster_uuid |
Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster. |
metrics |
Output only. Contains cluster daemon metrics such as HDFS and YARN stats. Beta Feature: This report is available for testing purposes only. It may be changed before final release. |
ClusterConfig
The cluster config.
Fields | |
---|---|
config_bucket |
Optional. A Cloud Storage bucket used to stage job dependencies, config files, and job driver console output. If you do not specify a staging bucket, Cloud Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket (see Dataproc staging bucket). This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket. |
temp_bucket |
Optional. A Cloud Storage bucket used to store ephemeral cluster and jobs data, such as Spark and MapReduce history files. If you do not specify a temp bucket, Dataproc will determine a Cloud Storage location (US, ASIA, or EU) for your cluster's temp bucket according to the Compute Engine zone where your cluster is deployed, and then create and manage this project-level, per-location bucket. The default bucket has a TTL of 90 days, but you can use any TTL (or none) if you specify a bucket. This field requires a Cloud Storage bucket name, not a URI to a Cloud Storage bucket. |
gce_cluster_config |
Optional. The shared Compute Engine config settings for all instances in a cluster. |
master_config |
Optional. The Compute Engine config settings for the master instance in a cluster. |
worker_config |
Optional. The Compute Engine config settings for worker instances in a cluster. |
secondary_worker_config |
Optional. The Compute Engine config settings for additional worker instances in a cluster. |
software_config |
Optional. The config settings for software inside the cluster. |
lifecycle_config |
Optional. The config setting for auto delete cluster schedule. |
initialization_actions[] |
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
metadata to run an executable on a master or worker node, as shown below using
|
encryption_config |
Optional. Encryption settings for the cluster. |
autoscaling_config |
Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset. |
endpoint_config |
Optional. Port/endpoint configuration for this cluster |
security_config |
Optional. Security related configuration. |
gke_cluster_config |
Optional. The Kubernetes Engine config for Dataproc clusters deployed to Kubernetes. Setting this is considered mutually exclusive with Compute Engine-based options such as |
metastore_config |
Optional. Metastore configuration. |
ClusterMetrics
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.
Fields | |
---|---|
hdfs_metrics |
The HDFS metrics. |
yarn_metrics |
The YARN metrics. |
ClusterOperation
The cluster operation triggered by a workflow.
Fields | |
---|---|
operation_id |
Output only. The id of the cluster operation. |
error |
Output only. Error, if operation failed. |
done |
Output only. Indicates the operation is done. |
ClusterOperationMetadata
Metadata describing the operation.
Fields | |
---|---|
cluster_name |
Output only. Name of the cluster for the operation. |
cluster_uuid |
Output only. Cluster UUID for the operation. |
status |
Output only. Current operation status. |
status_history[] |
Output only. The previous operation status. |
operation_type |
Output only. The operation type. |
description |
Output only. Short description of operation. |
labels |
Output only. Labels associated with the operation |
warnings[] |
Output only. Errors encountered during operation execution. |
ClusterOperationStatus
The status of the operation.
Fields | |
---|---|
state |
Output only. A message containing the operation state. |
inner_state |
Output only. A message containing the detailed operation state. |
details |
Output only. A message containing any operation metadata details. |
state_start_time |
Output only. The time this state was entered. |
State
The operation state.
Enums | |
---|---|
UNKNOWN |
Unused. |
PENDING |
The operation has been created. |
RUNNING |
The operation is running. |
DONE |
The operation is done; either cancelled or completed. |
ClusterSelector
A selector that chooses target cluster for jobs based on metadata.
Fields | |
---|---|
zone |
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. |
cluster_labels |
Required. The cluster labels. Cluster must have all labels to match. |
ClusterStatus
The status of a cluster and its instances.
Fields | |
---|---|
state |
Output only. The cluster's state. |
detail |
Output only. Optional details of cluster's state. |
state_start_time |
Output only. Time when this state was entered (see JSON representation of Timestamp). |
substate |
Output only. Additional state information that includes status reported by the agent. |
State
The cluster state.
Enums | |
---|---|
UNKNOWN |
The cluster state is unknown. |
CREATING |
The cluster is being created and set up. It is not ready for use. |
RUNNING |
The cluster is currently running and healthy. It is ready for use. |
ERROR |
The cluster encountered an error. It is not ready for use. |
DELETING |
The cluster is being deleted. It cannot be used. |
UPDATING |
The cluster is being updated. It continues to accept and process jobs. |
STOPPING |
The cluster is being stopped. It cannot be used. |
STOPPED |
The cluster is currently stopped. It is not ready for use. |
STARTING |
The cluster is being started. It is not ready for use. |
Substate
The cluster substate.
Enums | |
---|---|
UNSPECIFIED |
The cluster substate is unknown. |
UNHEALTHY |
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 |
The agent-reported status is out of date (may occur if Dataproc loses communication with Agent). Applies to RUNNING state. |
Component
Cluster components that can be activated.
Enums | |
---|---|
COMPONENT_UNSPECIFIED |
Unspecified component. Specifying this will cause Cluster creation to fail. |
ANACONDA |
The Anaconda python distribution. The Anaconda component is not supported in the Dataproc 2.0 image. The 2.0 image is pre-installed with Miniconda. |
DOCKER |
Docker |
DRUID |
The Druid query engine. |
FLINK |
Flink |
HBASE |
HBase. |
HIVE_WEBHCAT |
The Hive Web HCatalog (the REST service for accessing HCatalog). |
JUPYTER |
The Jupyter Notebook. |
KERBEROS |
The Kerberos security feature. |
PRESTO |
The Presto query engine. |
RANGER |
The Ranger service. |
SOLR |
The Solr service. |
ZEPPELIN |
The Zeppelin notebook. |
ZOOKEEPER |
The Zookeeper service. |
CreateAutoscalingPolicyRequest
A request to create an autoscaling policy.
Fields | |
---|---|
parent |
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
policy |
Required. The autoscaling policy to create. |
CreateClusterRequest
A request to create a cluster.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the cluster belongs to. Authorization requires the following IAM permission on the specified resource
|
region |
Required. The Dataproc region in which to handle the request. |
cluster |
Required. The cluster to create. |
request_id |
Optional. A unique id used to identify the request. If the server receives two CreateClusterRequests with the same id, then the second request will be ignored and the first It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
CreateWorkflowTemplateRequest
A request to create a workflow template.
Fields | |
---|---|
parent |
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
template |
Required. The Dataproc workflow template to create. |
DeleteAutoscalingPolicyRequest
A request to delete an autoscaling policy.
Autoscaling policies in use by one or more clusters will not be deleted.
Fields | |
---|---|
name |
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
DeleteClusterRequest
A request to delete a cluster.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
cluster_name |
Required. The cluster name. Authorization requires the following IAM permission on the specified resource
|
cluster_uuid |
Optional. Specifying the |
request_id |
Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequests with the same id, then the second request will be ignored and the first It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
DeleteJobRequest
A request to delete a job.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
job_id |
Required. The job ID. Authorization requires the following IAM permission on the specified resource
|
DeleteWorkflowTemplateRequest
A request to delete a workflow template.
Currently started workflows will remain running.
Fields | |
---|---|
name |
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
version |
Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version. |
DiagnoseClusterRequest
A request to collect cluster diagnostic information.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
cluster_name |
Required. The cluster name. Authorization requires the following IAM permission on the specified resource
|
DiagnoseClusterResults
The location of diagnostic output.
Fields | |
---|---|
output_uri |
Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics. |
DiskConfig
Specifies the config of disk options for a group of VM instances.
Fields | |
---|---|
boot_disk_type |
Optional. Type of the boot disk (default is "pd-standard"). Valid values: "pd-balanced" (Persistent Disk Balanced Solid State Drive), "pd-ssd" (Persistent Disk Solid State Drive), or "pd-standard" (Persistent Disk Hard Disk Drive). See Disk types. |
boot_disk_size_gb |
Optional. Size in GB of the boot disk (default is 500GB). |
num_local_ssds |
Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries. |
EncryptionConfig
Encryption settings for the cluster.
Fields | |
---|---|
gce_pd_kms_key_name |
Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster. |
EndpointConfig
Endpoint config for this cluster
Fields | |
---|---|
http_ports |
Output only. The map of port descriptions to URLs. Will only be populated if enable_http_port_access is true. |
enable_http_port_access |
Optional. If true, enable http access to specific ports on the cluster from external sources. Defaults to false. |
GceClusterConfig
Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.
Fields | |
---|---|
zone_uri |
Optional. The zone where the Compute Engine cluster will be located. On a create request, it is required in the "global" region. If omitted in a non-global Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present. A full URL, partial URI, or short name are valid. Examples:
|
network_uri |
Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither A full URL, partial URI, or short name are valid. Examples:
|
subnetwork_uri |
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:
|
internal_ip_only |
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 |
private_ipv6_google_access |
Optional. The type of IPv6 access for a cluster. |
service_account |
Optional. The Dataproc service account (also see VM Data Plane identity) used by Dataproc cluster VM instances to access Google Cloud Platform services. If not specified, the Compute Engine default service account is used. |
service_account_scopes[] |
Optional. The URIs of service account scopes to be included in Compute Engine instances. The following base set of scopes is always included:
If no scopes are specified, the following defaults are also provided: |
tags[] |
The Compute Engine tags to add to all instances (see Tagging instances). |
metadata |
The Compute Engine metadata entries to add to all instances (see Project and instance metadata). |
reservation_affinity |
Optional. Reservation Affinity for consuming Zonal reservation. |
node_group_affinity |
Optional. Node Group Affinity for sole-tenant clusters. |
shielded_instance_config |
Optional. Shielded Instance Config for clusters using Compute Engine Shielded VMs. |
PrivateIpv6GoogleAccess
PrivateIpv6GoogleAccess
controls whether and how Dataproc cluster nodes can communicate with Google Services through gRPC over IPv6. These values are directly mapped to corresponding values in the Compute Engine Instance fields.
Enums | |
---|---|
PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED |
If unspecified, Compute Engine default behavior will apply, which is the same as INHERIT_FROM_SUBNETWORK . |
INHERIT_FROM_SUBNETWORK |
Private access to and from Google Services configuration inherited from the subnetwork configuration. This is the default Compute Engine behavior. |
OUTBOUND |
Enables outbound private IPv6 access to Google Services from the Dataproc cluster. |
BIDIRECTIONAL |
Enables bidirectional private IPv6 access between Google Services and the Dataproc cluster. |
GetAutoscalingPolicyRequest
A request to fetch an autoscaling policy.
Fields | |
---|---|
name |
Required. The "resource name" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
GetClusterRequest
Request to get the resource representation for a cluster in a project.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the cluster belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
cluster_name |
Required. The cluster name. Authorization requires the following IAM permission on the specified resource
|
GetJobRequest
A request to get the resource representation for a job in a project.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
job_id |
Required. The job ID. Authorization requires the following IAM permission on the specified resource
|
GetWorkflowTemplateRequest
A request to fetch a workflow template.
Fields | |
---|---|
name |
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
version |
Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved. If unspecified, retrieves the current version. |
GkeClusterConfig
The GKE config for this cluster.
Fields | |
---|---|
namespaced_gke_deployment_target |
Optional. A target for the deployment. |
NamespacedGkeDeploymentTarget
A full, namespace-isolated deployment target for an existing GKE cluster.
Fields | |
---|---|
target_gke_cluster |
Optional. The target GKE cluster to deploy to. Format: 'projects/{project}/locations/{location}/clusters/{cluster_id}' |
cluster_namespace |
Optional. A namespace within the GKE cluster to deploy into. |
HadoopJob
A Dataproc job for running Apache Hadoop MapReduce jobs on Apache Hadoop YARN.
Fields | ||
---|---|---|
args[] |
Optional. The arguments to pass to the driver. Do not include arguments, such as |
|
jar_file_uris[] |
Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks. |
|
file_uris[] |
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. |
|
archive_uris[] |
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. |
|
properties |
Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code. |
|
logging_config |
Optional. The runtime log config for job execution. |
|
Union field 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. driver can be only one of the following: |
||
main_jar_file_uri |
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' |
|
main_class |
The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in |
HiveJob
A Dataproc job for running Apache Hive queries on YARN.
Fields | ||
---|---|---|
continue_on_failure |
Optional. Whether to continue executing queries if a query fails. The default value is |
|
script_variables |
Optional. Mapping of query variable names to values (equivalent to the Hive command: |
|
properties |
Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the 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. |
|
jar_file_uris[] |
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. |
|
Union field queries . Required. The sequence of Hive queries to execute, specified as either an HCFS file URI or a list of queries. queries can be only one of the following: |
||
query_file_uri |
The HCFS URI of the script that contains Hive queries. |
|
query_list |
A list of queries. |
InstanceGroupAutoscalingPolicyConfig
Configuration for the size bounds of an instance group, including its proportional size to other groups.
Fields | |
---|---|
min_instances |
Optional. Minimum number of instances for this group. Primary workers - Bounds: [2, max_instances]. Default: 2. Secondary workers - Bounds: [0, max_instances]. Default: 0. |
max_instances |
Optional. 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, ). Required. Secondary workers - Bounds: [min_instances, ). Default: 0. |
weight |
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 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. |
InstanceGroupConfig
The config settings for Compute Engine resources in an instance group, such as a master or worker group.
Fields | |
---|---|
num_instances |
Optional. The number of VM instances in the instance group. For HA cluster master_config groups, must be set to 3. For standard cluster master_config groups, must be set to 1. |
instance_names[] |
Output only. The list of instance names. Dataproc derives the names from |
image_uri |
Optional. The Compute Engine image resource used for cluster instances. The URI can represent an image or image family. Image examples:
Image family examples. Dataproc will use the most recent image from the family:
If the URI is unspecified, it will be inferred from |
machine_type_uri |
Optional. The Compute Engine machine type used for cluster instances. A full URL, partial URI, or short name are valid. Examples:
Auto Zone Exception: If you are using the Dataproc Auto Zone Placement feature, you must use the short name of the machine type resource, for example, |
disk_config |
Optional. Disk option config settings. |
is_preemptible |
Output only. Specifies that this instance group contains preemptible instances. |
preemptibility |
Optional. Specifies the preemptibility of the instance group. The default value for master and worker groups is The default value for secondary instances is |
managed_group_config |
Output only. The config for Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups. |
accelerators[] |
Optional. The Compute Engine accelerator configuration for these instances. |
min_cpu_platform |
Specifies the minimum cpu platform for the Instance Group. See Dataproc -> Minimum CPU Platform. |
Preemptibility
Controls the use of preemptible instances within the group.
Enums | |
---|---|
PREEMPTIBILITY_UNSPECIFIED |
Preemptibility is unspecified, the system will choose the appropriate setting for each instance group. |
NON_PREEMPTIBLE |
Instances are non-preemptible. This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups. |
PREEMPTIBLE |
Instances are preemptible. This option is allowed only for secondary worker groups. |
InstantiateInlineWorkflowTemplateRequest
A request to instantiate an inline workflow template.
Fields | |
---|---|
parent |
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
template |
Required. The workflow template to instantiate. |
instance_id |
Deprecated. Please use |
request_id |
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. The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
InstantiateWorkflowTemplateRequest
A request to instantiate a workflow template.
Fields | |
---|---|
name |
Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
version |
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. |
instance_id |
Deprecated. Please use |
request_id |
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. The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
parameters |
Optional. Map from parameter names to values that should be used for those parameters. Values may not exceed 1000 characters. |
Job
A Dataproc job resource.
Fields | ||
---|---|---|
reference |
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
. |
|
placement |
Required. Job information, including how, when, and where to run the job. |
|
status |
Output only. The job status. Additional application-specific status information may be contained in the
and
fields. |
|
status_history[] |
Output only. The previous job status. |
|
yarn_applications[] |
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. |
|
submitted_by |
Output only. The email address of the user submitting the job. For jobs submitted on the cluster, the address is . |
|
driver_output_resource_uri |
Output only. A URI pointing to the location of the stdout of the job's driver program. |
|
driver_control_files_uri |
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 |
|
labels |
Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035. Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035. No more than 32 labels can be associated with a job. |
|
scheduling |
Optional. Job scheduling configuration. |
|
job_uuid |
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. |
|
done |
Output only. Indicates whether the job is completed. If the value is |
|
Union field type_job . Required. The application/framework-specific portion of the job. type_job can be only one of the following: |
||
hadoop_job |
Optional. Job is a Hadoop job. |
|
spark_job |
Optional. Job is a Spark job. |
|
pyspark_job |
Optional. Job is a PySpark job. |
|
hive_job |
Optional. Job is a Hive job. |
|
pig_job |
Optional. Job is a Pig job. |
|
spark_r_job |
Optional. Job is a SparkR job. |
|
spark_sql_job |
Optional. Job is a SparkSql job. |
|
presto_job |
Optional. Job is a Presto job. |
JobMetadata
Job Operation metadata.
Fields | |
---|---|
job_id |
Output only. The job id. |
status |
Output only. Most recent job status. |
operation_type |
Output only. Operation type. |
start_time |
Output only. Job submission time. |
JobPlacement
Dataproc job config.
Fields | |
---|---|
cluster_name |
Required. The name of the cluster where the job will be submitted. |
cluster_uuid |
Output only. A cluster UUID generated by the Dataproc service when the job is submitted. |
cluster_labels |
Optional. Cluster labels to identify a cluster where the job will be submitted. |
JobReference
Encapsulates the full scoping used to reference a job.
Fields | |
---|---|
project_id |
Optional. The ID of the Google Cloud Platform project that the job belongs to. If specified, must match the request project ID. |
job_id |
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. |
JobScheduling
Job scheduling options.
Fields | |
---|---|
max_failures_per_hour |
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. |
max_failures_total |
Optional. Maximum number of times in total a driver may be restarted as a result of driver exiting with non-zero code before job is reported failed. Maximum value is 240. |
JobStatus
Dataproc job status.
Fields | |
---|---|
state |
Output only. A state message specifying the overall job state. |
details |
Output only. Optional Job state details, such as an error description if the state is
. |
state_start_time |
Output only. The time when this state was entered. |
substate |
Output only. Additional state information, which includes status reported by the agent. |
State
The job state.
Enums | |
---|---|
STATE_UNSPECIFIED |
The job state is unknown. |
PENDING |
The job is pending; it has been submitted, but is not yet running. |
SETUP_DONE |
Job has been received by the service and completed initial setup; it will soon be submitted to the cluster. |
RUNNING |
The job is running on the cluster. |
CANCEL_PENDING |
A CancelJob request has been received, but is pending. |
CANCEL_STARTED |
Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster. |
CANCELLED |
The job cancellation was successful. |
DONE |
The job has completed successfully. |
ERROR |
The job has completed, but encountered an error. |
ATTEMPT_FAILURE |
Job attempt has failed. The detail field contains failure details for this attempt. Applies to restartable jobs only. |
Substate
The job substate.
Enums | |
---|---|
UNSPECIFIED |
The job substate is unknown. |
SUBMITTED |
The Job is submitted to the agent. Applies to RUNNING state. |
QUEUED |
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 |
The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Dataproc. If the agent does not send a timely update, the job will fail. Applies to RUNNING state. |
KerberosConfig
Specifies Kerberos related configuration.
Fields | |
---|---|
enable_kerberos |
Optional. Flag to indicate whether to Kerberize the cluster (default: false). Set this field to true to enable Kerberos on a cluster. |
root_principal_password_uri |
Optional. The Cloud Storage URI of a KMS encrypted file containing the root principal password. |
kms_key_uri |
Optional. The uri of the KMS key used to encrypt various sensitive files. |
keystore_uri |
Optional. The Cloud Storage URI of the keystore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. |
truststore_uri |
Optional. The Cloud Storage URI of the truststore file used for SSL encryption. If not provided, Dataproc will provide a self-signed certificate. |
keystore_password_uri |
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. |
key_password_uri |
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. |
truststore_password_uri |
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. |
cross_realm_trust_realm |
Optional. The remote realm the Dataproc on-cluster KDC will trust, should the user enable cross realm trust. |
cross_realm_trust_kdc |
Optional. The KDC (IP or hostname) for the remote trusted realm in a cross realm trust relationship. |
cross_realm_trust_admin_server |
Optional. The admin server (IP or hostname) for the remote trusted realm in a cross realm trust relationship. |
cross_realm_trust_shared_password_uri |
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. |
kdc_db_key_uri |
Optional. The Cloud Storage URI of a KMS encrypted file containing the master key of the KDC database. |
tgt_lifetime_hours |
Optional. The lifetime of the ticket granting ticket, in hours. If not specified, or user specifies 0, then default value 10 will be used. |
realm |
Optional. The name of the on-cluster Kerberos realm. If not specified, the uppercased domain of hostnames will be the realm. |
LifecycleConfig
Specifies the cluster auto-delete schedule configuration.
Fields | ||
---|---|---|
idle_delete_ttl |
Optional. The duration to keep the cluster alive while idling (when no jobs are running). Passing this threshold will cause the cluster to be deleted. Minimum value is 5 minutes; maximum value is 14 days (see JSON representation of Duration). |
|
idle_start_time |
Output only. The time when cluster became idle (most recent job finished) and became eligible for deletion due to idleness (see JSON representation of Timestamp). |
|
Union field ttl . Either the exact time the cluster should be deleted at or the cluster maximum age. ttl can be only one of the following: |
||
auto_delete_time |
Optional. The time when cluster will be auto-deleted. (see JSON representation of Timestamp). |
|
auto_delete_ttl |
Optional. The lifetime duration of cluster. The cluster will be auto-deleted at the end of this period. Minimum value is 10 minutes; maximum value is 14 days (see JSON representation of Duration). |
ListAutoscalingPoliciesRequest
A request to list autoscaling policies in a project.
Fields | |
---|---|
parent |
Required. The "resource name" of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100. |
page_token |
Optional. The page token, returned by a previous call, to request the next page of results. |
ListAutoscalingPoliciesResponse
A response to a request to list autoscaling policies in a project.
Fields | |
---|---|
policies[] |
Output only. Autoscaling policies list. |
next_page_token |
Output only. This token is included in the response if there are more results to fetch. |
ListClustersRequest
A request to list the clusters in a project.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the cluster belongs to. Authorization requires the following IAM permission on the specified resource
|
region |
Required. The Dataproc region in which to handle the request. |
filter |
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 Example filter: status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = * |
page_size |
Optional. The standard List page size. |
page_token |
Optional. The standard List page token. |
ListClustersResponse
The list of all clusters in a project.
Fields | |
---|---|
clusters[] |
Output only. The clusters in the project. |
next_page_token |
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
. |
ListJobsRequest
A request to list jobs in a project.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. Authorization requires the following IAM permission on the specified resource
|
region |
Required. The Dataproc region in which to handle the request. |
page_size |
Optional. The number of results to return in each response. |
page_token |
Optional. The page token, returned by a previous call, to request the next page of results. |
cluster_name |
Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster. |
job_state_matcher |
Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs). If |
filter |
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 Example filter: status.state = ACTIVE AND labels.env = staging AND labels.starred = * |
JobStateMatcher
A matcher that specifies categories of job states.
Enums | |
---|---|
ALL |
Match all jobs, regardless of state. |
ACTIVE |
Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING. |
NON_ACTIVE |
Only match jobs in terminal states: CANCELLED, DONE, or ERROR. |
ListJobsResponse
A list of jobs in a project.
Fields | |
---|---|
jobs[] |
Output only. Jobs list. |
next_page_token |
Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the
. |
ListWorkflowTemplatesRequest
A request to list workflow templates in a project.
Fields | |
---|---|
parent |
Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names.
Authorization requires the following IAM permission on the specified resource
|
page_size |
Optional. The maximum number of results to return in each response. |
page_token |
Optional. The page token, returned by a previous call, to request the next page of results. |
ListWorkflowTemplatesResponse
A response to a request to list workflow templates in a project.
Fields | |
---|---|
templates[] |
Output only. WorkflowTemplates list. |
next_page_token |
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
. |
LoggingConfig
The runtime logging config of the job.
Fields | |
---|---|
driver_log_levels |
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' |
Level
The Log4j level for job execution. When running an Apache Hive job, Cloud Dataproc configures the Hive client to an equivalent verbosity level.
Enums | |
---|---|
LEVEL_UNSPECIFIED |
Level is unspecified. Use default level for log4j. |
ALL |
Use ALL level for log4j. |
TRACE |
Use TRACE level for log4j. |
DEBUG |
Use DEBUG level for log4j. |
INFO |
Use INFO level for log4j. |
WARN |
Use WARN level for log4j. |
ERROR |
Use ERROR level for log4j. |
FATAL |
Use FATAL level for log4j. |
OFF |
Turn off log4j. |
ManagedCluster
Cluster that is managed by the workflow.
Fields | |
---|---|
cluster_name |
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. |
config |
Required. The cluster configuration. |
labels |
Optional. The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\p{Ll}\p{Lo}][\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. |
ManagedGroupConfig
Specifies the resources used to actively manage an instance group.
Fields | |
---|---|
instance_template_name |
Output only. The name of the Instance Template used for the Managed Instance Group. |
instance_group_manager_name |
Output only. The name of the Instance Group Manager for this group. |
MetastoreConfig
Specifies a Metastore configuration.
Fields | |
---|---|
dataproc_metastore_service |
Required. Resource name of an existing Dataproc Metastore service. Example:
|
NodeGroupAffinity
Node Group Affinity for clusters using sole-tenant node groups.
Fields | |
---|---|
node_group_uri |
Required. The URI of a sole-tenant node group resource that the cluster will be created on. A full URL, partial URI, or node group name are valid. Examples:
|
NodeInitializationAction
Specifies an executable to run on a fully configured node and a timeout period for executable completion.
Fields | |
---|---|
executable_file |
Required. Cloud Storage URI of executable file. |
execution_timeout |
Optional. Amount of time executable has to complete. Default is 10 minutes (see JSON representation of Duration). 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. |
OrderedJob
A job executed by the workflow.
Fields | ||
---|---|---|
step_id |
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 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. |
|
labels |
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. |
|
scheduling |
Optional. Job scheduling configuration. |
|
prerequisite_step_ids[] |
Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow. |
|
Union field job_type . Required. The job definition. job_type can be only one of the following: |
||
hadoop_job |
Optional. Job is a Hadoop job. |
|
spark_job |
Optional. Job is a Spark job. |
|
pyspark_job |
Optional. Job is a PySpark job. |
|
hive_job |
Optional. Job is a Hive job. |
|
pig_job |
Optional. Job is a Pig job. |
|
spark_r_job |
Optional. Job is a SparkR job. |
|
spark_sql_job |
Optional. Job is a SparkSql job. |
|
presto_job |
Optional. Job is a Presto job. |
ParameterValidation
Configuration for parameter validation.
Fields | ||
---|---|---|
Union field validation_type . Required. The type of validation to be performed. validation_type can be only one of the following: |
||
regex |
Validation based on regular expressions. |
|
values |
Validation based on a list of allowed values. |
PigJob
A Dataproc job for running Apache Pig queries on YARN.
Fields | ||
---|---|---|
continue_on_failure |
Optional. Whether to continue executing queries if a query fails. The default value is |
|
script_variables |
Optional. Mapping of query variable names to values (equivalent to the Pig command: |
|
properties |
Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the 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. |
|
jar_file_uris[] |
Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs. |
|
logging_config |
Optional. The runtime log config for job execution. |
|
Union field queries . Required. The sequence of Pig queries to execute, specified as an HCFS file URI or a list of queries. queries can be only one of the following: |
||
query_file_uri |
The HCFS URI of the script that contains the Pig queries. |
|
query_list |
A list of queries. |
PrestoJob
A Dataproc job for running Presto queries. IMPORTANT: The Dataproc Presto Optional Component must be enabled when the cluster is created to submit a Presto job to the cluster.
Fields | ||
---|---|---|
continue_on_failure |
Optional. Whether to continue executing queries if a query fails. The default value is |
|
output_format |
Optional. The format in which query output will be displayed. See the Presto documentation for supported output formats |
|
client_tags[] |
Optional. Presto client tags to attach to this query |
|
properties |
Optional. A mapping of property names to values. Used to set Presto session properties Equivalent to using the --session flag in the Presto CLI |
|
logging_config |
Optional. The runtime log config for job execution. |
|
Union field queries . Required. The sequence of Presto queries to execute, specified as either an HCFS file URI or as a list of queries. queries can be only one of the following: |
||
query_file_uri |
The HCFS URI of the script that contains SQL queries. |
|
query_list |
A list of queries. |
PySparkJob
A Dataproc job for running Apache PySpark applications on YARN.
Fields | |
---|---|
main_python_file_uri |
Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file. |
args[] |
Optional. The arguments to pass to the driver. Do not include arguments, such as |
python_file_uris[] |
Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip. |
jar_file_uris[] |
Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks. |
file_uris[] |
Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. |
archive_uris[] |
Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. |
properties |
Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. |
logging_config |
Optional. The runtime log config for job execution. |
QueryList
A list of queries to run on a cluster.
Fields | |
---|---|
queries[] |
Required. The queries to execute. You do not need to end a query expression with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of a Dataproc API snippet that uses a QueryList to specify a HiveJob:
|
RegexValidation
Validation based on regular expressions.
Fields | |
---|---|
regexes[] |
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). |
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
Fields | |
---|---|
consume_reservation_type |
Optional. Type of reservation to consume |
key |
Optional. Corresponds to the label key of reservation resource. |
values[] |
Optional. Corresponds to the label values of reservation resource. |
Type
Indicates whether to consume capacity from an reservation or not.
Enums | |
---|---|
TYPE_UNSPECIFIED |
|
NO_RESERVATION |
Do not consume from any allocated capacity. |
ANY_RESERVATION |
Consume any reservation available. |
SPECIFIC_RESERVATION |
Must consume from a specific reservation. Must specify key value fields for specifying the reservations. |
SecurityConfig
Security related configuration, including encryption, Kerberos, etc.
Fields | |
---|---|
kerberos_config |
Optional. Kerberos related configuration. |
ShieldedInstanceConfig
Shielded Instance Config for clusters using Compute Engine Shielded VMs.
Fields | |
---|---|
enable_secure_boot |
Optional. Defines whether instances have Secure Boot enabled. |
enable_vtpm |
Optional. Defines whether instances have the vTPM enabled. |
enable_integrity_monitoring |
Optional. Defines whether instances have integrity monitoring enabled. |
SoftwareConfig
Specifies the selection and config of software inside the cluster.
Fields | |
---|---|
image_version |
Optional. The version of software inside the cluster. It must be one of the supported Dataproc Versions, such as "1.2" (including a subminor version, such as "1.2.29"), or the "preview" version. If unspecified, it defaults to the latest Debian version. |
properties |
Optional. The properties to set on daemon config files. Property keys are specified in
For more information, see Cluster properties. |
optional_components[] |
The set of optional components to activate on the cluster. |
SparkJob
A Dataproc job for running Apache Spark applications on YARN. 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
.
Fields | ||
---|---|---|
args[] |
Optional. The arguments to pass to the driver. Do not include arguments, such as |
|
jar_file_uris[] |
Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks. |
|
file_uris[] |
Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. |
|
archive_uris[] |
Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. |
|
properties |
Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. |
|
logging_config |
Optional. The runtime log config for job execution. |
|
Union field
|
||
main_jar_file_uri |
The HCFS URI of the jar file that contains the main class. |
|
main_class |
The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in |
SparkRJob
A Dataproc job for running Apache SparkR applications on YARN.
Fields | |
---|---|
main_r_file_uri |
Required. The HCFS URI of the main R file to use as the driver. Must be a .R file. |
args[] |
Optional. The arguments to pass to the driver. Do not include arguments, such as |
file_uris[] |
Optional. HCFS URIs of files to be placed in the working directory of each executor. Useful for naively parallel tasks. |
archive_uris[] |
Optional. HCFS URIs of archives to be extracted into the working directory of each executor. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip. |
properties |
Optional. A mapping of property names to values, used to configure SparkR. Properties that conflict with values set by the Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code. |
logging_config |
Optional. The runtime log config for job execution. |
SparkSqlJob
A Dataproc job for running Apache Spark SQL queries.
Fields | ||
---|---|---|
script_variables |
Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET |
|
properties |
Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Dataproc API may be overwritten. |
|
jar_file_uris[] |
Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH. |
|
logging_config |
Optional. The runtime log config for job execution. |
|
Union field queries . Required. The sequence of Spark SQL queries to execute, specified as either an HCFS file URI or as a list of queries. queries can be only one of the following: |
||
query_file_uri |
The HCFS URI of the script that contains SQL queries. |
|
query_list |
A list of queries. |
StartClusterRequest
A request to start a cluster.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
cluster_name |
Required. The cluster name. Authorization requires the following IAM permission on the specified resource
|
cluster_uuid |
Optional. Specifying the |
request_id |
Optional. A unique id used to identify the request. If the server receives two StartClusterRequests with the same id, then the second request will be ignored and the first Recommendation: Set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
StopClusterRequest
A request to stop a cluster.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
cluster_name |
Required. The cluster name. Authorization requires the following IAM permission on the specified resource
|
cluster_uuid |
Optional. Specifying the |
request_id |
Optional. A unique id used to identify the request. If the server receives two StopClusterRequests with the same id, then the second request will be ignored and the first Recommendation: Set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
SubmitJobRequest
A request to submit a job.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. Authorization requires one or more of the following IAM permissions on the specified resource
|
region |
Required. The Dataproc region in which to handle the request. |
job |
Required. The job resource. |
request_id |
Optional. A unique id used to identify the request. If the server receives two SubmitJobRequests with the same id, then the second request will be ignored and the first It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
TemplateParameter
A 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)
Fields | |
---|---|
name |
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. |
fields[] |
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 Also, field paths can reference fields using the following syntax:
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:
|
description |
Optional. Brief description of the parameter. Must not exceed 1024 characters. |
validation |
Optional. Validation rules to be applied to this parameter's value. |
UpdateAutoscalingPolicyRequest
A request to update an autoscaling policy.
Fields | |
---|---|
policy |
Required. The updated autoscaling policy. Authorization requires the following IAM permission on the specified resource
|
UpdateClusterRequest
A request to update a cluster.
Fields | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
project_id |
Required. The ID of the Google Cloud Platform project the cluster belongs to. |
||||||||||||||||
region |
Required. The Dataproc region in which to handle the request. |
||||||||||||||||
cluster_name |
Required. The cluster name. |
||||||||||||||||
cluster |
Required. The changes to the cluster. Authorization requires the following IAM permission on the specified resource
|
||||||||||||||||
graceful_decommission_timeout |
Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day (see JSON representation of Duration). Only supported on Dataproc image versions 1.2 and higher. |
||||||||||||||||
update_mask |
Required. Specifies the path, relative to
Similarly, to change the number of preemptible workers in a cluster to 5, the
Note: currently only the following fields can be updated:
|
||||||||||||||||
request_id |
Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequests with the same id, then the second request will be ignored and the first It is recommended to always set this value to a UUID. The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. |
UpdateJobRequest
A request to update a job.
Fields | |
---|---|
project_id |
Required. The ID of the Google Cloud Platform project that the job belongs to. |
region |
Required. The Dataproc region in which to handle the request. |
job_id |
Required. The job ID. |
job |
Required. The changes to the job. Authorization requires the following IAM permission on the specified resource
|
update_mask |
Required. Specifies the path, relative to
, of the field to update. For example, to update the labels of a Job the
parameter would be specified as
, and the
is the only field that can be updated. |
UpdateWorkflowTemplateRequest
A request to update a workflow template.
Fields | |
---|---|
template |
Required. The updated workflow template. The Authorization requires the following IAM permission on the specified resource
|
ValueValidation
Validation based on a list of allowed values.
Fields | |
---|---|
values[] |
Required. List of allowed values for the parameter. |
WorkflowGraph
The workflow graph.
Fields | |
---|---|
nodes[] |
Output only. The workflow nodes. |
WorkflowMetadata
A Dataproc workflow template resource.
Fields | |
---|---|
template |
Output only. The resource name of the workflow template as described in https://cloud.google.com/apis/design/resource_names.
|
version |
Output only. The version of template at the time of workflow instantiation. |
create_cluster |
Output only. The create cluster operation metadata. |
graph |
Output only. The workflow graph. |
delete_cluster |
Output only. The delete cluster operation metadata. |
state |
Output only. The workflow state. |
cluster_name |
Output only. The name of the target cluster. |
parameters |
Map from parameter names to values that were used for those parameters. |
start_time |
Output only. Workflow start time. |
end_time |
Output only. Workflow end time. |
cluster_uuid |
Output only. The UUID of target cluster. |
dag_timeout |
Output only. The timeout duration for the DAG of jobs, expressed in seconds (see JSON representation of duration). |
dag_start_time |
Output only. DAG start time, which is only set for workflows with |
dag_end_time |
Output only. DAG end time, which is only set for workflows with |
State
The operation state.
Enums | |
---|---|
UNKNOWN |
Unused. |
PENDING |
The operation has been created. |
RUNNING |
The operation is running. |
DONE |
The operation is done; either cancelled or completed. |
WorkflowNode
The workflow node.
Fields | |
---|---|
step_id |
Output only. The name of the node. |
prerequisite_step_ids[] |
Output only. Node's prerequisite nodes. |
job_id |
Output only. The job id; populated after the node enters RUNNING state. |
state |
Output only. The node state. |
error |
Output only. The error detail. |
NodeState
The workflow node state.
Enums | |
---|---|
NODE_STATUS_UNSPECIFIED |
State is unspecified. |
BLOCKED |
The node is awaiting prerequisite node to finish. |
RUNNABLE |
The node is runnable but not running. |
RUNNING |
The node is running. |
COMPLETED |
The node completed successfully. |
FAILED |
The node failed. A node can be marked FAILED because its ancestor or peer failed. |
WorkflowTemplate
A Dataproc workflow template resource.
Fields | |
---|---|
id |
Required. The template 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. . |
name |
Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names.
|
version |
Optional. Used to perform a consistent read-modify-write. This field should be left blank for a |