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
createPOST /v1/{parent=projects/*/locations/*}/autoscalingPolicies
Creates new autoscaling policy.
deleteDELETE /v1/{name=projects/*/locations/*/autoscalingPolicies/*}
Deletes an autoscaling policy.
getGET /v1/{name=projects/*/locations/*/autoscalingPolicies/*}
Retrieves autoscaling policy.
getIamPolicyPOST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/locations/*}/autoscalingPolicies
Lists autoscaling policies in the project.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/autoscalingPolicies/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updatePUT /v1/{policy.name=projects/*/locations/*/autoscalingPolicies/*}
Updates (replaces) autoscaling policy.

REST Resource: v1.projects.locations.operations

Methods
cancelPOST /v1/{name=projects/*/locations/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1/{name=projects/*/locations/*/operations/*}
Deletes a long-running operation.
getGET /v1/{name=projects/*/locations/*/operations/*}
Gets the latest state of a long-running operation.
listGET /v1/{name=projects/*/locations/*/operations}
Lists operations that match the specified filter in the request.

REST Resource: v1.projects.locations.workflowTemplates

Methods
createPOST /v1/{parent=projects/*/locations/*}/workflowTemplates
Creates new workflow template.
deleteDELETE /v1/{name=projects/*/locations/*/workflowTemplates/*}
Deletes a workflow template.
getGET /v1/{name=projects/*/locations/*/workflowTemplates/*}
Retrieves the latest workflow template.
getIamPolicyPOST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:getIamPolicy
Gets the access control policy for a resource.
instantiatePOST /v1/{name=projects/*/locations/*/workflowTemplates/*}:instantiate
Instantiates a template and begins execution.
instantiateInlinePOST /v1/{parent=projects/*/locations/*}/workflowTemplates:instantiateInline
Instantiates a template and begins execution.
listGET /v1/{parent=projects/*/locations/*}/workflowTemplates
Lists workflows that match the specified filter in the request.
setIamPolicyPOST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/locations/*/workflowTemplates/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updatePUT /v1/{template.name=projects/*/locations/*/workflowTemplates/*}
Updates (replaces) workflow template.

REST Resource: v1.projects.regions.autoscalingPolicies

Methods
createPOST /v1/{parent=projects/*/regions/*}/autoscalingPolicies
Creates new autoscaling policy.
deleteDELETE /v1/{name=projects/*/regions/*/autoscalingPolicies/*}
Deletes an autoscaling policy.
getGET /v1/{name=projects/*/regions/*/autoscalingPolicies/*}
Retrieves autoscaling policy.
getIamPolicyPOST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{parent=projects/*/regions/*}/autoscalingPolicies
Lists autoscaling policies in the project.
setIamPolicyPOST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/regions/*/autoscalingPolicies/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updatePUT /v1/{policy.name=projects/*/regions/*/autoscalingPolicies/*}
Updates (replaces) autoscaling policy.

REST Resource: v1.projects.regions.clusters

Methods
createPOST /v1/projects/{projectId}/regions/{region}/clusters
Creates a cluster in a project.
deleteDELETE /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Deletes a cluster in a project.
diagnosePOST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose
Gets cluster diagnostic information.
getGET /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Gets the resource representation for a cluster in a project.
getIamPolicyPOST /v1/{resource=projects/*/regions/*/clusters/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/projects/{projectId}/regions/{region}/clusters
Lists all regions/{region}/clusters in a project alphabetically.
/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}
Updates a cluster in a project.
setIamPolicyPOST /v1/{resource=projects/*/regions/*/clusters/*}:setIamPolicy
Sets the access control policy on the specified resource.
startPOST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:start
Starts a cluster in a project.
stopPOST /v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:stop
Stops a cluster in a project.
testIamPermissionsPOST /v1/{resource=projects/*/regions/*/clusters/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

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

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

REST Resource: v1.projects.regions.jobs

Methods
cancelPOST /v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel
Starts a job cancellation request.
deleteDELETE /v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Deletes the job from the project.
getGET /v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Gets the resource representation for a job in a project.
getIamPolicyPOST /v1/{resource=projects/*/regions/*/jobs/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/projects/{projectId}/regions/{region}/jobs
Lists regions/{region}/jobs in a project.
/v1/projects/{projectId}/regions/{region}/jobs/{jobId}
Updates a job in a project.
setIamPolicyPOST /v1/{resource=projects/*/regions/*/jobs/*}:setIamPolicy
Sets the access control policy on the specified resource.
submitPOST /v1/projects/{projectId}/regions/{region}/jobs:submit
Submits a job to a cluster.
submitAsOperationPOST /v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation
Submits job to a cluster.
testIamPermissionsPOST /v1/{resource=projects/*/regions/*/jobs/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.regions.operations

Methods
cancelPOST /v1/{name=projects/*/regions/*/operations/*}:cancel
Starts asynchronous cancellation on a long-running operation.
deleteDELETE /v1/{name=projects/*/regions/*/operations/*}
Deletes a long-running operation.
getGET /v1/{name=projects/*/regions/*/operations/*}
Gets the latest state of a long-running operation.
getIamPolicyPOST /v1/{resource=projects/*/regions/*/operations/*}:getIamPolicy
Gets the access control policy for a resource.
listGET /v1/{name=projects/*/regions/*/operations}
Lists operations that match the specified filter in the request.
setIamPolicyPOST /v1/{resource=projects/*/regions/*/operations/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/regions/*/operations/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.

REST Resource: v1.projects.regions.workflowTemplates

Methods
createPOST /v1/{parent=projects/*/regions/*}/workflowTemplates
Creates new workflow template.
deleteDELETE /v1/{name=projects/*/regions/*/workflowTemplates/*}
Deletes a workflow template.
getGET /v1/{name=projects/*/regions/*/workflowTemplates/*}
Retrieves the latest workflow template.
getIamPolicyPOST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:getIamPolicy
Gets the access control policy for a resource.
instantiatePOST /v1/{name=projects/*/regions/*/workflowTemplates/*}:instantiate
Instantiates a template and begins execution.
instantiateInlinePOST /v1/{parent=projects/*/regions/*}/workflowTemplates:instantiateInline
Instantiates a template and begins execution.
listGET /v1/{parent=projects/*/regions/*}/workflowTemplates
Lists workflows that match the specified filter in the request.
setIamPolicyPOST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:setIamPolicy
Sets the access control policy on the specified resource.
testIamPermissionsPOST /v1/{resource=projects/*/regions/*/workflowTemplates/*}:testIamPermissions
Returns permissions that a caller has on the specified resource.
updatePUT /v1/{template.name=projects/*/regions/*/workflowTemplates/*}
Updates (replaces) workflow template.