Classes
AcceleratorConfig
Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.
AutoscalingConfig
Autoscaling Policy config associated with the cluster.
AutoscalingPolicy
Describes an autoscaling policy for Dataproc cluster autoscaler.
AutoscalingPolicyName
Resource name for the AutoscalingPolicy
resource.
AutoscalingPolicyService
The API interface for managing autoscaling policies in the Dataproc API.
AutoscalingPolicyService.AutoscalingPolicyServiceBase
Base class for server-side implementations of AutoscalingPolicyService
AutoscalingPolicyService.AutoscalingPolicyServiceClient
Client for AutoscalingPolicyService
AutoscalingPolicyServiceClient
AutoscalingPolicyService client wrapper, for convenient use.
AutoscalingPolicyServiceClientBuilder
Builder class for AutoscalingPolicyServiceClient to provide simple configuration of credentials, endpoint etc.
AutoscalingPolicyServiceClientImpl
AutoscalingPolicyService client wrapper implementation, for convenient use.
AutoscalingPolicyServiceSettings
Settings for AutoscalingPolicyServiceClient instances.
BasicAutoscalingAlgorithm
Basic algorithm for autoscaling.
BasicYarnAutoscalingConfig
Basic autoscaling configurations for YARN.
CancelJobRequest
A request to cancel a job.
Cluster
Describes the identifying information, config, and status of a cluster of Compute Engine instances.
ClusterConfig
The cluster config.
ClusterController
The ClusterControllerService provides methods to manage clusters of Compute Engine instances.
ClusterController.ClusterControllerBase
Base class for server-side implementations of ClusterController
ClusterController.ClusterControllerClient
Client for ClusterController
ClusterControllerClient
ClusterController client wrapper, for convenient use.
ClusterControllerClientBuilder
Builder class for ClusterControllerClient to provide simple configuration of credentials, endpoint etc.
ClusterControllerClientImpl
ClusterController client wrapper implementation, for convenient use.
ClusterControllerSettings
Settings for ClusterControllerClient instances.
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.
ClusterName
Resource name for the Cluster
resource.
ClusterOperation
The cluster operation triggered by a workflow.
ClusterOperationMetadata
Metadata describing the operation.
ClusterOperationStatus
The status of the operation.
ClusterOperationStatus.Types
Container for nested types declared in the ClusterOperationStatus message type.
ClusterSelector
A selector that chooses target cluster for jobs based on metadata.
ClusterStatus
The status of a cluster and its instances.
ClusterStatus.Types
Container for nested types declared in the ClusterStatus message type.
CreateAutoscalingPolicyRequest
A request to create an autoscaling policy.
CreateClusterRequest
A request to create a cluster.
CreateWorkflowTemplateRequest
A request to create a workflow template.
DeleteAutoscalingPolicyRequest
A request to delete an autoscaling policy.
Autoscaling policies in use by one or more clusters will not be deleted.
DeleteClusterRequest
A request to delete a cluster.
DeleteJobRequest
A request to delete a job.
DeleteWorkflowTemplateRequest
A request to delete a workflow template.
Currently started workflows will remain running.
DiagnoseClusterRequest
A request to collect cluster diagnostic information.
DiagnoseClusterResults
The location of diagnostic output.
DiskConfig
Specifies the config of disk options for a group of VM instances.
EncryptionConfig
Encryption settings for the cluster.
EndpointConfig
Endpoint config for this cluster
GceClusterConfig
Common config settings for resources of Compute Engine cluster instances, applicable to all instances in the cluster.
GceClusterConfig.Types
Container for nested types declared in the GceClusterConfig message type.
GetAutoscalingPolicyRequest
A request to fetch an autoscaling policy.
GetClusterRequest
Request to get the resource representation for a cluster in a project.
GetJobRequest
A request to get the resource representation for a job in a project.
GetWorkflowTemplateRequest
A request to fetch a workflow template.
GkeClusterConfig
The GKE config for this cluster.
GkeClusterConfig.Types
Container for nested types declared in the GkeClusterConfig message type.
GkeClusterConfig.Types.NamespacedGkeDeploymentTarget
A full, namespace-isolated deployment target for an existing GKE cluster.
HadoopJob
A Dataproc job for running Apache Hadoop MapReduce jobs on Apache Hadoop YARN.
HiveJob
A Dataproc job for running Apache Hive queries on YARN.
IdentityConfig
Identity related configuration, including service account based secure multi-tenancy user mappings.
InstanceGroupAutoscalingPolicyConfig
Configuration for the size bounds of an instance group, including its proportional size to other groups.
InstanceGroupConfig
The config settings for Compute Engine resources in an instance group, such as a master or worker group.
InstanceGroupConfig.Types
Container for nested types declared in the InstanceGroupConfig message type.
InstantiateInlineWorkflowTemplateRequest
A request to instantiate an inline workflow template.
InstantiateWorkflowTemplateRequest
A request to instantiate a workflow template.
Job
A Dataproc job resource.
JobController
The JobController provides methods to manage jobs.
JobController.JobControllerBase
Base class for server-side implementations of JobController
JobController.JobControllerClient
Client for JobController
JobControllerClient
JobController client wrapper, for convenient use.
JobControllerClientBuilder
Builder class for JobControllerClient to provide simple configuration of credentials, endpoint etc.
JobControllerClientImpl
JobController client wrapper implementation, for convenient use.
JobControllerSettings
Settings for JobControllerClient instances.
JobMetadata
Job Operation metadata.
JobPlacement
Dataproc job config.
JobReference
Encapsulates the full scoping used to reference a job.
JobScheduling
Job scheduling options.
JobStatus
Dataproc job status.
JobStatus.Types
Container for nested types declared in the JobStatus message type.
KerberosConfig
Specifies Kerberos related configuration.
LifecycleConfig
Specifies the cluster auto-delete schedule configuration.
ListAutoscalingPoliciesRequest
A request to list autoscaling policies in a project.
ListAutoscalingPoliciesResponse
A response to a request to list autoscaling policies in a project.
ListClustersRequest
A request to list the clusters in a project.
ListClustersResponse
The list of all clusters in a project.
ListJobsRequest
A request to list jobs in a project.
ListJobsRequest.Types
Container for nested types declared in the ListJobsRequest message type.
ListJobsResponse
A list of jobs in a project.
ListWorkflowTemplatesRequest
A request to list workflow templates in a project.
ListWorkflowTemplatesResponse
A response to a request to list workflow templates in a project.
LoggingConfig
The runtime logging config of the job.
LoggingConfig.Types
Container for nested types declared in the LoggingConfig message type.
ManagedCluster
Cluster that is managed by the workflow.
ManagedGroupConfig
Specifies the resources used to actively manage an instance group.
MetastoreConfig
Specifies a Metastore configuration.
NodeGroupAffinity
Node Group Affinity for clusters using sole-tenant node groups.
NodeInitializationAction
Specifies an executable to run on a fully configured node and a timeout period for executable completion.
OrderedJob
A job executed by the workflow.
ParameterValidation
Configuration for parameter validation.
PigJob
A Dataproc job for running Apache Pig queries on YARN.
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.
PySparkJob
A Dataproc job for running Apache PySpark applications on YARN.
QueryList
A list of queries to run on a cluster.
RegexValidation
Validation based on regular expressions.
RegionName
Resource name for the Region
resource.
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
ReservationAffinity.Types
Container for nested types declared in the ReservationAffinity message type.
SecurityConfig
Security related configuration, including encryption, Kerberos, etc.
ServiceName
Resource name for the Service
resource.
ShieldedInstanceConfig
Shielded Instance Config for clusters using Compute Engine Shielded VMs.
SoftwareConfig
Specifies the selection and config of software inside the cluster.
SparkJob
A Dataproc job for running Apache Spark applications on YARN.
SparkRJob
A Dataproc job for running Apache SparkR applications on YARN.
SparkSqlJob
A Dataproc job for running Apache Spark SQL queries.
StartClusterRequest
A request to start a cluster.
StopClusterRequest
A request to stop a cluster.
SubmitJobRequest
A request to submit a job.
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)
UpdateAutoscalingPolicyRequest
A request to update an autoscaling policy.
UpdateClusterRequest
A request to update a cluster.
UpdateJobRequest
A request to update a job.
UpdateWorkflowTemplateRequest
A request to update a workflow template.
ValueValidation
Validation based on a list of allowed values.
WorkflowGraph
The workflow graph.
WorkflowMetadata
A Dataproc workflow template resource.
WorkflowMetadata.Types
Container for nested types declared in the WorkflowMetadata message type.
WorkflowNode
The workflow node.
WorkflowNode.Types
Container for nested types declared in the WorkflowNode message type.
WorkflowTemplate
A Dataproc workflow template resource.
WorkflowTemplateName
Resource name for the WorkflowTemplate
resource.
WorkflowTemplatePlacement
Specifies workflow execution target.
Either managed_cluster
or cluster_selector
is required.
WorkflowTemplateService
The API interface for managing Workflow Templates in the Dataproc API.
WorkflowTemplateService.WorkflowTemplateServiceBase
Base class for server-side implementations of WorkflowTemplateService
WorkflowTemplateService.WorkflowTemplateServiceClient
Client for WorkflowTemplateService
WorkflowTemplateServiceClient
WorkflowTemplateService client wrapper, for convenient use.
WorkflowTemplateServiceClientBuilder
Builder class for WorkflowTemplateServiceClient to provide simple configuration of credentials, endpoint etc.
WorkflowTemplateServiceClientImpl
WorkflowTemplateService client wrapper implementation, for convenient use.
WorkflowTemplateServiceSettings
Settings for WorkflowTemplateServiceClient instances.
YarnApplication
A 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.
YarnApplication.Types
Container for nested types declared in the YarnApplication message type.
Enums
AutoscalingPolicy.AlgorithmOneofCase
Enum of possible cases for the "algorithm" oneof.
AutoscalingPolicyName.ResourceNameType
The possible contents of AutoscalingPolicyName.
ClusterName.ResourceNameType
The possible contents of ClusterName.
ClusterOperationStatus.Types.State
The operation state.
ClusterStatus.Types.State
The cluster state.
ClusterStatus.Types.Substate
The cluster substate.
Component
Cluster components that can be activated. Next ID: 16.
GceClusterConfig.Types.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.
HadoopJob.DriverOneofCase
Enum of possible cases for the "driver" oneof.
HiveJob.QueriesOneofCase
Enum of possible cases for the "queries" oneof.
InstanceGroupConfig.Types.Preemptibility
Controls the use of preemptible instances within the group.
Job.TypeJobOneofCase
Enum of possible cases for the "type_job" oneof.
JobStatus.Types.State
The job state.
JobStatus.Types.Substate
The job substate.
LifecycleConfig.TtlOneofCase
Enum of possible cases for the "ttl" oneof.
ListJobsRequest.Types.JobStateMatcher
A matcher that specifies categories of job states.
LoggingConfig.Types.Level
The Log4j level for job execution. When running an Apache Hive job, Cloud Dataproc configures the Hive client to an equivalent verbosity level.
OrderedJob.JobTypeOneofCase
Enum of possible cases for the "job_type" oneof.
ParameterValidation.ValidationTypeOneofCase
Enum of possible cases for the "validation_type" oneof.
PigJob.QueriesOneofCase
Enum of possible cases for the "queries" oneof.
PrestoJob.QueriesOneofCase
Enum of possible cases for the "queries" oneof.
RegionName.ResourceNameType
The possible contents of RegionName.
ReservationAffinity.Types.Type
Indicates whether to consume capacity from an reservation or not.
ServiceName.ResourceNameType
The possible contents of ServiceName.
SparkJob.DriverOneofCase
Enum of possible cases for the "driver" oneof.
SparkSqlJob.QueriesOneofCase
Enum of possible cases for the "queries" oneof.
WorkflowMetadata.Types.State
The operation state.
WorkflowNode.Types.NodeState
The workflow node state.
WorkflowTemplateName.ResourceNameType
The possible contents of WorkflowTemplateName.
WorkflowTemplatePlacement.PlacementOneofCase
Enum of possible cases for the "placement" oneof.
YarnApplication.Types.State
The application state, corresponding to <code>YarnProtos.YarnApplicationStateProto</code>.