Package Classes (5.23.0) Stay organized with collections Save and categorize content based on your preferences.
Summary of entries of Classes for dataproc.
Classes
AutoscalingPolicyServiceAsyncClient
The API interface for managing autoscaling policies in theDataproc API.
AutoscalingPolicyServiceClient
The API interface for managing autoscaling policies in theDataproc API.
ListAutoscalingPoliciesAsyncPager
A pager for iterating throughlist_autoscaling_policies requests.
This class thinly wraps an initialListAutoscalingPoliciesResponse object, andprovides an__aiter__ method to iterate through itspolicies field.
If there are more pages, the__aiter__ method will make additionalListAutoscalingPolicies requests and continue to iteratethrough thepolicies field on thecorresponding responses.
All the usualListAutoscalingPoliciesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListAutoscalingPoliciesPager
A pager for iterating throughlist_autoscaling_policies requests.
This class thinly wraps an initialListAutoscalingPoliciesResponse object, andprovides an__iter__ method to iterate through itspolicies field.
If there are more pages, the__iter__ method will make additionalListAutoscalingPolicies requests and continue to iteratethrough thepolicies field on thecorresponding responses.
All the usualListAutoscalingPoliciesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
BatchControllerAsyncClient
The BatchController provides methods to manage batchworkloads.
BatchControllerClient
The BatchController provides methods to manage batchworkloads.
ListBatchesAsyncPager
A pager for iterating throughlist_batches requests.
This class thinly wraps an initialListBatchesResponse object, andprovides an__aiter__ method to iterate through itsbatches field.
If there are more pages, the__aiter__ method will make additionalListBatches requests and continue to iteratethrough thebatches field on thecorresponding responses.
All the usualListBatchesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListBatchesPager
A pager for iterating throughlist_batches requests.
This class thinly wraps an initialListBatchesResponse object, andprovides an__iter__ method to iterate through itsbatches field.
If there are more pages, the__iter__ method will make additionalListBatches requests and continue to iteratethrough thebatches field on thecorresponding responses.
All the usualListBatchesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ClusterControllerAsyncClient
The ClusterControllerService provides methods to manageclusters of Compute Engine instances.
ClusterControllerClient
The ClusterControllerService provides methods to manageclusters of Compute Engine instances.
ListClustersAsyncPager
A pager for iterating throughlist_clusters requests.
This class thinly wraps an initialListClustersResponse object, andprovides an__aiter__ method to iterate through itsclusters field.
If there are more pages, the__aiter__ method will make additionalListClusters requests and continue to iteratethrough theclusters field on thecorresponding responses.
All the usualListClustersResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListClustersPager
A pager for iterating throughlist_clusters requests.
This class thinly wraps an initialListClustersResponse object, andprovides an__iter__ method to iterate through itsclusters field.
If there are more pages, the__iter__ method will make additionalListClusters requests and continue to iteratethrough theclusters field on thecorresponding responses.
All the usualListClustersResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
JobControllerAsyncClient
The JobController provides methods to manage jobs.
JobControllerClient
The JobController provides methods to manage jobs.
ListJobsAsyncPager
A pager for iterating throughlist_jobs requests.
This class thinly wraps an initialListJobsResponse object, andprovides an__aiter__ method to iterate through itsjobs field.
If there are more pages, the__aiter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.
All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListJobsPager
A pager for iterating throughlist_jobs requests.
This class thinly wraps an initialListJobsResponse object, andprovides an__iter__ method to iterate through itsjobs field.
If there are more pages, the__iter__ method will make additionalListJobs requests and continue to iteratethrough thejobs field on thecorresponding responses.
All the usualListJobsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
NodeGroupControllerAsyncClient
TheNodeGroupControllerService provides methods to manage nodegroups of Compute Engine managed instances.
NodeGroupControllerClient
TheNodeGroupControllerService provides methods to manage nodegroups of Compute Engine managed instances.
SessionControllerAsyncClient
TheSessionController provides methods to manage interactivesessions.
SessionControllerClient
TheSessionController provides methods to manage interactivesessions.
ListSessionsAsyncPager
A pager for iterating throughlist_sessions requests.
This class thinly wraps an initialListSessionsResponse object, andprovides an__aiter__ method to iterate through itssessions field.
If there are more pages, the__aiter__ method will make additionalListSessions requests and continue to iteratethrough thesessions field on thecorresponding responses.
All the usualListSessionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListSessionsPager
A pager for iterating throughlist_sessions requests.
This class thinly wraps an initialListSessionsResponse object, andprovides an__iter__ method to iterate through itssessions field.
If there are more pages, the__iter__ method will make additionalListSessions requests and continue to iteratethrough thesessions field on thecorresponding responses.
All the usualListSessionsResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
SessionTemplateControllerAsyncClient
The SessionTemplateController provides methods to managesession templates.
SessionTemplateControllerClient
The SessionTemplateController provides methods to managesession templates.
ListSessionTemplatesAsyncPager
A pager for iterating throughlist_session_templates requests.
This class thinly wraps an initialListSessionTemplatesResponse object, andprovides an__aiter__ method to iterate through itssession_templates field.
If there are more pages, the__aiter__ method will make additionalListSessionTemplates requests and continue to iteratethrough thesession_templates field on thecorresponding responses.
All the usualListSessionTemplatesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListSessionTemplatesPager
A pager for iterating throughlist_session_templates requests.
This class thinly wraps an initialListSessionTemplatesResponse object, andprovides an__iter__ method to iterate through itssession_templates field.
If there are more pages, the__iter__ method will make additionalListSessionTemplates requests and continue to iteratethrough thesession_templates field on thecorresponding responses.
All the usualListSessionTemplatesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
WorkflowTemplateServiceAsyncClient
The API interface for managing Workflow Templates in theDataproc API.
WorkflowTemplateServiceClient
The API interface for managing Workflow Templates in theDataproc API.
ListWorkflowTemplatesAsyncPager
A pager for iterating throughlist_workflow_templates requests.
This class thinly wraps an initialListWorkflowTemplatesResponse object, andprovides an__aiter__ method to iterate through itstemplates field.
If there are more pages, the__aiter__ method will make additionalListWorkflowTemplates requests and continue to iteratethrough thetemplates field on thecorresponding responses.
All the usualListWorkflowTemplatesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
ListWorkflowTemplatesPager
A pager for iterating throughlist_workflow_templates requests.
This class thinly wraps an initialListWorkflowTemplatesResponse object, andprovides an__iter__ method to iterate through itstemplates field.
If there are more pages, the__iter__ method will make additionalListWorkflowTemplates requests and continue to iteratethrough thetemplates field on thecorresponding responses.
All the usualListWorkflowTemplatesResponseattributes are available on the pager. If multiple requests are made, onlythe most recent response is retained, and thus used for attribute lookup.
AcceleratorConfig
Specifies the type and number of accelerator cards attached to theinstances of an instance. SeeGPUs on ComputeEngine <https://cloud.google.com/compute/docs/gpus/>__.
AuthenticationConfig
Authentication configuration for a workload is used to setthe default identity for the workload execution.The config specifies the type of identity (service account oruser) that will be used by workloads to access resources on theproject(s).
AuthenticationType
Authentication types for workload execution.
AutoscalingConfig
Autoscaling Policy config associated with the cluster.
AutoscalingPolicy
Describes an autoscaling policy for Dataproc clusterautoscaler.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
AutotuningConfig
Autotuning configuration of the workload.
Scenario
Scenario represents a specific goal that autotuning willattempt to achieve by modifying workloads.
AuxiliaryNodeGroup
Node group identification and configuration information.
AuxiliaryServicesConfig
Auxiliary services configuration for a Cluster.
BasicAutoscalingAlgorithm
Basic algorithm for autoscaling.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BasicYarnAutoscalingConfig
Basic autoscaling configurations for YARN.
Batch
A representation of a batch workload in the service.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
State
The batch state.
StateHistory
Historical state information.
BatchOperationMetadata
Metadata describing the Batch operation.
BatchOperationType
Operation type for Batch resources
LabelsEntry
The abstract base class for a message.
CancelJobRequest
A request to cancel a job.
Cluster
Describes the identifying information, config, and status ofa Dataproc cluster
LabelsEntry
The abstract base class for a message.
ClusterConfig
The cluster config.
ClusterTier
The cluster tier.
ClusterMetrics
Contains cluster daemon metrics, such as HDFS and YARN stats.
Beta Feature: This report is available for testing purposesonly. It may be changed before final release.
HdfsMetricsEntry
The abstract base class for a message.
YarnMetricsEntry
The abstract base class for a message.
ClusterOperation
The cluster operation triggered by a workflow.
ClusterOperationMetadata
Metadata describing the operation.
LabelsEntry
The abstract base class for a message.
ClusterOperationStatus
The status of the operation.
State
The operation state.
ClusterSelector
A selector that chooses target cluster for jobs based onmetadata.
ClusterLabelsEntry
The abstract base class for a message.
ClusterStatus
The status of a cluster and its instances.
State
The cluster state.
**Note:** The cluster state changes from "creating" to "running" status after the master node(s), first two primary worker nodes (and the last primary worker node if primary workers > 2) are running.ERROR (3): The cluster encountered an error. It is not ready for use.ERROR_DUE_TO_UPDATE (9): The cluster has encountered an error while being updated. Jobs can be submitted to the cluster, but the cluster cannot be updated.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.STOPPING (6): The cluster is being stopped. It cannot be used.STOPPED (7): The cluster is currently stopped. It is not ready for use.STARTING (8): The cluster is being started. It is not ready for use.REPAIRING (10): The cluster is being repaired. It is not ready for use.Substate
The cluster substate.
Applies to RUNNING state.STALE_STATUS (2): 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.
ConfidentialInstanceConfig
Confidential Instance Config for clusters usingConfidentialVMs <https://cloud.google.com/compute/confidential-vm/docs>__
CreateAutoscalingPolicyRequest
A request to create an autoscaling policy.
CreateBatchRequest
A request to create a batch workload.
CreateClusterRequest
A request to create a cluster.
CreateNodeGroupRequest
A request to create a node group.
CreateSessionRequest
A request to create a session.
CreateSessionTemplateRequest
A request to create a session template.
CreateWorkflowTemplateRequest
A request to create a workflow template.
DataprocMetricConfig
Dataproc metric config.
Metric
A Dataproc custom metric.
MetricSource
A source for the collection of Dataproc custom metrics (seeCustommetrics).
DeleteAutoscalingPolicyRequest
A request to delete an autoscaling policy.
Autoscaling policies in use by one or more clusters will not bedeleted.
DeleteBatchRequest
A request to delete a batch workload.
DeleteClusterRequest
A request to delete a cluster.
DeleteJobRequest
A request to delete a job.
DeleteSessionRequest
A request to delete a session.
DeleteSessionTemplateRequest
A request to delete a session template.
DeleteWorkflowTemplateRequest
A request to delete a workflow template.
Currently started workflows will remain running.
DiagnoseClusterRequest
A request to collect cluster diagnostic information.
TarballAccess
Defines who has access to the diagnostic tarball
DiagnoseClusterResults
The location of diagnostic output.
DiskConfig
Specifies the config of disk options for a group of VMinstances.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
DriverSchedulingConfig
Driver scheduling configuration.
EncryptionConfig
Encryption settings for the cluster.
EndpointConfig
Endpoint config for this cluster
HttpPortsEntry
The abstract base class for a message.
EnvironmentConfig
Environment configuration for a workload.
ExecutionConfig
Execution configuration for a workload.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
FailureAction
Actions in response to failure of a resource associated witha cluster.
FlinkJob
A Dataproc job for running Apache Flink applications on YARN.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
GceClusterConfig
Common config settings for resources of Compute Enginecluster instances, applicable to all instances in the cluster.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
MetadataEntry
The abstract base class for a message.
PrivateIpv6GoogleAccess
PrivateIpv6GoogleAccess controls whether and how Dataproccluster nodes can communicate with Google Services through gRPC overIPv6. These values are directly mapped to corresponding values intheCompute Engine Instancefields <https://cloud.google.com/compute/docs/reference/rest/v1/instances>__.
GetAutoscalingPolicyRequest
A request to fetch an autoscaling policy.
GetBatchRequest
A request to get the resource representation for a batchworkload.
GetClusterRequest
Request to get the resource representation for a cluster in aproject.
GetJobRequest
A request to get the resource representation for a job in aproject.
GetNodeGroupRequest
A request to get a node group .
GetSessionRequest
A request to get the resource representation for a session.
GetSessionTemplateRequest
A request to get the resource representation for a sessiontemplate.
GetWorkflowTemplateRequest
A request to fetch a workflow template.
GkeClusterConfig
The cluster's GKE config.
GkeNodePoolConfig
The configuration of a GKE node pool used by aDataproc-on-GKEcluster <https://cloud.google.com/dataproc/docs/concepts/jobs/dataproc-gke#create-a-dataproc-on-gke-cluster>__.
GkeNodeConfig
Parameters that describe cluster nodes.
GkeNodePoolAcceleratorConfig
A GkeNodeConfigAcceleratorConfig represents a HardwareAccelerator request for a node pool.
GkeNodePoolAutoscalingConfig
GkeNodePoolAutoscaling contains information the clusterautoscaler needs to adjust the size of the node pool to thecurrent cluster usage.
GkeNodePoolTarget
GKE node pools that Dataproc workloads run on.
Role
Role specifies the tasks that will run on the node pool. Rolescan be specific to workloads. Exactly oneGkeNodePoolTargetwithin the virtual cluster must have theDEFAULT role, which isused to run all workloads that are not associated with a node pool.
HadoopJob
A Dataproc job for runningApache HadoopMapReduce <https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html>jobs onApache HadoopYARN <https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html>.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
HiveJob
A Dataproc job for runningApacheHive <https://hive.apache.org/>__ queries on YARN.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
ScriptVariablesEntry
The abstract base class for a message.
IdentityConfig
Identity related configuration, including service accountbased secure multi-tenancy user mappings.
UserServiceAccountMappingEntry
The abstract base class for a message.
InstanceFlexibilityPolicy
Instance flexibility Policy allowing a mixture of VM shapesand provisioning models.
InstanceSelection
Defines machines types and a rank to which the machines typesbelong.
InstanceSelectionResult
Defines a mapping from machine types to the number of VMsthat are created with each machine type.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ProvisioningModelMix
Defines how Dataproc should create VMs with a mixture ofprovisioning models.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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 inan instance group, such as a master or worker group.
Preemptibility
Controls the use of preemptible instances within the group.
This option is allowed for all instance groups and is the only valid value for Master and Worker instance groups.PREEMPTIBLE (2): Instances are [preemptible] (https://cloud.google.com/compute/docs/instances/preemptible). This option is allowed only for [secondary worker] (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups.SPOT (3): Instances are [Spot VMs] (https://cloud.google.com/compute/docs/instances/spot). This option is allowed only for [secondary worker] (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups. Spot VMs are the latest version of [preemptible VMs] (https://cloud.google.com/compute/docs/instances/preemptible), and provide additional features.InstanceReference
A reference to a Compute Engine instance.
InstantiateInlineWorkflowTemplateRequest
A request to instantiate an inline workflow template.
InstantiateWorkflowTemplateRequest
A request to instantiate a workflow template.
ParametersEntry
The abstract base class for a message.
Job
A Dataproc job resource.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
JobMetadata
Job Operation metadata.
JobPlacement
Dataproc job config.
ClusterLabelsEntry
The abstract base class for a message.
JobReference
Encapsulates the full scoping used to reference a job.
JobScheduling
Job scheduling options.
JobStatus
Dataproc job status.
State
The job state.
Applies to restartable jobs only.Substate
The job substate.
Applies to RUNNING state.QUEUED (2): The Job has been received and is awaiting execution (it might 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 can 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.JupyterConfig
Jupyter configuration for an interactive session.
Kernel
Jupyter kernel types.
KerberosConfig
Specifies Kerberos related configuration.
KubernetesClusterConfig
The configuration for running the Dataproc cluster onKubernetes.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
KubernetesSoftwareConfig
The software configuration for this Dataproc cluster runningon Kubernetes.
ComponentVersionEntry
The abstract base class for a message.
PropertiesEntry
The abstract base class for a message.
LifecycleConfig
Specifies the cluster auto-delete schedule configuration.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListAutoscalingPoliciesRequest
A request to list autoscaling policies in a project.
ListAutoscalingPoliciesResponse
A response to a request to list autoscaling policies in aproject.
ListBatchesRequest
A request to list batch workloads in a project.
ListBatchesResponse
A list of batch workloads.
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.
JobStateMatcher
A matcher that specifies categories of job states.
ListJobsResponse
A list of jobs in a project.
ListSessionTemplatesRequest
A request to list session templates in a project.
ListSessionTemplatesResponse
A list of session templates.
ListSessionsRequest
A request to list sessions in a project.
ListSessionsResponse
A list of interactive sessions.
ListWorkflowTemplatesRequest
A request to list workflow templates in a project.
ListWorkflowTemplatesResponse
A response to a request to list workflow templates in aproject.
LoggingConfig
The runtime logging config of the job.
DriverLogLevelsEntry
The abstract base class for a message.
Level
The Log4j level for job execution. When running anApacheHive <https://hive.apache.org/>__ job, Cloud Dataproc configuresthe Hive client to an equivalent verbosity level.
ManagedCluster
Cluster that is managed by the workflow.
LabelsEntry
The abstract base class for a message.
ManagedGroupConfig
Specifies the resources used to actively manage an instancegroup.
MetastoreConfig
Specifies a Metastore configuration.
NodeGroup
Dataproc Node Group.The DataprocNodeGroup resource is notrelated to the DataprocNodeGroupAffinityresource.
LabelsEntry
The abstract base class for a message.
Role
Node pool roles.
NodeGroupAffinity
Node Group Affinity for clusters using sole-tenant node groups.The DataprocNodeGroupAffinity resource is not related to theDataprocNodeGroup resource.
NodeGroupOperationMetadata
Metadata describing the node group operation.
LabelsEntry
The abstract base class for a message.
NodeGroupOperationType
Operation type for node group resources.
NodeInitializationAction
Specifies an executable to run on a fully configured node anda timeout period for executable completion.
OrderedJob
A job executed by the workflow.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
ParameterValidation
Configuration for parameter validation.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PeripheralsConfig
Auxiliary services configuration for a workload.
PigJob
A Dataproc job for runningApache Pig <https://pig.apache.org/>__queries on YARN.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
ScriptVariablesEntry
The abstract base class for a message.
PrestoJob
A Dataproc job for runningPresto <https://prestosql.io/>queries.IMPORTANT: TheDataproc Presto OptionalComponent <https://cloud.google.com/dataproc/docs/concepts/components/presto>must be enabled when the cluster is created to submit a Presto jobto the cluster.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
PyPiRepositoryConfig
Configuration for PyPi repository
PySparkBatch
A configuration for running anApachePySpark <https://spark.apache.org/docs/latest/api/python/getting_started/quickstart.html>__batch workload.
PySparkJob
A Dataproc job for runningApachePySpark <https://spark.apache.org/docs/0.9.0/python-programming-guide.html>__applications on YARN.
PropertiesEntry
The abstract base class for a message.
QueryList
A list of queries to run on a cluster.
RegexValidation
Validation based on regular expressions.
RepositoryConfig
Configuration for dependency repositories
ReservationAffinity
Reservation Affinity for consuming Zonal reservation.
Type
Indicates whether to consume capacity from an reservation ornot.
ResizeNodeGroupRequest
A request to resize a node group.
RuntimeConfig
Runtime configuration for a workload.
PropertiesEntry
The abstract base class for a message.
RuntimeInfo
Runtime information about workload execution.
EndpointsEntry
The abstract base class for a message.
SecurityConfig
Security related configuration, including encryption,Kerberos, etc.
Session
A representation of a session.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
SessionStateHistory
Historical state information.
State
The session state.
SessionOperationMetadata
Metadata describing the Session operation.
LabelsEntry
The abstract base class for a message.
SessionOperationType
Operation type for Session resources
SessionTemplate
A representation of a session template.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
LabelsEntry
The abstract base class for a message.
ShieldedInstanceConfig
Shielded Instance Config for clusters usingCompute Engine ShieldedVMs <https://cloud.google.com/security/shielded-cloud/shielded-vm>__.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SoftwareConfig
Specifies the selection and config of software inside thecluster.
PropertiesEntry
The abstract base class for a message.
SparkBatch
A configuration for running anApacheSpark <https://spark.apache.org/>__ batch workload.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SparkConnectConfig
Spark Connect configuration for an interactive session.
SparkHistoryServerConfig
Spark History Server configuration for the workload.
SparkJob
A Dataproc job for runningApacheSpark <https://spark.apache.org/>__ applications on YARN.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
SparkRBatch
A configuration for running anApacheSparkR <https://spark.apache.org/docs/latest/sparkr.html>__ batchworkload.
SparkRJob
A Dataproc job for runningApacheSparkR <https://spark.apache.org/docs/latest/sparkr.html>__applications on YARN.
PropertiesEntry
The abstract base class for a message.
SparkSqlBatch
A configuration for runningApache SparkSQL <https://spark.apache.org/sql/>__ queries as a batch workload.
QueryVariablesEntry
The abstract base class for a message.
SparkSqlJob
A Dataproc job for runningApache SparkSQL <https://spark.apache.org/sql/>__ queries.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
ScriptVariablesEntry
The abstract base class for a message.
StartClusterRequest
A request to start a cluster.
StartupConfig
Configuration to handle the startup of instances duringcluster create and update process.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StopClusterRequest
A request to stop a cluster.
SubmitJobRequest
A request to submit a job.
TemplateParameter
A configurable parameter that replaces one or more fields inthe template. Parameterizable fields:
- Labels
- File uris
- Job properties
- Job arguments
- Script variables
- Main class (in HadoopJob and SparkJob)
- Zone (in ClusterSelector)
TerminateSessionRequest
A request to terminate an interactive session.
TrinoJob
A Dataproc job for runningTrino <https://trino.io/> queries.IMPORTANT: TheDataproc Trino OptionalComponent <https://cloud.google.com/dataproc/docs/concepts/components/trino>must be enabled when the cluster is created to submit a Trino job tothe cluster.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PropertiesEntry
The abstract base class for a message.
UpdateAutoscalingPolicyRequest
A request to update an autoscaling policy.
UpdateClusterRequest
A request to update a cluster.
UpdateJobRequest
A request to update a job.
UpdateSessionTemplateRequest
A request to update a session template.
UpdateWorkflowTemplateRequest
A request to update a workflow template.
UsageMetrics
Usage metrics represent approximate total resources consumedby a workload.
UsageSnapshot
The usage snapshot represents the resources consumed by aworkload at a specified time.
ValueValidation
Validation based on a list of allowed values.
VirtualClusterConfig
The Dataproc cluster config for a cluster that does not directlycontrol the underlying compute resources, such as aDataproc-on-GKEcluster <https://cloud.google.com/dataproc/docs/guides/dpgke/dataproc-gke-overview>__.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WorkflowGraph
The workflow graph.
WorkflowMetadata
A Dataproc workflow template resource.
ParametersEntry
The abstract base class for a message.
State
The operation state.
WorkflowNode
The workflow node.
NodeState
The workflow node state.
WorkflowTemplate
A Dataproc workflow template resource.
EncryptionConfig
Encryption settings for encrypting workflow template jobarguments.
LabelsEntry
The abstract base class for a message.
WorkflowTemplatePlacement
Specifies workflow execution target.
Eithermanaged_cluster orcluster_selector is required.
This message hasoneof_ fields (mutually exclusive fields).For each oneof, at most one member field can be set at the same time.Setting any member of the oneof automatically clears all othermembers.
.. _oneof:https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
YarnApplication
A YARN application created by a job. Application information is asubset oforg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto.
Beta Feature: This report is available for testing purposesonly. It may be changed before final release.
State
The application state, corresponding toYarnProtos.YarnApplicationStateProto.
Modules
pagers
API documentation fordataproc_v1.services.autoscaling_policy_service.pagers module.
pagers
API documentation fordataproc_v1.services.batch_controller.pagers module.
pagers
API documentation fordataproc_v1.services.cluster_controller.pagers module.
pagers
API documentation fordataproc_v1.services.job_controller.pagers module.
pagers
API documentation fordataproc_v1.services.session_controller.pagers module.
pagers
API documentation fordataproc_v1.services.session_template_controller.pagers module.
pagers
API documentation fordataproc_v1.services.workflow_template_service.pagers module.
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-11-13 UTC.