blob: 4e0c93c3c5cef33e61eb8275bd3093769220ac5d [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"basePath": "",
"baseUrl": "https://dataproc.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Dataproc",
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/dataproc/",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "dataproc:v1",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://dataproc.mtls.googleapis.com/",
"name": "dataproc",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"autoscalingPolicies": {
"methods": {
"create": {
"description": "Creates new autoscaling policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/autoscalingPolicies",
"request": {
"$ref": "AutoscalingPolicy"
},
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.locations.autoscalingPolicies.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves autoscaling policy.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "GET",
"id": "dataproc.projects.locations.autoscalingPolicies.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists autoscaling policies in the project.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies",
"httpMethod": "GET",
"id": "dataproc.projects.locations.autoscalingPolicies.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/autoscalingPolicies",
"response": {
"$ref": "ListAutoscalingPoliciesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.locations.autoscalingPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "PUT",
"id": "dataproc.projects.locations.autoscalingPolicies.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AutoscalingPolicy"
},
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workflowTemplates": {
"methods": {
"create": {
"description": "Creates new workflow template.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.locations.workflowTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "GET",
"id": "dataproc.projects.locations.workflowTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"instantiate": {
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.instantiate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:instantiate",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"instantiateInline": {
"description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates:instantiateInline",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.instantiateInline",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "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 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates:instantiateInline",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists workflows that match the specified filter in the request.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"httpMethod": "GET",
"id": "dataproc.projects.locations.workflowTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.locations.workflowTemplates.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "PUT",
"id": "dataproc.projects.locations.workflowTemplates.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
},
"regions": {
"resources": {
"autoscalingPolicies": {
"methods": {
"create": {
"description": "Creates new autoscaling policy.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/autoscalingPolicies",
"request": {
"$ref": "AutoscalingPolicy"
},
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes an autoscaling policy. It is an error to delete an autoscaling policy that is in use by one or more clusters.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.regions.autoscalingPolicies.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.delete, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves autoscaling policy.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "GET",
"id": "dataproc.projects.regions.autoscalingPolicies.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies.get, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists autoscaling policies in the project.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies",
"httpMethod": "GET",
"id": "dataproc.projects.regions.autoscalingPolicies.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response. Must be less than or equal to 1000. Defaults to 100.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The \"resource name\" of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies.list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.autoscalingPolicies.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/autoscalingPolicies",
"response": {
"$ref": "ListAutoscalingPoliciesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.autoscalingPolicies.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates (replaces) autoscaling policy.Disabled check for update_mask, because all updates will be full replacements.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/autoscalingPolicies/{autoscalingPoliciesId}",
"httpMethod": "PUT",
"id": "dataproc.projects.regions.autoscalingPolicies.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/autoscalingPolicies/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "AutoscalingPolicy"
},
"response": {
"$ref": "AutoscalingPolicy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"clusters": {
"methods": {
"create": {
"description": "Creates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.create",
"parameterOrder": [
"projectId",
"region"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"httpMethod": "DELETE",
"id": "dataproc.projects.regions.clusters.delete",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"description": "Required. The cluster name.",
"location": "path",
"required": true,
"type": "string"
},
"clusterUuid": {
"description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"diagnose": {
"description": "Gets cluster diagnostic information. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata). After the operation completes, Operation.response contains DiagnoseClusterResults (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#diagnoseclusterresults).",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.diagnose",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"description": "Required. The cluster name.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"request": {
"$ref": "DiagnoseClusterRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the resource representation for a cluster in a project.",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"httpMethod": "GET",
"id": "dataproc.projects.regions.clusters.get",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"description": "Required. The cluster name.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"response": {
"$ref": "Cluster"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists all regions/{region}/clusters in a project alphabetically.",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters",
"httpMethod": "GET",
"id": "dataproc.projects.regions.clusters.list",
"parameterOrder": [
"projectId",
"region"
],
"parameters": {
"filter": {
"description": "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 status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The standard List page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The standard List page token.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters",
"response": {
"$ref": "ListClustersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a cluster in a project. The returned Operation.metadata will be ClusterOperationMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#clusteroperationmetadata).",
"flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"httpMethod": "PATCH",
"id": "dataproc.projects.regions.clusters.patch",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"description": "Required. The cluster name.",
"location": "path",
"required": true,
"type": "string"
},
"gracefulDecommissionTimeout": {
"description": "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 (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher.",
"format": "google-duration",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
},
"requestId": {
"description": "Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
},
"updateMask": {
"description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows: { \"config\":{ \"secondaryWorkerConfig\":{ \"numInstances\":\"5\" } } } *Note:* Currently, only the following fields can be updated: *Mask* *Purpose* *labels* Update labels *config.worker_config.num_instances* Resize primary worker group *config.secondary_worker_config.num_instances* Resize secondary worker group config.autoscaling_config.policy_uri Use, stop using, or change autoscaling policies ",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"request": {
"$ref": "Cluster"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.clusters.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"jobs": {
"methods": {
"cancel": {
"description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/list) or regions/{region}/jobs.get (https://cloud.google.com/dataproc/docs/reference/rest/v1/projects.regions.jobs/get).",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.cancel",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"parameters": {
"jobId": {
"description": "Required. The job ID.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"request": {
"$ref": "CancelJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.regions.jobs.delete",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"parameters": {
"jobId": {
"description": "Required. The job ID.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the resource representation for a job in a project.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"httpMethod": "GET",
"id": "dataproc.projects.regions.jobs.get",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"parameters": {
"jobId": {
"description": "Required. The job ID.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists regions/{region}/jobs in a project.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs",
"httpMethod": "GET",
"id": "dataproc.projects.regions.jobs.list",
"parameterOrder": [
"projectId",
"region"
],
"parameters": {
"clusterName": {
"description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
"location": "query",
"type": "string"
},
"filter": {
"description": "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 status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *",
"location": "query",
"type": "string"
},
"jobStateMatcher": {
"description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.",
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
],
"enumDescriptions": [
"Match all jobs, regardless of state.",
"Only match jobs in non-terminal states: PENDING, RUNNING, or CANCEL_PENDING.",
"Only match jobs in terminal states: CANCELLED, DONE, or ERROR."
],
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Optional. The number of results to return in each response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query",
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs",
"response": {
"$ref": "ListJobsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates a job in a project.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"httpMethod": "PATCH",
"id": "dataproc.projects.regions.jobs.patch",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"parameters": {
"jobId": {
"description": "Required. The job ID.",
"location": "path",
"required": true,
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
},
"updateMask": {
"description": "Required. Specifies the path, relative to Job, of the field to update. For example, to update the labels of a Job the update_mask parameter would be specified as labels, and the PATCH request body would specify the new value. *Note:* Currently, labels is the only field that can be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}",
"request": {
"$ref": "Job"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"submit": {
"description": "Submits a job to a cluster.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.submit",
"parameterOrder": [
"projectId",
"region"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs:submit",
"request": {
"$ref": "SubmitJobRequest"
},
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"submitAsOperation": {
"description": "Submits job to a cluster.",
"flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.submitAsOperation",
"parameterOrder": [
"projectId",
"region"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"location": "path",
"required": true,
"type": "string"
},
"region": {
"description": "Required. The Dataproc region in which to handle the request.",
"location": "path",
"required": true,
"type": "string"
}
},
"path": "v1/projects/{projectId}/regions/{region}/jobs:submitAsOperation",
"request": {
"$ref": "SubmitJobRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/jobs/{jobsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.jobs.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/jobs/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"cancel": {
"description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
"httpMethod": "POST",
"id": "dataproc.projects.regions.operations.cancel",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:cancel",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.regions.operations.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "dataproc.projects.regions.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.operations.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations",
"httpMethod": "GET",
"id": "dataproc.projects.regions.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.operations.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.operations.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"workflowTemplates": {
"methods": {
"create": {
"description": "Creates new workflow template.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.create",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,create, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.create, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "DELETE",
"id": "dataproc.projects.regions.workflowTemplates.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.delete, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "GET",
"id": "dataproc.projects.regions.workflowTemplates.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.get, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
},
"version": {
"description": "Optional. The version of workflow template to retrieve. Only previously instantiated versions can be retrieved.If unspecified, retrieves the current version.",
"format": "int32",
"location": "query",
"type": "integer"
}
},
"path": "v1/{+name}",
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:getIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"instantiate": {
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.instantiate",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates.instantiate, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}:instantiate",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"instantiateInline": {
"description": "Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#workflowmetadata). Also see Using WorkflowMetadata (https://cloud.google.com/dataproc/docs/concepts/workflows/debugging#using_workflowmetadata).On successful completion, Operation.response will be Empty.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates:instantiateInline",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.instantiateInline",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,instantiateinline, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.instantiateinline, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"required": true,
"type": "string"
},
"requestId": {
"description": "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 (https://en.wikipedia.org/wiki/Universally_unique_identifier).The tag must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.",
"location": "query",
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates:instantiateInline",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists workflows that match the specified filter in the request.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"httpMethod": "GET",
"id": "dataproc.projects.regions.workflowTemplates.list",
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"description": "Optional. The maximum number of results to return in each response.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The resource name of the region or location, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates,list, the resource name of the region has the following format: projects/{project_id}/regions/{region} For projects.locations.workflowTemplates.list, the resource name of the location has the following format: projects/{project_id}/locations/{location}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+parent}/workflowTemplates",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:setIamPolicy",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:testIamPermissions",
"httpMethod": "POST",
"id": "dataproc.projects.regions.workflowTemplates.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"update": {
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
"flatPath": "v1/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"httpMethod": "PUT",
"id": "dataproc.projects.regions.workflowTemplates.update",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Output only. The resource name of the workflow template, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/regions/{region}/workflowTemplates/{template_id} For projects.locations.workflowTemplates, the resource name of the template has the following format: projects/{project_id}/locations/{location}/workflowTemplates/{template_id}",
"location": "path",
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v1/{+name}",
"request": {
"$ref": "WorkflowTemplate"
},
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20200917",
"rootUrl": "https://dataproc.googleapis.com/",
"schemas": {
"AcceleratorConfig": {
"description": "Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine (https://cloud.google.com/compute/docs/gpus/).",
"id": "AcceleratorConfig",
"properties": {
"acceleratorCount": {
"description": "The number of the accelerator cards of this type exposed to this instance.",
"format": "int32",
"type": "integer"
},
"acceleratorTypeUri": {
"description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes (https://cloud.google.com/compute/docs/reference/beta/acceleratorTypes).Examples: https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 nvidia-tesla-k80Auto Zone Exception: If you are using the Dataproc Auto Zone Placement (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/auto-zone#using_auto_zone_placement) feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.",
"type": "string"
}
},
"type": "object"
},
"AutoscalingConfig": {
"description": "Autoscaling Policy config associated with the cluster.",
"id": "AutoscalingConfig",
"properties": {
"policyUri": {
"description": "Optional. The autoscaling policy used by the cluster.Only resource names including projectid and location (region) are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id] projects/[project_id]/locations/[dataproc_region]/autoscalingPolicies/[policy_id]Note that the policy must be in the same project and Dataproc region.",
"type": "string"
}
},
"type": "object"
},
"AutoscalingPolicy": {
"description": "Describes an autoscaling policy for Dataproc cluster autoscaler.",
"id": "AutoscalingPolicy",
"properties": {
"basicAlgorithm": {
"$ref": "BasicAutoscalingAlgorithm"
},
"id": {
"description": "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.",
"type": "string"
},
"name": {
"description": "Output only. The \"resource name\" of the autoscaling policy, as described in https://cloud.google.com/apis/design/resource_names. For projects.regions.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/regions/{region}/autoscalingPolicies/{policy_id} For projects.locations.autoscalingPolicies, the resource name of the policy has the following format: projects/{project_id}/locations/{location}/autoscalingPolicies/{policy_id}",
"readOnly": true,
"type": "string"
},
"secondaryWorkerConfig": {
"$ref": "InstanceGroupAutoscalingPolicyConfig",
"description": "Optional. Describes how the autoscaler will operate for secondary workers."
},
"workerConfig": {
"$ref": "InstanceGroupAutoscalingPolicyConfig",
"description": "Required. Describes how the autoscaler will operate for primary workers."
}
},
"type": "object"
},
"BasicAutoscalingAlgorithm": {
"description": "Basic algorithm for autoscaling.",
"id": "BasicAutoscalingAlgorithm",
"properties": {
"cooldownPeriod": {
"description": "Optional. Duration between scaling events. A scaling period starts after the update operation from the previous event has completed.Bounds: 2m, 1d. Default: 2m.",
"format": "google-duration",
"type": "string"
},
"yarnConfig": {
"$ref": "BasicYarnAutoscalingConfig",
"description": "Required. YARN autoscaling configuration."
}
},
"type": "object"
},
"BasicYarnAutoscalingConfig": {
"description": "Basic autoscaling configurations for YARN.",
"id": "BasicYarnAutoscalingConfig",
"properties": {
"gracefulDecommissionTimeout": {
"description": "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.",
"format": "google-duration",
"type": "string"
},
"scaleDownFactor": {
"description": "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 (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.",
"format": "double",
"type": "number"
},
"scaleDownMinWorkerFraction": {
"description": "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.",
"format": "double",
"type": "number"
},
"scaleUpFactor": {
"description": "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 (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/autoscaling#how_autoscaling_works) for more information.Bounds: 0.0, 1.0.",
"format": "double",
"type": "number"
},
"scaleUpMinWorkerFraction": {
"description": "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.",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Binding": {
"description": "Associates members with a role.",
"id": "Binding",
"properties": {
"bindingId": {
"description": "A client-specified ID for this binding. Expected to be globally unique to support the internal bindings-by-ID API.",
"type": "string"
},
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.",
"type": "string"
}
},
"type": "object"
},
"CancelJobRequest": {
"description": "A request to cancel a job.",
"id": "CancelJobRequest",
"properties": {},
"type": "object"
},
"Cluster": {
"description": "Describes the identifying information, config, and status of a cluster of Compute Engine instances.",
"id": "Cluster",
"properties": {
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
"type": "string"
},
"clusterUuid": {
"description": "Output only. A cluster UUID (Unique Universal Identifier). Dataproc generates this value when it creates the cluster.",
"readOnly": true,
"type": "string"
},
"config": {
"$ref": "ClusterConfig",
"description": "Required. The cluster config. Note that Dataproc may set default values, and values may change when clusters are updated."
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.",
"type": "object"
},
"metrics": {
"$ref": "ClusterMetrics",
"description": "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.",
"readOnly": true
},
"projectId": {
"description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
"type": "string"
},
"status": {
"$ref": "ClusterStatus",
"description": "Output only. Cluster status.",
"readOnly": true
},
"statusHistory": {
"description": "Output only. The previous cluster status.",
"items": {
"$ref": "ClusterStatus"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ClusterConfig": {
"description": "The cluster config.",
"id": "ClusterConfig",
"properties": {
"autoscalingConfig": {
"$ref": "AutoscalingConfig",
"description": "Optional. Autoscaling config for the policy associated with the cluster. Cluster does not autoscale if this field is unset."
},
"configBucket": {
"description": "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 (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/staging-bucket)).",
"type": "string"
},
"encryptionConfig": {
"$ref": "EncryptionConfig",
"description": "Optional. Encryption settings for the cluster."
},
"endpointConfig": {
"$ref": "EndpointConfig",
"description": "Optional. Port/endpoint configuration for this cluster"
},
"gceClusterConfig": {
"$ref": "GceClusterConfig",
"description": "Optional. The shared Compute Engine config settings for all instances in a cluster."
},
"initializationActions": {
"description": "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 role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi ",
"items": {
"$ref": "NodeInitializationAction"
},
"type": "array"
},
"lifecycleConfig": {
"$ref": "LifecycleConfig",
"description": "Optional. Lifecycle setting for the cluster."
},
"masterConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for the master instance in a cluster."
},
"secondaryWorkerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for additional worker instances in a cluster."
},
"securityConfig": {
"$ref": "SecurityConfig",
"description": "Optional. Security settings for the cluster."
},
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "Optional. The config settings for software inside the cluster."
},
"tempBucket": {
"description": "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.",
"type": "string"
},
"workerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Compute Engine config settings for worker instances in a cluster."
}
},
"type": "object"
},
"ClusterMetrics": {
"description": "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.",
"id": "ClusterMetrics",
"properties": {
"hdfsMetrics": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
"description": "The HDFS metrics.",
"type": "object"
},
"yarnMetrics": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
"description": "The YARN metrics.",
"type": "object"
}
},
"type": "object"
},
"ClusterOperation": {
"description": "The cluster operation triggered by a workflow.",
"id": "ClusterOperation",
"properties": {
"done": {
"description": "Output only. Indicates the operation is done.",
"readOnly": true,
"type": "boolean"
},
"error": {
"description": "Output only. Error, if operation failed.",
"readOnly": true,
"type": "string"
},
"operationId": {
"description": "Output only. The id of the cluster operation.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ClusterOperationMetadata": {
"description": "Metadata describing the operation.",
"id": "ClusterOperationMetadata",
"properties": {
"clusterName": {
"description": "Output only. Name of the cluster for the operation.",
"readOnly": true,
"type": "string"
},
"clusterUuid": {
"description": "Output only. Cluster UUID for the operation.",
"readOnly": true,
"type": "string"
},
"description": {
"description": "Output only. Short description of operation.",
"readOnly": true,
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Output only. Labels associated with the operation",
"readOnly": true,
"type": "object"
},
"operationType": {
"description": "Output only. The operation type.",
"readOnly": true,
"type": "string"
},
"status": {
"$ref": "ClusterOperationStatus",
"description": "Output only. Current operation status.",
"readOnly": true
},
"statusHistory": {
"description": "Output only. The previous operation status.",
"items": {
"$ref": "ClusterOperationStatus"
},
"readOnly": true,
"type": "array"
},
"warnings": {
"description": "Output only. Errors encountered during operation execution.",
"items": {
"type": "string"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
},
"ClusterOperationStatus": {
"description": "The status of the operation.",
"id": "ClusterOperationStatus",
"properties": {
"details": {
"description": "Output only. A message containing any operation metadata details.",
"readOnly": true,
"type": "string"
},
"innerState": {
"description": "Output only. A message containing the detailed operation state.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. A message containing the operation state.",
"enum": [
"UNKNOWN",
"PENDING",
"RUNNING",
"DONE"
],
"enumDescriptions": [
"Unused.",
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
],
"readOnly": true,
"type": "string"
},
"stateStartTime": {
"description": "Output only. The time this state was entered.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"ClusterSelector": {
"description": "A selector that chooses target cluster for jobs based on metadata.",
"id": "ClusterSelector",
"properties": {
"clusterLabels": {
"additionalProperties": {
"type": "string"
},
"description": "Required. The cluster labels. Cluster must have all labels to match.",
"type": "object"
},
"zone": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"ClusterStatus": {
"description": "The status of a cluster and its instances.",
"id": "ClusterStatus",
"properties": {
"detail": {
"description": "Optional. Output only. Details of cluster's state.",
"readOnly": true,
"type": "string"
},
"state": {
"description": "Output only. The cluster's state.",
"enum": [
"UNKNOWN",
"CREATING",
"RUNNING",
"ERROR",
"DELETING",
"UPDATING"
],
"enumDescriptions": [
"The cluster state is unknown.",
"The cluster is being created and set up. It is not ready for use.",
"The cluster is currently running and healthy. It is ready for use.",
"The cluster encountered an error. It is not ready for use.",
"The cluster is being deleted. It cannot be used.",
"The cluster is being updated. It continues to accept and process jobs."
],
"readOnly": true,
"type": "string"
},
"stateStartTime": {
"description": "Output only. Time when this state was entered (see JSON representation of Timestamp (https://developers.google.com/protocol-buffers/docs/proto3#json)).",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"substate": {
"description": "Output only. Additional state information that includes status reported by the agent.",
"enum": [
"UNSPECIFIED",
"UNHEALTHY",
"STALE_STATUS"
],
"enumDescriptions": [
"The cluster substate is unknown.",
"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.",
"The agent-reported status is out of date (may occur if Dataproc loses communication with Agent).Applies to RUNNING state."
],
"readOnly": true,
"type": "string"
}
},