Google Git
Sign in
code / google-api-go-client / 9e2045da407b8bc1df9bc5c14d4d1a7e7e182e05 / . / dataproc / v1beta2 / dataproc-api.json
blob: 6f9ade864ac04d51fc41d38cf21c7d1d29a4fd4a [file] [log] [blame]
{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "View and manage your data across Google Cloud Platform services"
}
}
}
},
"servicePath": "",
"description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
"kind": "discovery#restDescription",
"rootUrl": "https://dataproc.googleapis.com/",
"basePath": "",
"ownerDomain": "google.com",
"name": "dataproc",
"batchPath": "batch",
"revision": "20171010",
"documentationLink": "https://cloud.google.com/dataproc/",
"id": "dataproc:v1beta2",
"title": "Google Cloud Dataproc API",
"discoveryVersion": "v1",
"ownerName": "Google",
"version_module": true,
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"workflowTemplates": {
"methods": {
"instantiate": {
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
},
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"id": "dataproc.projects.locations.workflowTemplates.instantiate",
"path": "v1beta2/{+name}:instantiate"
},
"get": {
"id": "dataproc.projects.locations.workflowTemplates.get",
"path": "v1beta2/{+name}",
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"response": {
"$ref": "WorkflowTemplate"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"version": {
"location": "query",
"format": "int32",
"description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
"type": "integer"
},
"name": {
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}"
},
"update": {
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.locations.workflowTemplates.update",
"request": {
"$ref": "WorkflowTemplate"
},
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
"httpMethod": "PUT",
"parameterOrder": [
"name"
],
"response": {
"$ref": "WorkflowTemplate"
}
},
"delete": {
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
},
"version": {
"location": "query",
"format": "int32",
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}",
"id": "dataproc.projects.locations.workflowTemplates.delete",
"path": "v1beta2/{+name}"
},
"list": {
"description": "Lists workflows that match the specified filter in the request.",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The maximum number of results to return in each response.",
"type": "integer"
},
"parent": {
"location": "path",
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"id": "dataproc.projects.locations.workflowTemplates.list",
"path": "v1beta2/{+parent}/workflowTemplates"
},
"create": {
"request": {
"$ref": "WorkflowTemplate"
},
"description": "Creates new workflow template.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"location": "path",
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates",
"path": "v1beta2/{+parent}/workflowTemplates",
"id": "dataproc.projects.locations.workflowTemplates.create"
}
}
}
}
},
"regions": {
"resources": {
"workflowTemplates": {
"methods": {
"instantiate": {
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"parameters": {
"name": {
"location": "path",
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate",
"id": "dataproc.projects.regions.workflowTemplates.instantiate",
"path": "v1beta2/{+name}:instantiate",
"description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.",
"request": {
"$ref": "InstantiateWorkflowTemplateRequest"
}
},
"get": {
"description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.",
"httpMethod": "GET",
"response": {
"$ref": "WorkflowTemplate"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
},
"version": {
"location": "query",
"format": "int32",
"description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.regions.workflowTemplates.get"
},
"update": {
"request": {
"$ref": "WorkflowTemplate"
},
"description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.",
"httpMethod": "PUT",
"parameterOrder": [
"name"
],
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"location": "path",
"description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.regions.workflowTemplates.update"
},
"delete": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.regions.workflowTemplates.delete",
"description": "Deletes a workflow template. It does not cancel in-progress workflows.",
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"version": {
"format": "int32",
"description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.",
"type": "integer",
"location": "query"
},
"name": {
"description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists workflows that match the specified filter in the request.",
"response": {
"$ref": "ListWorkflowTemplatesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The maximum number of results to return in each response.",
"type": "integer"
},
"parent": {
"pattern": "^projects/[^/]+/regions/[^/]+$",
"location": "path",
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"id": "dataproc.projects.regions.workflowTemplates.list",
"path": "v1beta2/{+parent}/workflowTemplates"
},
"create": {
"request": {
"$ref": "WorkflowTemplate"
},
"description": "Creates new workflow template.",
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "WorkflowTemplate"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"parent": {
"description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates",
"path": "v1beta2/{+parent}/workflowTemplates",
"id": "dataproc.projects.regions.workflowTemplates.create"
}
}
},
"clusters": {
"methods": {
"list": {
"description": "Lists all regions/{region}/clusters in a project.",
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"region"
],
"response": {
"$ref": "ListClustersResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"filter": {
"location": "query",
"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 = *",
"type": "string"
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
},
"pageToken": {
"location": "query",
"description": "Optional. The standard List page token.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The standard List page size.",
"type": "integer"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"id": "dataproc.projects.regions.clusters.list"
},
"setIamPolicy": {
"request": {
"$ref": "SetIamPolicyRequest"
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$",
"location": "path",
"description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy",
"id": "dataproc.projects.regions.clusters.setIamPolicy",
"path": "v1beta2/{+resource}:setIamPolicy"
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region"
],
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters",
"id": "dataproc.projects.regions.clusters.create",
"request": {
"$ref": "Cluster"
},
"description": "Creates a cluster in a project."
},
"getIamPolicy": {
"id": "dataproc.projects.regions.clusters.getIamPolicy",
"path": "v1beta2/{+resource}: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.",
"response": {
"$ref": "Policy"
},
"httpMethod": "GET",
"parameterOrder": [
"resource"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy"
},
"get": {
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"id": "dataproc.projects.regions.clusters.get",
"description": "Gets the resource representation for a cluster in a project.",
"httpMethod": "GET",
"response": {
"$ref": "Cluster"
},
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"parameters": {
"clusterName": {
"location": "path",
"description": "Required. The cluster name.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true
},
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"clusterName": {
"location": "path",
"description": "Required. The cluster name.",
"type": "string",
"required": true
},
"gracefulDecommissionTimeout": {
"type": "string",
"location": "query",
"format": "google-duration",
"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.Only supported on Dataproc image versions 1.2 and higher."
},
"projectId": {
"type": "string",
"required": true,
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project the cluster belongs to."
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|",
"type": "string"
},
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"id": "dataproc.projects.regions.clusters.patch",
"description": "Updates a cluster in a project.",
"request": {
"$ref": "Cluster"
}
},
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"parameterOrder": [
"resource"
],
"httpMethod": "POST",
"parameters": {
"resource": {
"location": "path",
"description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions",
"id": "dataproc.projects.regions.clusters.testIamPermissions",
"path": "v1beta2/{+resource}: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.",
"request": {
"$ref": "TestIamPermissionsRequest"
}
},
"diagnose": {
"description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.",
"request": {
"$ref": "DiagnoseClusterRequest"
},
"httpMethod": "POST",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"clusterName": {
"description": "Required. The cluster name.",
"type": "string",
"required": true,
"location": "path"
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose",
"id": "dataproc.projects.regions.clusters.diagnose"
},
"delete": {
"description": "Deletes a cluster in a project.",
"httpMethod": "DELETE",
"parameterOrder": [
"projectId",
"region",
"clusterName"
],
"response": {
"$ref": "Operation"
},
"parameters": {
"clusterUuid": {
"type": "string",
"location": "query",
"description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist."
},
"clusterName": {
"description": "Required. The cluster name.",
"type": "string",
"required": true,
"location": "path"
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.",
"type": "string",
"required": true
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}",
"id": "dataproc.projects.regions.clusters.delete"
}
}
},
"operations": {
"methods": {
"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.",
"response": {
"$ref": "Operation"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"id": "dataproc.projects.regions.operations.get",
"path": "v1beta2/{+name}"
},
"list": {
"response": {
"$ref": "ListOperationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"filter": {
"description": "The standard list filter.",
"type": "string",
"location": "query"
},
"pageToken": {
"description": "The standard list page token.",
"type": "string",
"location": "query"
},
"name": {
"pattern": "^projects/[^/]+/regions/[^/]+/operations$",
"location": "path",
"description": "The name of the operation's parent resource.",
"type": "string",
"required": true
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations",
"id": "dataproc.projects.regions.operations.list",
"path": "v1beta2/{+name}",
"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."
},
"cancel": {
"httpMethod": "POST",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"parameters": {
"name": {
"description": "The name of the operation resource to be cancelled.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel",
"path": "v1beta2/{+name}:cancel",
"id": "dataproc.projects.regions.operations.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."
},
"delete": {
"flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}",
"path": "v1beta2/{+name}",
"id": "dataproc.projects.regions.operations.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.",
"httpMethod": "DELETE",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource to be deleted.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$",
"location": "path"
}
},
"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 or regions/{region}/jobs.get.",
"request": {
"$ref": "CancelJobRequest"
},
"response": {
"$ref": "Job"
},
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"httpMethod": "POST",
"parameters": {
"jobId": {
"description": "Required. The job ID.",
"type": "string",
"required": true,
"location": "path"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel",
"id": "dataproc.projects.regions.jobs.cancel",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel"
},
"patch": {
"request": {
"$ref": "Job"
},
"description": "Updates a job in a project.",
"httpMethod": "PATCH",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"jobId": {
"location": "path",
"description": "Required. The job ID.",
"type": "string",
"required": true
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.",
"type": "string"
},
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.patch"
},
"get": {
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"response": {
"$ref": "Job"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"jobId": {
"location": "path",
"description": "Required. The job ID.",
"type": "string",
"required": true
},
"projectId": {
"location": "path",
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true
},
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.get",
"description": "Gets the resource representation for a job in a project."
},
"submit": {
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
"id": "dataproc.projects.regions.jobs.submit",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit",
"description": "Submits a job to a cluster.",
"request": {
"$ref": "SubmitJobRequest"
},
"response": {
"$ref": "Job"
},
"parameterOrder": [
"projectId",
"region"
],
"httpMethod": "POST",
"parameters": {
"region": {
"location": "path",
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"projectId",
"region",
"jobId"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"jobId": {
"location": "path",
"description": "Required. The job ID.",
"type": "string",
"required": true
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"id": "dataproc.projects.regions.jobs.delete",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}",
"description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION."
},
"list": {
"response": {
"$ref": "ListJobsResponse"
},
"httpMethod": "GET",
"parameterOrder": [
"projectId",
"region"
],
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"clusterName": {
"description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.",
"type": "string",
"location": "query"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string",
"required": true,
"location": "path"
},
"filter": {
"location": "query",
"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 INACTIVE. 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 = *",
"type": "string"
},
"jobStateMatcher": {
"location": "query",
"enum": [
"ALL",
"ACTIVE",
"NON_ACTIVE"
],
"description": "Optional. Specifies enumerated categories of jobs to list (default = match ALL jobs).",
"type": "string"
},
"pageToken": {
"description": "Optional. The page token, returned by a previous call, to request the next page of results.",
"type": "string",
"location": "query"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Optional. The number of results to return in each response.",
"type": "integer"
},
"region": {
"description": "Required. The Cloud Dataproc region in which to handle the request.",
"type": "string",
"required": true,
"location": "path"
}
},
"flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs",
"id": "dataproc.projects.regions.jobs.list",
"path": "v1beta2/projects/{projectId}/regions/{region}/jobs",
"description": "Lists regions/{region}/jobs in a project."
}
}
}
}
}
}
}
},
"parameters": {
"quotaUser": {
"location": "query",
"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.",
"type": "string"
},
"pp": {
"description": "Pretty-print response.",
"default": "true",
"type": "boolean",
"location": "query"
},
"bearer_token": {
"type": "string",
"location": "query",
"description": "OAuth bearer token."
},
"oauth_token": {
"location": "query",
"description": "OAuth 2.0 token for the current user.",
"type": "string"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"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",
"description": "Data format for response.",
"default": "json"
},
"key": {
"type": "string",
"location": "query",
"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."
},
"access_token": {
"type": "string",
"location": "query",
"description": "OAuth access token."
}
},
"schemas": {
"SetIamPolicyRequest": {
"description": "Request message for SetIamPolicy method.",
"type": "object",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them."
}
},
"id": "SetIamPolicyRequest"
},
"HiveJob": {
"description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.",
"type": "object",
"properties": {
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
"queryList": {
"description": "A list of queries.",
"$ref": "QueryList"
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains Hive queries.",
"type": "string"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.",
"items": {
"type": "string"
},
"type": "array"
},
"scriptVariables": {
"description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"properties": {
"description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.",
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"id": "HiveJob"
},
"WorkflowGraph": {
"description": "The workflow graph.",
"type": "object",
"properties": {
"nodes": {
"description": "Output only. The workflow nodes.",
"items": {
"$ref": "WorkflowNode"
},
"type": "array"
}
},
"id": "WorkflowGraph"
},
"DiagnoseClusterResults": {
"properties": {
"outputUri": {
"type": "string",
"description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics."
}
},
"id": "DiagnoseClusterResults",
"description": "The location of diagnostic output.",
"type": "object"
},
"ClusterConfig": {
"description": "The cluster config.",
"type": "object",
"properties": {
"secondaryWorkerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster."
},
"lifecycleConfig": {
"$ref": "LifecycleConfig",
"description": "Optional. The config setting for auto delete cluster schedule."
},
"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 \u003ccode\u003erole\u003c/code\u003e metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n",
"items": {
"$ref": "NodeInitializationAction"
},
"type": "array"
},
"configBucket": {
"description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.",
"type": "string"
},
"workerConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Google Compute Engine config settings for worker instances in a cluster."
},
"gceClusterConfig": {
"description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.",
"$ref": "GceClusterConfig"
},
"softwareConfig": {
"$ref": "SoftwareConfig",
"description": "Optional. The config settings for software inside the cluster."
},
"masterConfig": {
"$ref": "InstanceGroupConfig",
"description": "Optional. The Google Compute Engine config settings for the master instance in a cluster."
}
},
"id": "ClusterConfig"
},
"PySparkJob": {
"properties": {
"jarFileUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks."
},
"loggingConfig": {
"$ref": "LoggingConfig",
"description": "Optional. The runtime log config for job execution."
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"type": "object"
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
"type": "string"
},
"type": "array"
},
"fileUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks."
},
"pythonFileUris": {
"description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"mainPythonFileUri": {
"description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.",
"type": "string"
},
"archiveUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip."
}
},
"id": "PySparkJob",
"description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.",
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for TestIamPermissions method.",
"type": "object",
"properties": {
"permissions": {
"description": "The set of permissions to check for the resource. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "TestIamPermissionsRequest"
},
"AcceleratorConfig": {
"description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).",
"type": "object",
"properties": {
"acceleratorCount": {
"format": "int32",
"description": "The number of the accelerator cards of this type exposed to this instance.",
"type": "integer"
},
"acceleratorTypeUri": {
"description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /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-k80",
"type": "string"
}
},
"id": "AcceleratorConfig"
},
"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.",
"type": "object",
"properties": {
"yarnMetrics": {
"additionalProperties": {
"format": "int64",
"type": "string"
},
"description": "The YARN metrics.",
"type": "object"
},
"hdfsMetrics": {
"description": "The HDFS metrics.",
"type": "object",
"additionalProperties": {
"format": "int64",
"type": "string"
}
}
},
"id": "ClusterMetrics"
},
"LoggingConfig": {
"type": "object",
"properties": {
"driverLogLevels": {
"additionalProperties": {
"enum": [
"LEVEL_UNSPECIFIED",
"ALL",
"TRACE",
"DEBUG",
"INFO",
"WARN",
"ERROR",
"FATAL",
"OFF"
],
"type": "string"
},
"description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'",
"type": "object"
}
},
"id": "LoggingConfig",
"description": "The runtime logging config of the job."
},
"OrderedJob": {
"type": "object",
"properties": {
"scheduling": {
"$ref": "JobScheduling",
"description": "Optional. Job scheduling configuration."
},
"stepId": {
"description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job workflow-step-id label, and in prerequisite_step_ids field from other steps.",
"type": "string"
},
"pigJob": {
"description": "Job is a Pig job.",
"$ref": "PigJob"
},
"hadoopJob": {
"$ref": "HadoopJob",
"description": "Job is a Hadoop job."
},
"prerequisiteStepIds": {
"description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.",
"items": {
"type": "string"
},
"type": "array"
},
"hiveJob": {
"description": "Job is a Hive job.",
"$ref": "HiveJob"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job."
},
"sparkJob": {
"description": "Job is a Spark job.",
"$ref": "SparkJob"
},
"sparkSqlJob": {
"$ref": "SparkSqlJob",
"description": "Job is a SparkSql job."
},
"pysparkJob": {
"description": "Job is a Pyspark job.",
"$ref": "PySparkJob"
}
},
"id": "OrderedJob"
},
"WorkflowNode": {
"id": "WorkflowNode",
"description": "The workflow node.",
"type": "object",
"properties": {
"state": {
"enum": [
"NODE_STATUS_UNSPECIFIED",
"BLOCKED",
"RUNNABLE",
"RUNNING",
"COMPLETED",
"FAILED"
],
"description": "Output only. The node state.",
"type": "string",
"enumDescriptions": [
"",
"The node is awaiting prerequisite node to finish.",
"The node is runnable but not running.",
"The node is running.",
"The node completed successfully.",
"The node failed. A node can be marked FAILED because its ancestor or peer failed."
]
},
"error": {
"description": "Output only. The error detail.",
"type": "string"
},
"stepId": {
"description": "Output only. The name of the node.",
"type": "string"
},
"jobId": {
"description": "Output only. The job id; populated after the node enters RUNNING state.",
"type": "string"
},
"prerequisiteStepIds": {
"description": "Output only. Node's prerequisite nodes.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"InstantiateWorkflowTemplateRequest": {
"description": "A request to instantiate a workflow template.",
"type": "object",
"properties": {
"version": {
"format": "int32",
"description": "Optional. The version of workflow template to instantiate. If specified, the workflow will be instantiated only if the current version of the workflow template has the supplied version.This option cannot be used to instantiate a previous version of workflow template.",
"type": "integer"
},
"instanceId": {
"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.",
"type": "string"
}
},
"id": "InstantiateWorkflowTemplateRequest"
},
"SubmitJobRequest": {
"type": "object",
"properties": {
"job": {
"$ref": "Job",
"description": "Required. The job resource."
}
},
"id": "SubmitJobRequest",
"description": "A request to submit a job."
},
"JobScheduling": {
"description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.",
"type": "object",
"properties": {
"maxFailuresPerHour": {
"format": "int32",
"description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.",
"type": "integer"
}
},
"id": "JobScheduling"
},
"Cluster": {
"type": "object",
"properties": {
"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": {
"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.",
"$ref": "ClusterMetrics"
},
"status": {
"$ref": "ClusterStatus",
"description": "Output-only. Cluster status."
},
"statusHistory": {
"description": "Output-only. The previous cluster status.",
"items": {
"$ref": "ClusterStatus"
},
"type": "array"
},
"config": {
"$ref": "ClusterConfig",
"description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
},
"clusterUuid": {
"description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
"type": "string"
},
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.",
"type": "string"
},
"projectId": {
"description": "Required. The Google Cloud Platform project ID that the cluster belongs to.",
"type": "string"
}
},
"id": "Cluster",
"description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances."
},
"TestIamPermissionsResponse": {
"id": "TestIamPermissionsResponse",
"description": "Response message for TestIamPermissions method.",
"type": "object",
"properties": {
"permissions": {
"description": "A subset of TestPermissionsRequest.permissions that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
}
},
"SoftwareConfig": {
"id": "SoftwareConfig",
"description": "Specifies the selection and config of software inside the cluster.",
"type": "object",
"properties": {
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.",
"type": "object"
},
"imageVersion": {
"description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).",
"type": "string"
}
}
},
"ClusterSelector": {
"description": "A selector that chooses target cluster for jobs based on metadata.",
"type": "object",
"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"
}
},
"id": "ClusterSelector"
},
"WorkflowTemplatePlacement": {
"description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.",
"type": "object",
"properties": {
"clusterSelector": {
"$ref": "ClusterSelector",
"description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted."
},
"managedCluster": {
"description": "Optional. A cluster that is managed by the workflow.",
"$ref": "ManagedCluster"
}
},
"id": "WorkflowTemplatePlacement"
},
"ClusterOperation": {
"type": "object",
"properties": {
"done": {
"description": "Output only. Indicates the operation is done.",
"type": "boolean"
},
"error": {
"description": "Output only. Error, if operation failed.",
"type": "string"
},
"operationId": {
"description": "Output only. The id of the cluster operation.",
"type": "string"
}
},
"id": "ClusterOperation"
},
"WorkflowMetadata": {
"description": "A Cloud Dataproc workflow template resource.",
"type": "object",
"properties": {
"clusterName": {
"type": "string",
"description": "Output only. The name of the managed cluster."
},
"createCluster": {
"$ref": "ClusterOperation",
"description": "Output only. The create cluster operation metadata."
},
"graph": {
"$ref": "WorkflowGraph",
"description": "Output only. The workflow graph."
},
"version": {
"format": "int32",
"description": "Output only. The version of template at the time of workflow instantiation.",
"type": "integer"
},
"template": {
"description": "Output only. The \"resource name\" of the template.",
"type": "string"
},
"deleteCluster": {
"$ref": "ClusterOperation",
"description": "Output only. The delete cluster operation metadata."
},
"state": {
"description": "Output only. The workflow state.",
"type": "string",
"enumDescriptions": [
"Unused.",
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
],
"enum": [
"UNKNOWN",
"PENDING",
"RUNNING",
"DONE"
]
}
},
"id": "WorkflowMetadata"
},
"SparkJob": {
"description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.",
"type": "object",
"properties": {
"mainJarFileUri": {
"description": "The HCFS URI of the jar file that contains the main class.",
"type": "string"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.",
"items": {
"type": "string"
},
"type": "array"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"properties": {
"description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"args": {
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.",
"items": {
"type": "string"
},
"type": "array"
},
"fileUris": {
"description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.",
"items": {
"type": "string"
},
"type": "array"
},
"mainClass": {
"description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.",
"type": "string"
},
"archiveUris": {
"description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "SparkJob"
},
"JobStatus": {
"description": "Cloud Dataproc job status.",
"type": "object",
"properties": {
"substate": {
"description": "Output-only. Additional state information, which includes status reported by the agent.",
"type": "string",
"enumDescriptions": [
"",
"The Job is submitted to the agent.Applies to RUNNING state.",
"The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.",
"The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state."
],
"enum": [
"UNSPECIFIED",
"SUBMITTED",
"QUEUED",
"STALE_STATUS"
]
},
"stateStartTime": {
"format": "google-datetime",
"description": "Output-only. The time when this state was entered.",
"type": "string"
},
"details": {
"description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.",
"type": "string"
},
"state": {
"enum": [
"STATE_UNSPECIFIED",
"PENDING",
"SETUP_DONE",
"RUNNING",
"CANCEL_PENDING",
"CANCEL_STARTED",
"CANCELLED",
"DONE",
"ERROR",
"ATTEMPT_FAILURE"
],
"description": "Output-only. A state message specifying the overall job state.",
"type": "string",
"enumDescriptions": [
"The job state is unknown.",
"The job is pending; it has been submitted, but is not yet running.",
"Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.",
"The job is running on the cluster.",
"A CancelJob request has been received, but is pending.",
"Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.",
"The job cancellation was successful.",
"The job has completed successfully.",
"The job has completed, but encountered an error.",
"Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only."
]
}
},
"id": "JobStatus"
},
"DiagnoseClusterRequest": {
"description": "A request to collect cluster diagnostic information.",
"type": "object",
"properties": {},
"id": "DiagnoseClusterRequest"
},
"DiskConfig": {
"properties": {
"bootDiskSizeGb": {
"format": "int32",
"description": "Optional. Size in GB of the boot disk (default is 500GB).",
"type": "integer"
},
"numLocalSsds": {
"format": "int32",
"description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.",
"type": "integer"
}
},
"id": "DiskConfig",
"description": "Specifies the config of disk options for a group of VM instances.",
"type": "object"
},
"ClusterOperationMetadata": {
"description": "Metadata describing the operation.",
"type": "object",
"properties": {
"description": {
"description": "Output-only. Short description of operation.",
"type": "string"
},
"warnings": {
"description": "Output-only. Errors encountered during operation execution.",
"items": {
"type": "string"
},
"type": "array"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Output-only. Labels associated with the operation",
"type": "object"
},
"status": {
"$ref": "ClusterOperationStatus",
"description": "Output-only. Current operation status."
},
"statusHistory": {
"description": "Output-only. The previous operation status.",
"items": {
"$ref": "ClusterOperationStatus"
},
"type": "array"
},
"clusterName": {
"description": "Output-only. Name of the cluster for the operation.",
"type": "string"
},
"clusterUuid": {
"description": "Output-only. Cluster UUID for the operation.",
"type": "string"
},
"operationType": {
"description": "Output-only. The operation type.",
"type": "string"
}
},
"id": "ClusterOperationMetadata"
},
"Empty": {
"description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.",
"type": "object",
"properties": {},
"id": "Empty"
},
"GceClusterConfig": {
"description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.",
"type": "object",
"properties": {
"internalIpOnly": {
"type": "boolean",
"description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses."
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).",
"type": "object"
},
"serviceAccountScopes": {
"description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control",
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"description": "The Google Compute Engine tags to add to all instances (see Tagging instances).",
"items": {
"type": "string"
},
"type": "array"
},
"serviceAccount": {
"description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com",
"type": "string"
},
"subnetworkUri": {
"description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0",
"type": "string"
},
"networkUri": {
"type": "string",
"description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault"
},
"zoneUri": {
"description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f",
"type": "string"
}
},
"id": "GceClusterConfig"
},
"Policy": {
"properties": {
"etag": {
"format": "byte",
"description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.",
"type": "string"
},
"version": {
"type": "integer",
"format": "int32",
"description": "Version of the Policy. The default version is 0."
},
"bindings": {
"description": "Associates a list of members to a role. bindings with no members will result in an error.",
"items": {
"$ref": "Binding"
},
"type": "array"
}
},
"id": "Policy",
"description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.Example\n{\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n}\nFor a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam).",
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"type": "object",
"properties": {
"done": {
"description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.",
"type": "boolean"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should have the format of operations/some/unique/name.",
"type": "string"
},
"error": {
"description": "The error result of the operation in case of failure or cancellation.",
"$ref": "Status"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
"type": "object"
}
},
"id": "Operation"
},
"ListWorkflowTemplatesResponse": {
"properties": {
"templates": {
"description": "Output only. WorkflowTemplates list.",
"items": {
"$ref": "WorkflowTemplate"
},
"type": "array"
},
"nextPageToken": {
"description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListWorkflowTemplatesRequest\u003c/code\u003e.",
"type": "string"
}
},
"id": "ListWorkflowTemplatesResponse",
"description": "A response to a request to list workflow templates in a project.",
"type": "object"
},
"JobReference": {
"description": "Encapsulates the full scoping used to reference a job.",
"type": "object",
"properties": {
"jobId": {
"description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.",
"type": "string"
},
"projectId": {
"description": "Required. The ID of the Google Cloud Platform project that the job belongs to.",
"type": "string"
}
},
"id": "JobReference"
},
"Status": {
"description": "The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). The error model is designed to be:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe Status message contains three pieces of data: error code, error message, and error details. The error code should be an enum value of google.rpc.Code, but it may accept additional error codes if needed. The error message should be a developer-facing English message that helps developers understand and resolve the error. If a localized user-facing error message is needed, put the localized message in the error details or localize it in the client. The optional error details may contain arbitrary information about the error. There is a predefined set of error detail types in the package google.rpc that can be used for common error conditions.Language mappingThe Status message is the logical representation of the error model, but it is not necessarily the actual wire format. When the Status message is exposed in different client libraries and different wire protocols, it can be mapped differently. For example, it will likely be mapped to some exceptions in Java, but more likely mapped to some error codes in C.Other usesThe error model and the Status message can be used in a variety of environments, either with or without APIs, to provide a consistent developer experience across different environments.Example uses of this error model include:\nPartial errors. If a service needs to return partial errors to the client, it may embed the Status in the normal response to indicate the partial errors.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch operations. If a client uses batch request and batch response, the Status message should be used directly inside batch response, one for each error sub-response.\nAsynchronous operations. If an API call embeds asynchronous operation results in its response, the status of those operations should be represented directly using the Status message.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.",
"type": "object",
"properties": {
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"code": {
"format": "int32",
"description": "The status code, which should be an enum value of google.rpc.Code.",
"type": "integer"
},
"message": {
"description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
"type": "string"
}
},
"id": "Status"
},
"Binding": {
"description": "Associates members with a role.",
"type": "object",
"properties": {
"members": {
"description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name 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. Required",
"type": "string"
}
},
"id": "Binding"
},
"InstanceGroupConfig": {
"description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.",
"type": "object",
"properties": {
"accelerators": {
"description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.",
"items": {
"$ref": "AcceleratorConfig"
},
"type": "array"
},
"numInstances": {
"format": "int32",
"description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.",
"type": "integer"
},
"diskConfig": {
"$ref": "DiskConfig",
"description": "Optional. Disk option config settings."
},
"managedGroupConfig": {
"$ref": "ManagedGroupConfig",
"description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups."
},
"isPreemptible": {
"description": "Optional. Specifies that this instance group contains preemptible instances.",
"type": "boolean"
},
"imageUri": {
"description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.",
"type": "string"
},
"machineTypeUri": {
"description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2",
"type": "string"
},
"instanceNames": {
"description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "InstanceGroupConfig"
},
"NodeInitializationAction": {
"properties": {
"executionTimeout": {
"format": "google-duration",
"description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.",
"type": "string"
},
"executableFile": {
"description": "Required. Google Cloud Storage URI of executable file.",
"type": "string"
}
},
"id": "NodeInitializationAction",
"description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.",
"type": "object"
},
"ListJobsResponse": {
"description": "A list of jobs in a project.",
"type": "object",
"properties": {
"jobs": {
"description": "Output-only. Jobs list.",
"items": {
"$ref": "Job"
},
"type": "array"
},
"nextPageToken": {
"description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.",
"type": "string"
}
},
"id": "ListJobsResponse"
},
"CancelJobRequest": {
"id": "CancelJobRequest",
"description": "A request to cancel a job.",
"type": "object",
"properties": {}
},
"SparkSqlJob": {
"description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.",
"type": "object",
"properties": {
"queryFileUri": {
"description": "The HCFS URI of the script that contains SQL queries.",
"type": "string"
},
"queryList": {
"$ref": "QueryList",
"description": "A list of queries."
},
"scriptVariables": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).",
"type": "object"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.",
"items": {
"type": "string"
},
"type": "array"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.",
"type": "object"
}
},
"id": "SparkSqlJob"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
}
},
"id": "ListOperationsResponse"
},
"JobPlacement": {
"description": "Cloud Dataproc job config.",
"type": "object",
"properties": {
"clusterUuid": {
"description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.",
"type": "string"
},
"clusterName": {
"description": "Required. The name of the cluster where the job will be submitted.",
"type": "string"
}
},
"id": "JobPlacement"
},
"PigJob": {
"properties": {
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.",
"type": "object"
},
"continueOnFailure": {
"description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.",
"type": "boolean"
},
"queryList": {
"$ref": "QueryList",
"description": "A list of queries."
},
"queryFileUri": {
"description": "The HCFS URI of the script that contains the Pig queries.",
"type": "string"
},
"jarFileUris": {
"description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.",
"items": {
"type": "string"
},
"type": "array"
},
"scriptVariables": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).",
"type": "object"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
}
},
"id": "PigJob",
"description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.",
"type": "object"
},
"ClusterStatus": {
"id": "ClusterStatus",
"description": "The status of a cluster and its instances.",
"type": "object",
"properties": {
"substate": {
"enum": [
"UNSPECIFIED",
"UNHEALTHY",
"STALE_STATUS"
],
"description": "Output-only. Additional state information that includes status reported by the agent.",
"type": "string",
"enumDescriptions": [
"",
"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 Cloud Dataproc loses communication with Agent).Applies to RUNNING state."
]
},
"stateStartTime": {
"format": "google-datetime",
"description": "Output-only. Time when this state was entered.",
"type": "string"
},
"detail": {
"description": "Output-only. Optional details of cluster's state.",
"type": "string"
},
"state": {
"description": "Output-only. The cluster's state.",
"type": "string",
"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."
],
"enum": [
"UNKNOWN",
"CREATING",
"RUNNING",
"ERROR",
"DELETING",
"UPDATING"
]
}
}
},
"WorkflowTemplate": {
"description": "A Cloud Dataproc workflow template resource.",
"type": "object",
"properties": {
"jobs": {
"description": "Required. The Directed Acyclic Graph of Jobs to submit.",
"items": {
"$ref": "OrderedJob"
},
"type": "array"
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.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 template."
},
"createTime": {
"format": "google-datetime",
"description": "Output only. The time template was created.",
"type": "string"
},
"placement": {
"$ref": "WorkflowTemplatePlacement",
"description": "Required. WorkflowTemplate scheduling information."
},
"updateTime": {
"format": "google-datetime",
"description": "Output only. The time template was last updated.",
"type": "string"
},
"name": {
"description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}",
"type": "string"
},
"id": {
"description": "Required. The template id.",
"type": "string"
},
"version": {
"type": "integer",
"format": "int32",
"description": "Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request."
}
},
"id": "WorkflowTemplate"
},
"ListClustersResponse": {
"description": "The list of all clusters in a project.",
"type": "object",
"properties": {
"nextPageToken": {
"description": "Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e.",
"type": "string"
},
"clusters": {
"description": "Output-only. The clusters in the project.",
"items": {
"$ref": "Cluster"
},
"type": "array"
}
},
"id": "ListClustersResponse"
},
"Job": {
"id": "Job",
"description": "A Cloud Dataproc job resource.",
"type": "object",
"properties": {
"hiveJob": {
"$ref": "HiveJob",
"description": "Job is a Hive job."
},
"labels": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this job. 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 job."
},
"driverOutputResourceUri": {
"description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.",
"type": "string"
},
"statusHistory": {
"description": "Output-only. The previous job status.",
"items": {
"$ref": "JobStatus"
},
"type": "array"
},
"sparkSqlJob": {
"$ref": "SparkSqlJob",
"description": "Job is a SparkSql job."
},
"sparkJob": {
"$ref": "SparkJob",
"description": "Job is a Spark job."
},
"yarnApplications": {
"description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"items": {
"$ref": "YarnApplication"
},
"type": "array"
},
"pysparkJob": {
"$ref": "PySparkJob",
"description": "Job is a Pyspark job."
},
"reference": {
"description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.",
"$ref": "JobReference"
},
"hadoopJob": {
"description": "Job is a Hadoop job.",
"$ref": "HadoopJob"
},
"status": {
"$ref": "JobStatus",
"description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields."
},
"placement": {
"$ref": "JobPlacement",
"description": "Required. Job information, including how, when, and where to run the job."
},
"driverControlFilesUri": {
"description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.",
"type": "string"
},
"scheduling": {
"$ref": "JobScheduling",
"description": "Optional. Job scheduling configuration."
},
"pigJob": {
"$ref": "PigJob",
"description": "Job is a Pig job."
}
}
},
"LifecycleConfig": {
"description": "Specifies the cluster auto delete related schedule configuration.",
"type": "object",
"properties": {
"autoDeleteTime": {
"format": "google-datetime",
"description": "Optional. The time when cluster will be auto-deleted.",
"type": "string"
},
"idleDeleteTtl": {
"format": "google-duration",
"description": "Optional. The longest duration that cluster would keep alive while staying idle; passing this threshold will cause cluster to be auto-deleted.",
"type": "string"
},
"autoDeleteTtl": {
"format": "google-duration",
"description": "Optional. The life duration of cluster, the cluster will be auto-deleted at the end of this duration.",
"type": "string"
}
},
"id": "LifecycleConfig"
},
"ManagedGroupConfig": {
"description": "Specifies the resources used to actively manage an instance group.",
"type": "object",
"properties": {
"instanceGroupManagerName": {
"description": "Output-only. The name of the Instance Group Manager for this group.",
"type": "string"
},
"instanceTemplateName": {
"description": "Output-only. The name of the Instance Template used for the Managed Instance Group.",
"type": "string"
}
},
"id": "ManagedGroupConfig"
},
"ManagedCluster": {
"description": "Cluster that is managed by the workflow.",
"type": "object",
"properties": {
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. The labels to associate with this cluster.Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given cluster.",
"type": "object"
},
"config": {
"description": "Required. The cluster configuration.",
"$ref": "ClusterConfig"
},
"clusterName": {
"description": "Required. The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.",
"type": "string"
}
},
"id": "ManagedCluster"
},
"ClusterOperationStatus": {
"type": "object",
"properties": {
"details": {
"description": "Output-only.A message containing any operation metadata details.",
"type": "string"
},
"state": {
"enumDescriptions": [
"Unused.",
"The operation has been created.",
"The operation is running.",
"The operation is done; either cancelled or completed."
],
"enum": [
"UNKNOWN",
"PENDING",
"RUNNING",
"DONE"
],
"description": "Output-only. A message containing the operation state.",
"type": "string"
},
"innerState": {
"description": "Output-only. A message containing the detailed operation state.",
"type": "string"
},
"stateStartTime": {
"format": "google-datetime",
"description": "Output-only. The time this state was entered.",
"type": "string"
}
},
"id": "ClusterOperationStatus",
"description": "The status of the operation."
},
"YarnApplication": {
"description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.",
"type": "object",
"properties": {
"state": {
"enumDescriptions": [
"Status is unspecified.",
"Status is NEW.",
"Status is NEW_SAVING.",
"Status is SUBMITTED.",
"Status is ACCEPTED.",
"Status is RUNNING.",
"Status is FINISHED.",
"Status is FAILED.",
"Status is KILLED."
],
"enum": [
"STATE_UNSPECIFIED",
"NEW",
"NEW_SAVING",
"SUBMITTED",
"ACCEPTED",
"RUNNING",
"FINISHED",
"FAILED",
"KILLED"
],
"description": "Required. The application state.",
"type": "string"
},
"name": {
"description": "Required. The application name.",
"type": "string"
},
"trackingUrl": {
"description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.",
"type": "string"
},
"progress": {
"format": "float",
"description": "Required. The numerical progress of the application, from 1 to 100.",
"type": "number"
}
},
"id": "YarnApplication"
},
"QueryList": {
"properties": {
"queries": {
"description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "QueryList",
"description": "A list of queries to run on a cluster.",
"type": "object"
},
"HadoopJob": {
"description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).",
"type": "object",
"properties": {
"archiveUris": {
"description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.",
"items": {
"type": "string"
},
"type": "array"
},
"mainJarFileUri": {
"description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'",
"type": "string"
},
"jarFileUris": {
"description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.",
"items": {
"type": "string"
},
"type": "array"
},
"loggingConfig": {
"description": "Optional. The runtime log config for job execution.",
"$ref": "LoggingConfig"
},
"properties": {
"additionalProperties": {
"type": "string"
},
"description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.",
"type": "object"
},
"args": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission."
},
"fileUris": {
"items": {
"type": "string"
},
"type": "array",
"description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks."
},
"mainClass": {
"description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.",
"type": "string"
}
},
"id": "HadoopJob"
}
},
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"protocol": "rest",
"version": "v1beta2",
"baseUrl": "https://dataproc.googleapis.com/"
}