openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 96.5 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"Manages Hadoop-based clusters and jobs on Google Cloud Platform.","title":"Cloud Dataproc","version":"v1","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-logo":{"url":"https://www.google.com/images/branding/googlelogo/2x/googlelogo_color_272x92dp.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://dataproc.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"dataproc"},"externalDocs":{"url":"https://cloud.google.com/dataproc/"},"tags":[{"name":"projects"}],"paths":{"/v1/projects/{projectId}/regions/{region}/clusters":{"get":{"description":"Lists all regions/{region}/clusters in a project.","operationId":"dataproc.projects.regions.clusters.list","parameters":[{"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 = *","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Optional. The standard List page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The standard List page token.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListClustersResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates a cluster in a project.","operationId":"dataproc.projects.regions.clusters.create","parameters":[{"description":"Required. The ID of the Google Cloud Platform project that the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Optional. A unique id used to identify the request. If the server receives two CreateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Cluster"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}":{"delete":{"description":"Deletes a cluster in a project.","operationId":"dataproc.projects.regions.clusters.delete","parameters":[{"description":"Required. The cluster name.","in":"path","name":"clusterName","required":true,"schema":{"type":"string"}},{"description":"Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.","in":"query","name":"clusterUuid","schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Optional. A unique id used to identify the request. If the server receives two DeleteClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.","in":"query","name":"requestId","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the resource representation for a cluster in a project.","operationId":"dataproc.projects.regions.clusters.get","parameters":[{"description":"Required. The cluster name.","in":"path","name":"clusterName","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Cluster"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates a cluster in a project.","operationId":"dataproc.projects.regions.clusters.patch","parameters":[{"description":"Required. The cluster name.","in":"path","name":"clusterName","required":true,"schema":{"type":"string"}},{"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.","in":"query","name":"gracefulDecommissionTimeout","schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Optional. A unique id used to identify the request. If the server receives two UpdateClusterRequest requests with the same id, then the second request will be ignored and the first google.longrunning.Operation created and stored in the backend is returned.It is recommended to always set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The id must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.","in":"query","name":"requestId","schema":{"type":"string"}},{"description":"Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\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 update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n<strong>Note:</strong> Currently, only the following fields can be updated:<table> <tbody> <tr> <td><strong>Mask</strong></td> <td><strong>Purpose</strong></td> </tr> <tr> <td><strong><em>labels</em></strong></td> <td>Update labels</td> </tr> <tr> <td><strong><em>config.worker_config.num_instances</em></strong></td> <td>Resize primary worker group</td> </tr> <tr> <td><strong><em>config.secondary_worker_config.num_instances</em></strong></td> <td>Resize secondary worker group</td> </tr> </tbody> </table>","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Cluster"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.","operationId":"dataproc.projects.regions.clusters.diagnose","parameters":[{"description":"Required. The cluster name.","in":"path","name":"clusterName","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the cluster belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DiagnoseClusterRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/projects/{projectId}/regions/{region}/jobs":{"get":{"description":"Lists regions/{region}/jobs in a project.","operationId":"dataproc.projects.regions.jobs.list","parameters":[{"description":"Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.","in":"query","name":"clusterName","schema":{"type":"string"}},{"description":"Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *","in":"query","name":"filter","schema":{"type":"string"}},{"description":"Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.","in":"query","name":"jobStateMatcher","schema":{"type":"string","enum":["ALL","ACTIVE","NON_ACTIVE"]}},{"description":"Optional. The number of results to return in each response.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The page token, returned by a previous call, to request the next page of results.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListJobsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}]},"/v1/projects/{projectId}/regions/{region}/jobs/{jobId}":{"delete":{"description":"Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.","operationId":"dataproc.projects.regions.jobs.delete","parameters":[{"description":"Required. The job ID.","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the resource representation for a job in a project.","operationId":"dataproc.projects.regions.jobs.get","parameters":[{"description":"Required. The job ID.","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"patch":{"description":"Updates a job in a project.","operationId":"dataproc.projects.regions.jobs.patch","parameters":[{"description":"Required. The job ID.","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}},{"description":"Required. Specifies the path, relative to <code>Job</code>, of the field to update. For example, to update the labels of a Job the <code>update_mask</code> parameter would be specified as <code>labels</code>, and the PATCH request body would specify the new value. <strong>Note:</strong> Currently, <code>labels</code> is the only field that can be updated.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.","operationId":"dataproc.projects.regions.jobs.cancel","parameters":[{"description":"Required. The job ID.","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelJobRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/projects/{projectId}/regions/{region}/jobs:submit":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Submits a job to a cluster.","operationId":"dataproc.projects.regions.jobs.submit","parameters":[{"description":"Required. The ID of the Google Cloud Platform project that the job belongs to.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Required. The Cloud Dataproc region in which to handle the request.","in":"path","name":"region","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitJobRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}":{"delete":{"description":"Deletes a workflow template. It does not cancel in-progress workflows.","operationId":"dataproc.projects.locations.workflowTemplates.delete","parameters":[{"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}","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.","in":"query","name":"version","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.","operationId":"dataproc.projects.locations.workflowTemplates.get","parameters":[{"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}","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"description":"The standard list page size.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"The standard list page token.","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.","in":"query","name":"version","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"put":{"description":"Updates (replaces) workflow template. The updated template must contain version that matches the current server version.","operationId":"dataproc.projects.locations.workflowTemplates.update","parameters":[{"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}","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/WorkflowTemplate"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:cancel":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"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.","operationId":"dataproc.projects.regions.operations.cancel","parameters":[{"description":"The name of the operation resource to be cancelled.","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Empty"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:instantiate":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.","operationId":"dataproc.projects.locations.workflowTemplates.instantiate","parameters":[{"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}","in":"path","name":"name","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstantiateWorkflowTemplateRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/workflowTemplates":{"get":{"description":"Lists workflows that match the specified filter in the request.","operationId":"dataproc.projects.locations.workflowTemplates.list","parameters":[{"description":"Optional. The maximum number of results to return in each response.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Optional. The page token, returned by a previous call, to request the next page of results.","in":"query","name":"pageToken","schema":{"type":"string"}},{"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}","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListWorkflowTemplatesResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Creates new workflow template.","operationId":"dataproc.projects.locations.workflowTemplates.create","parameters":[{"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}","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/WorkflowTemplate"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/workflowTemplates:instantiateInline":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Instantiates a template and begins execution.This method is equivalent to executing the sequence CreateWorkflowTemplate, InstantiateWorkflowTemplate, DeleteWorkflowTemplate.The returned Operation can be used to track execution of workflow by polling operations.get. The Operation will complete when entire workflow is finished.The running workflow can be aborted via operations.cancel. This will cause any inflight jobs to be cancelled and workflow-owned clusters to be deleted.The Operation.metadata will be WorkflowMetadata.On successful completion, Operation.response will be Empty.","operationId":"dataproc.projects.locations.workflowTemplates.instantiateInline","parameters":[{"description":"Required. The \"resource name\" of the workflow template region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}","in":"path","name":"parent","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}},{"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.","in":"query","name":"requestId","schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/WorkflowTemplate"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Operation"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:getIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.","operationId":"dataproc.projects.locations.workflowTemplates.getIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:setIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"description":"Sets the access control policy on the specified resource. Replaces any existing policy.","operationId":"dataproc.projects.locations.workflowTemplates.setIamPolicy","parameters":[{"description":"REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Policy"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:testIamPermissions":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/uploadType"},{"$ref":"#/components/parameters/upload_protocol"}],"post":{"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.","operationId":"dataproc.projects.locations.workflowTemplates.testIamPermissions","parameters":[{"description":"REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.","in":"path","name":"resource","required":true,"x-reservedExpansion":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"servers":[{"url":"https://dataproc.googleapis.com/"}],"components":{"parameters":{"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"type":"string","enum":["json","media","proto"],"default":"json"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}},"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"type":"string","enum":["1","2"]}}},"requestBodies":{"Cluster":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cluster"}}}},"WorkflowTemplate":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkflowTemplate"}}}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services"}}}}},"schemas":{"AcceleratorConfig":{"description":"Specifies the type and number of accelerator cards attached to the instances of an instance. See GPUs on Compute Engine.","properties":{"acceleratorCount":{"description":"The number of the accelerator cards of this type exposed to this instance.","format":"int32","type":"integer"},"acceleratorTypeUri":{"description":"Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Compute Engine AcceleratorTypes.Examples:\nhttps://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80\nprojects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80\nnvidia-tesla-k80Auto Zone Exception: If you are using the Cloud Dataproc Auto Zone Placement feature, you must use the short name of the accelerator type resource, for example, nvidia-tesla-k80.","type":"string"}},"type":"object"},"Binding":{"description":"Associates members with a role.","properties":{"condition":{"$ref":"#/components/schemas/Expr"},"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 .\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.","type":"string"}},"type":"object"},"CancelJobRequest":{"description":"A request to cancel a job.","properties":{},"type":"object"},"Cluster":{"description":"Describes the identifying information, config, and status of a cluster of Compute Engine instances.","properties":{"clusterName":{"description":"Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.","type":"string"},"clusterUuid":{"description":"Output only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.","type":"string"},"config":{"$ref":"#/components/schemas/ClusterConfig"},"labels":{"additionalProperties":{"type":"string"},"description":"Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.","type":"object"},"metrics":{"$ref":"#/components/schemas/ClusterMetrics"},"projectId":{"description":"Required. The Google Cloud Platform project ID that the cluster belongs to.","type":"string"},"status":{"$ref":"#/components/schemas/ClusterStatus"},"statusHistory":{"description":"Output only. The previous cluster status.","items":{"$ref":"#/components/schemas/ClusterStatus"},"type":"array"}},"type":"object"},"ClusterConfig":{"description":"The cluster config.","properties":{"configBucket":{"description":"Optional. A 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"},"encryptionConfig":{"$ref":"#/components/schemas/EncryptionConfig"},"gceClusterConfig":{"$ref":"#/components/schemas/GceClusterConfig"},"initializationActions":{"description":"Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n","items":{"$ref":"#/components/schemas/NodeInitializationAction"},"type":"array"},"masterConfig":{"$ref":"#/components/schemas/InstanceGroupConfig"},"secondaryWorkerConfig":{"$ref":"#/components/schemas/InstanceGroupConfig"},"softwareConfig":{"$ref":"#/components/schemas/SoftwareConfig"},"workerConfig":{"$ref":"#/components/schemas/InstanceGroupConfig"}},"type":"object"},"ClusterMetrics":{"description":"Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.","properties":{"hdfsMetrics":{"additionalProperties":{"format":"int64","type":"string"},"description":"The HDFS metrics.","type":"object"},"yarnMetrics":{"additionalProperties":{"format":"int64","type":"string"},"description":"The YARN metrics.","type":"object"}},"type":"object"},"ClusterOperation":{"description":"The cluster operation triggered by a workflow.","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"}},"type":"object"},"ClusterOperationMetadata":{"description":"Metadata describing the operation.","properties":{"clusterName":{"description":"Output only. Name of the cluster for the operation.","type":"string"},"clusterUuid":{"description":"Output only. Cluster UUID for the operation.","type":"string"},"description":{"description":"Output only. Short description of operation.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Output only. Labels associated with the operation","type":"object"},"operationType":{"description":"Output only. The operation type.","type":"string"},"status":{"$ref":"#/components/schemas/ClusterOperationStatus"},"statusHistory":{"description":"Output only. The previous operation status.","items":{"$ref":"#/components/schemas/ClusterOperationStatus"},"type":"array"},"warnings":{"description":"Output only. Errors encountered during operation execution.","items":{"type":"string"},"type":"array"}},"type":"object"},"ClusterOperationStatus":{"description":"The status of the operation.","properties":{"details":{"description":"Output only. A message containing any operation metadata details.","type":"string"},"innerState":{"description":"Output only. A message containing the detailed operation state.","type":"string"},"state":{"description":"Output only. A message containing the operation state.","enum":["UNKNOWN","PENDING","RUNNING","DONE"],"type":"string"},"stateStartTime":{"description":"Output only. The time this state was entered.","format":"google-datetime","type":"string"}},"type":"object"},"ClusterSelector":{"description":"A selector that chooses target cluster for jobs based on metadata.","properties":{"clusterLabels":{"additionalProperties":{"type":"string"},"description":"Required. The cluster labels. Cluster must have all labels to match.","type":"object"},"zone":{"description":"Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.","type":"string"}},"type":"object"},"ClusterStatus":{"description":"The status of a cluster and its instances.","properties":{"detail":{"description":"Output only. Optional details of cluster's state.","type":"string"},"state":{"description":"Output only. The cluster's state.","enum":["UNKNOWN","CREATING","RUNNING","ERROR","DELETING","UPDATING"],"type":"string"},"stateStartTime":{"description":"Output only. Time when this state was entered.","format":"google-datetime","type":"string"},"substate":{"description":"Output only. Additional state information that includes status reported by the agent.","enum":["UNSPECIFIED","UNHEALTHY","STALE_STATUS"],"type":"string"}},"type":"object"},"DiagnoseClusterRequest":{"description":"A request to collect cluster diagnostic information.","properties":{},"type":"object"},"DiagnoseClusterResults":{"description":"The location of diagnostic output.","properties":{"outputUri":{"description":"Output only. The Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.","type":"string"}},"type":"object"},"DiskConfig":{"description":"Specifies the config of disk options for a group of VM instances.","properties":{"bootDiskSizeGb":{"description":"Optional. Size in GB of the boot disk (default is 500GB).","format":"int32","type":"integer"},"bootDiskType":{"description":"Optional. Type of the boot disk (default is \"pd-standard\"). Valid values: \"pd-ssd\" (Persistent Disk Solid State Drive) or \"pd-standard\" (Persistent Disk Hard Disk Drive).","type":"string"},"numLocalSsds":{"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.","format":"int32","type":"integer"}},"type":"object"},"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