Cloud Dataproc API

Manages Hadoop-based clusters and jobs on Google Cloud Platform.

Service: dataproc.googleapis.com

To call this service, we recommend that you use the Google-provided client libraries. If your application needs to use your own libraries to call this service, use the following information when you make the API requests.

Discovery document

A Discovery Document is a machine-readable specification for describing and consuming REST APIs. It is used to build client libraries, IDE plugins, and other tools that interact with Google APIs. One service may provide multiple discovery documents. This service provides the following discovery document:

Service endpoint

A service endpoint is a base URL that specifies the network address of an API service. One service might have multiple service endpoints. This service has the following service endpoint and all URIs below are relative to this service endpoint:

  • https://dataproc.googleapis.com

REST Resource: v1.projects.locations.autoscalingPolicies

Methods
create POST /v1/{parent=projects/*/locations/*}/autoscalingPolicies
Creates new autoscaling policy.
delete DELETE /v1/{name=projects/*/locations/*/autoscalingPolicies/*}
Deletes an autoscaling policy.
get GET /v1/{name=projects/*/locations/*/autoscalingPolicies/*}
Retrieves autoscaling policy.
getIamPolicy POST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/locations/*}/autoscalingPolicies
Lists autoscaling policies in the project.
setIamPolicy POST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
update PUT /v1/{policy.name=projects/*/locations/*/autoscalingPolicies/*}
Updates (replaces) autoscaling policy.

REST Resource: v1.projects.locations.batches

Methods
create POST /v1/{parent=projects/*/locations/*}/batches
Creates a batch workload that executes asynchronously.
delete DELETE /v1/{name=projects/*/locations/*/batches/*}
Deletes the batch workload resource.
get GET /v1/{name=projects/*/locations/*/batches/*}
Gets the batch workload resource representation.
list GET /v1/{parent=projects/*/locations/*}/batches
Lists batch workloads.

REST Resource: v1.projects.locations.operations

Methods
cancel POST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
list GET /v1/{name=projects/*/locations/*/operations}
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.sessionTemplates

Methods
create POST /v1/{parent=projects/*/locations/*}/sessionTemplates
Create a session template synchronously.
delete DELETE /v1/{name=projects/*/locations/*/sessionTemplates/*}
Deletes a session template.
get GET /v1/{name=projects/*/locations/*/sessionTemplates/*}
Gets the resource representation for a session template.
list GET /v1/{parent=projects/*/locations/*}/sessionTemplates
Lists session templates.
patch PATCH /v1/{sessionTemplate.name=projects/*/locations/*/sessionTemplates/*}
Updates the session template synchronously.

REST Resource: v1.projects.locations.sessions

Methods
create POST /v1/{parent=projects/*/locations/*}/sessions
Create an interactive session asynchronously.
delete DELETE /v1/{name=projects/*/locations/*/sessions/*}
Deletes the interactive session resource.
get GET /v1/{name=projects/*/locations/*/sessions/*}
Gets the resource representation for an interactive session.
list GET /v1/{parent=projects/*/locations/*}/sessions
Lists interactive sessions.
terminate POST /v1/{name=projects/*/locations/*/sessions/*}:terminate
Terminates the interactive session.

REST Resource: v1.projects.locations.workflowTemplates

Methods
create POST /v1/{parent=projects/*/locations/*}/workflowTemplates
Creates new workflow template.
delete DELETE /v1/{name=projects/*/locations/*/workflowTemplates/*}
Deletes a workflow template.
get GET /v1/{name=projects/*/locations/*/workflowTemplates/*}
Retrieves the latest workflow template.
getIamPolicy POST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:getIamPolicy
Gets the access control policy for a resource.
instantiate POST /v1/{name=projects/*/locations/*/workflowTemplates/*}:instantiate
Instantiates a template and begins execution.
instantiateInline POST /v1/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline
Instantiates a template and begins execution.
list GET /v1/{parent=projects/*/locations/*}/workflowTemplates
Lists workflows that match the specified filter in the request.
setIamPolicy POST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
update PUT /v1/{template.name=projects/*/locations/*/workflowTemplates/*}
Updates (replaces) workflow template.

REST Resource: v1.projects.regions.autoscalingPolicies

Methods
create POST /v1/{parent=projects/*/regions/*}/autoscalingPolicies
Creates new autoscaling policy.
delete DELETE /v1/{name=projects/*/regions/*/autoscalingPolicies/*}
Deletes an autoscaling policy.
get GET /v1/{name=projects/*/regions/*/autoscalingPolicies/*}
Retrieves autoscaling policy.
getIamPolicy POST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{parent=projects/*/regions/*}/autoscalingPolicies
Lists autoscaling policies in the project.
setIamPolicy POST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
update PUT /v1/{policy.name=projects/*/regions/*/autoscalingPolicies/*}
Updates (replaces) autoscaling policy.

REST Resource: v1.projects.regions.clusters

Methods
create POST /v1/projects/{projectId}/regions/{region}/clusters
Creates a cluster in a project.
delete DELETE /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Deletes a cluster in a project.
diagnose POST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose
Gets cluster diagnostic information.
get GET /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Gets the resource representation for a cluster in a project.
getIamPolicy POST /v1/{resource=projects/*/regions/*/clusters/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/projects/{projectId}/regions/{region}/clusters
Lists all regions/{region}/clusters in a project alphabetically.
patch PATCH /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Updates a cluster in a project.
setIamPolicy POST /v1/{resource=projects/*/regions/*/clusters/*}:setIamPolicy
Sets the access control policy on the specified resource.
start POST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start
Starts a cluster in a project.
stop POST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop
Stops a cluster in a project.
testIamPermissions POST /v1/{resource=projects/*/regions/*/clusters/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.regions.clusters.nodeGroups

Methods
get GET /v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}
Gets the resource representation for a node group in a cluster.
resize POST /v1/{name=projects/*/regions/*/clusters/*/nodeGroups/*}:resize
Resizes a node group in a cluster.

REST Resource: v1.projects.regions.jobs

Methods
cancel POST /v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel
Starts a job cancellation request.
delete DELETE /v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Deletes the job from the project.
get GET /v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Gets the resource representation for a job in a project.
getIamPolicy POST /v1/{resource=projects/*/regions/*/jobs/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/projects/{projectId}/regions/{region}/jobs
Lists regions/{region}/jobs in a project.
patch PATCH /v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Updates a job in a project.
setIamPolicy POST /v1/{resource=projects/*/regions/*/jobs/*}:setIamPolicy
Sets the access control policy on the specified resource.
submit POST /v1/projects/{projectId}/regions/{region}/jobs:submit
Submits a job to a cluster.
submitAsOperation POST /v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation
Submits job to a cluster.
testIamPermissions POST /v1/{resource=projects/*/regions/*/jobs/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.regions.operations

Methods
cancel POST /v1/{name=projects/*/regions/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
delete DELETE /v1/{name=projects/*/regions/*/operations/*}
Deletes a long-running operation.
get GET /v1/{name=projects/*/regions/*/operations/*}
Gets the latest state of a long-running operation.
getIamPolicy POST /v1/{resource=projects/*/regions/*/operations/*}:getIamPolicy
Gets the access control policy for a resource.
list GET /v1/{name=projects/*/regions/*/operations}
Lists operations that match the specified filter in the request.
setIamPolicy POST /v1/{resource=projects/*/regions/*/operations/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/regions/*/operations/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.regions.workflowTemplates

Methods
create POST /v1/{parent=projects/*/regions/*}/workflowTemplates
Creates new workflow template.
delete DELETE /v1/{name=projects/*/regions/*/workflowTemplates/*}
Deletes a workflow template.
get GET /v1/{name=projects/*/regions/*/workflowTemplates/*}
Retrieves the latest workflow template.
getIamPolicy POST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:getIamPolicy
Gets the access control policy for a resource.
instantiate POST /v1/{name=projects/*/regions/*/workflowTemplates/*}:instantiate
Instantiates a template and begins execution.
instantiateInline POST /v1/{parent=projects/*/regions/*}/workflowTemplates:instantiateInline
Instantiates a template and begins execution.
list GET /v1/{parent=projects/*/regions/*}/workflowTemplates
Lists workflows that match the specified filter in the request.
setIamPolicy POST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissions POST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
update PUT /v1/{template.name=projects/*/regions/*/workflowTemplates/*}
Updates (replaces) workflow template.