Index: discovery/googleapis/dataproc__v1.json |
diff --git a/discovery/googleapis/dataproc__v1.json b/discovery/googleapis/dataproc__v1.json |
index b1300f6a665d1450458921523fedccc1f811e8a0..c48ecd5018c9d2df507c894facbdf09bd4e7a90a 100644 |
--- a/discovery/googleapis/dataproc__v1.json |
+++ b/discovery/googleapis/dataproc__v1.json |
@@ -11,10 +11,9 @@ |
"basePath": "", |
"baseUrl": "https://dataproc.googleapis.com/", |
"batchPath": "batch", |
- "description": "An API for managing Hadoop-based clusters and jobs on Google Cloud Platform.", |
+ "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", |
"discoveryVersion": "v1", |
"documentationLink": "https://cloud.google.com/dataproc/", |
- "etag": "\"tbys6C40o18GZwyMen5GMkdK-3s/UWIx0i13luZLKjW6gmDu2evUqDA\"", |
"icons": { |
"x16": "http://www.google.com/images/icons/product/search-16.gif", |
"x32": "http://www.google.com/images/icons/product/search-32.gif" |
@@ -25,24 +24,37 @@ |
"ownerDomain": "google.com", |
"ownerName": "Google", |
"parameters": { |
- "access_token": { |
- "description": "OAuth access token.", |
+ "upload_protocol": { |
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
- "alt": { |
- "default": "json", |
- "description": "Data format for response.", |
- "enumDescriptions": [ |
- "Responses with Content-Type of application/json", |
- "Media download with context-dependent Content-Type", |
- "Responses with Content-Type of application/x-protobuf" |
- ], |
+ "prettyPrint": { |
+ "default": "true", |
+ "description": "Returns response with indentations and line breaks.", |
+ "location": "query", |
+ "type": "boolean" |
+ }, |
+ "uploadType": { |
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
"location": "query", |
"type": "string" |
}, |
- "bearer_token": { |
- "description": "OAuth bearer token.", |
+ "fields": { |
+ "description": "Selector specifying which fields to include in a partial response.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "$.xgafv": { |
+ "description": "V1 error format.", |
+ "enum": [ |
+ "1", |
+ "2" |
+ ], |
+ "enumDescriptions": [ |
+ "v1 error format", |
+ "v2 error format" |
+ ], |
"location": "query", |
"type": "string" |
}, |
@@ -51,8 +63,19 @@ |
"location": "query", |
"type": "string" |
}, |
- "fields": { |
- "description": "Selector specifying which fields to include in a partial response.", |
+ "alt": { |
+ "default": "json", |
+ "description": "Data format for response.", |
+ "enum": [ |
+ "json", |
+ "media", |
+ "proto" |
+ ], |
+ "enumDescriptions": [ |
+ "Responses with Content-Type of application/json", |
+ "Media download with context-dependent Content-Type", |
+ "Responses with Content-Type of application/x-protobuf" |
+ ], |
"location": "query", |
"type": "string" |
}, |
@@ -61,44 +84,29 @@ |
"location": "query", |
"type": "string" |
}, |
- "oauth_token": { |
- "description": "OAuth 2.0 token for the current user.", |
+ "access_token": { |
+ "description": "OAuth access token.", |
"location": "query", |
"type": "string" |
}, |
- "pp": { |
- "default": "true", |
- "description": "Pretty-print response.", |
- "location": "query", |
- "type": "boolean" |
- }, |
- "prettyPrint": { |
- "default": "true", |
- "description": "Returns response with indentations and line breaks.", |
- "location": "query", |
- "type": "boolean" |
- }, |
"quotaUser": { |
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", |
"location": "query", |
"type": "string" |
}, |
- "upload_protocol": { |
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", |
+ "pp": { |
+ "default": "true", |
+ "description": "Pretty-print response.", |
"location": "query", |
- "type": "string" |
+ "type": "boolean" |
}, |
- "uploadType": { |
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", |
+ "oauth_token": { |
+ "description": "OAuth 2.0 token for the current user.", |
"location": "query", |
"type": "string" |
}, |
- "$.xgafv": { |
- "description": "V1 error format.", |
- "enumDescriptions": [ |
- "v1 error format", |
- "v2 error format" |
- ], |
+ "bearer_token": { |
+ "description": "OAuth bearer token.", |
"location": "query", |
"type": "string" |
} |
@@ -111,74 +119,75 @@ |
"resources": { |
"clusters": { |
"methods": { |
- "create": { |
- "description": "Creates a cluster in a project.", |
- "httpMethod": "POST", |
- "id": "dataproc.projects.regions.clusters.create", |
+ "list": { |
+ "description": "Lists all regions/{region}/clusters in a project.", |
+ "httpMethod": "GET", |
+ "id": "dataproc.projects.regions.clusters.list", |
"parameterOrder": [ |
"projectId", |
"region" |
], |
"parameters": { |
+ "pageToken": { |
+ "description": "Optional The standard List page token.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Optional The standard List page size.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "filter": { |
+ "description": "Optional A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1/projects/{projectId}/regions/{region}/clusters", |
- "request": { |
- "$ref": "Cluster" |
- }, |
"response": { |
- "$ref": "Operation" |
+ "$ref": "ListClustersResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "patch": { |
- "description": "Updates a cluster in a project.", |
- "httpMethod": "PATCH", |
- "id": "dataproc.projects.regions.clusters.patch", |
+ "create": { |
+ "description": "Creates a cluster in a project.", |
+ "httpMethod": "POST", |
+ "id": "dataproc.projects.regions.clusters.create", |
"parameterOrder": [ |
"projectId", |
- "region", |
- "clusterName" |
+ "region" |
], |
"parameters": { |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project the cluster belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "clusterName": { |
- "description": "[Required] The cluster name.", |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
- }, |
- "updateMask": { |
- "description": "[Required] Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the `PATCH` request body would specify the new value, as follows: { \"config\":{ \"workerConfig\":{ \"numInstances\":\"5\" } } } Similarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the `PATCH` request body would be set as follows: { \"config\":{ \"secondaryWorkerConfig\":{ \"numInstances\":\"5\" } } } Note: Currently, config.worker_config.num_instances and config.secondary_worker_config.num_instances are the only fields that can be updated.", |
- "location": "query", |
- "type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", |
+ "path": "v1/projects/{projectId}/regions/{region}/clusters", |
"request": { |
"$ref": "Cluster" |
}, |
@@ -189,10 +198,10 @@ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "delete": { |
- "description": "Deletes a cluster in a project.", |
- "httpMethod": "DELETE", |
- "id": "dataproc.projects.regions.clusters.delete", |
+ "get": { |
+ "description": "Gets the resource representation for a cluster in a project.", |
+ "httpMethod": "GET", |
+ "id": "dataproc.projects.regions.clusters.get", |
"parameterOrder": [ |
"projectId", |
"region", |
@@ -200,19 +209,19 @@ |
], |
"parameters": { |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"clusterName": { |
- "description": "[Required] The cluster name.", |
+ "description": "Required The cluster name.", |
"location": "path", |
"required": true, |
"type": "string" |
@@ -220,128 +229,128 @@ |
}, |
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", |
"response": { |
- "$ref": "Operation" |
+ "$ref": "Cluster" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "get": { |
- "description": "Gets the resource representation for a cluster in a project.", |
- "httpMethod": "GET", |
- "id": "dataproc.projects.regions.clusters.get", |
+ "patch": { |
+ "description": "Updates a cluster in a project.", |
+ "httpMethod": "PATCH", |
+ "id": "dataproc.projects.regions.clusters.patch", |
"parameterOrder": [ |
"projectId", |
"region", |
"clusterName" |
], |
"parameters": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", |
+ "clusterName": { |
+ "description": "Required The cluster name.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "clusterName": { |
- "description": "[Required] The cluster name.", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "updateMask": { |
+ "description": "Required Specifies the path, relative to <code>Cluster</code>, of the field to update. For example, to change the number of workers in a cluster to 5, the <code>update_mask</code> parameter would be specified as <code>config.worker_config.num_instances</code>, 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 <code>update_mask</code> parameter would be <code>config.secondary_worker_config.num_instances</code>, 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, <code>config.worker_config.num_instances</code> and <code>config.secondary_worker_config.num_instances</code> are the only fields that can be updated.", |
+ "format": "google-fieldmask", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", |
- "response": { |
+ "request": { |
"$ref": "Cluster" |
}, |
+ "response": { |
+ "$ref": "Operation" |
+ }, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "list": { |
- "description": "Lists all regions/{region}/clusters in a project.", |
- "httpMethod": "GET", |
- "id": "dataproc.projects.regions.clusters.list", |
+ "diagnose": { |
+ "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.", |
+ "httpMethod": "POST", |
+ "id": "dataproc.projects.regions.clusters.diagnose", |
"parameterOrder": [ |
"projectId", |
- "region" |
+ "region", |
+ "clusterName" |
], |
"parameters": { |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
"region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "filter": { |
- "description": "[Optional] A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax: field:value [field:value] ... or 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 valid filters are: status.state:ACTIVE clusterName:mycluster labels.env:staging \\ labels.starred:* and status.state = ACTIVE AND clusterName = mycluster \\ AND labels.env = staging AND labels.starred = *", |
- "location": "query", |
- "type": "string" |
- }, |
- "pageSize": { |
- "description": "[Optional] The standard List page size.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- }, |
- "pageToken": { |
- "description": "[Optional] The standard List page token.", |
- "location": "query", |
+ "clusterName": { |
+ "description": "Required The cluster name.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/clusters", |
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", |
+ "request": { |
+ "$ref": "DiagnoseClusterRequest" |
+ }, |
"response": { |
- "$ref": "ListClustersResponse" |
+ "$ref": "Operation" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "diagnose": { |
- "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains `DiagnoseClusterOutputLocation`.", |
- "httpMethod": "POST", |
- "id": "dataproc.projects.regions.clusters.diagnose", |
+ "delete": { |
+ "description": "Deletes a cluster in a project.", |
+ "httpMethod": "DELETE", |
+ "id": "dataproc.projects.regions.clusters.delete", |
"parameterOrder": [ |
"projectId", |
"region", |
"clusterName" |
], |
"parameters": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.", |
+ "clusterName": { |
+ "description": "Required The cluster name.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the cluster belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "clusterName": { |
- "description": "[Required] The cluster name.", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", |
- "request": { |
- "$ref": "DiagnoseClusterRequest" |
- }, |
+ "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", |
"response": { |
"$ref": "Operation" |
}, |
@@ -351,141 +360,126 @@ |
} |
} |
}, |
- "jobs": { |
+ "operations": { |
"methods": { |
- "submit": { |
- "description": "Submits a job to a cluster.", |
+ "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.", |
"httpMethod": "POST", |
- "id": "dataproc.projects.regions.jobs.submit", |
+ "id": "dataproc.projects.regions.operations.cancel", |
"parameterOrder": [ |
- "projectId", |
- "region" |
+ "name" |
], |
"parameters": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "name": { |
+ "description": "The name of the operation resource to be cancelled.", |
"location": "path", |
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", |
- "request": { |
- "$ref": "SubmitJobRequest" |
- }, |
+ "path": "v1/{+name}:cancel", |
"response": { |
- "$ref": "Job" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "get": { |
- "description": "Gets the resource representation for a job in a project.", |
- "httpMethod": "GET", |
- "id": "dataproc.projects.regions.jobs.get", |
+ "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", |
+ "id": "dataproc.projects.regions.operations.delete", |
"parameterOrder": [ |
- "projectId", |
- "region", |
- "jobId" |
+ "name" |
], |
"parameters": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "jobId": { |
- "description": "[Required] The job ID.", |
+ "name": { |
+ "description": "The name of the operation resource to be deleted.", |
"location": "path", |
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", |
+ "path": "v1/{+name}", |
"response": { |
- "$ref": "Job" |
+ "$ref": "Empty" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
"list": { |
- "description": "Lists regions/{region}/jobs in a project.", |
+ "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 below allows API services to override the binding to use different resource name schemes, such as users/*/operations.", |
"httpMethod": "GET", |
- "id": "dataproc.projects.regions.jobs.list", |
+ "id": "dataproc.projects.regions.operations.list", |
"parameterOrder": [ |
- "projectId", |
- "region" |
+ "name" |
], |
"parameters": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
- "location": "path", |
- "required": true, |
- "type": "string" |
- }, |
"pageSize": { |
- "description": "[Optional] The number of results to return in each response.", |
+ "description": "The standard list page size.", |
"format": "int32", |
"location": "query", |
"type": "integer" |
}, |
- "pageToken": { |
- "description": "[Optional] The page token, returned by a previous call, to request the next page of results.", |
- "location": "query", |
- "type": "string" |
- }, |
- "clusterName": { |
- "description": "[Optional] If set, the returned jobs list includes only jobs that were submitted to the named cluster.", |
+ "filter": { |
+ "description": "The standard list filter.", |
"location": "query", |
"type": "string" |
}, |
- "jobStateMatcher": { |
- "description": "[Optional] Specifies enumerated categories of jobs to list (default = match ALL jobs).", |
- "enum": [ |
- "ALL", |
- "ACTIVE", |
- "NON_ACTIVE" |
- ], |
- "location": "query", |
+ "name": { |
+ "description": "The name of the operation collection.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations$", |
+ "required": true, |
"type": "string" |
}, |
- "filter": { |
- "description": "[Optional] A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax: field:value] ... or [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 valid filters are: status.state:ACTIVE labels.env:staging labels.starred:* and status.state = ACTIVE AND labels.env = staging AND labels.starred = *", |
+ "pageToken": { |
+ "description": "The standard list page token.", |
"location": "query", |
"type": "string" |
} |
}, |
- "path": "v1/projects/{projectId}/regions/{region}/jobs", |
+ "path": "v1/{+name}", |
"response": { |
- "$ref": "ListJobsResponse" |
+ "$ref": "ListOperationsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
+ "get": { |
+ "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
+ "httpMethod": "GET", |
+ "id": "dataproc.projects.regions.operations.get", |
+ "parameterOrder": [ |
+ "name" |
+ ], |
+ "parameters": { |
+ "name": { |
+ "description": "The name of the operation resource.", |
+ "location": "path", |
+ "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
+ "required": true, |
+ "type": "string" |
+ } |
+ }, |
+ "path": "v1/{+name}", |
+ "response": { |
+ "$ref": "Operation" |
+ }, |
+ "scopes": [ |
+ "https://www.googleapis.com/auth/cloud-platform" |
+ ] |
+ } |
+ } |
+ }, |
+ "jobs": { |
+ "methods": { |
"cancel": { |
- "description": "Starts a job cancellation request. To access the job resource after cancellation, call [regions/{region}/jobs.list](/dataproc/reference/rest/v1/projects.regions.jobs/list) or [regions/{region}/jobs.get](/dataproc/reference/rest/v1/projects.regions.jobs/get).", |
+ "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.", |
"httpMethod": "POST", |
"id": "dataproc.projects.regions.jobs.cancel", |
"parameterOrder": [ |
@@ -495,19 +489,19 @@ |
], |
"parameters": { |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "jobId": { |
+ "description": "Required The job ID.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "jobId": { |
- "description": "[Required] The job ID.", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
@@ -524,10 +518,10 @@ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "delete": { |
- "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns `FAILED_PRECONDITION`.", |
- "httpMethod": "DELETE", |
- "id": "dataproc.projects.regions.jobs.delete", |
+ "patch": { |
+ "description": "Updates a job in a project.", |
+ "httpMethod": "PATCH", |
+ "id": "dataproc.projects.regions.jobs.patch", |
"parameterOrder": [ |
"projectId", |
"region", |
@@ -535,117 +529,141 @@ |
], |
"parameters": { |
"projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "region": { |
- "description": "[Required] The Cloud Dataproc region in which to handle the request.", |
+ "jobId": { |
+ "description": "Required The job ID.", |
"location": "path", |
"required": true, |
"type": "string" |
}, |
- "jobId": { |
- "description": "[Required] The job ID.", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
"required": true, |
"type": "string" |
+ }, |
+ "updateMask": { |
+ "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.", |
+ "format": "google-fieldmask", |
+ "location": "query", |
+ "type": "string" |
} |
}, |
"path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", |
+ "request": { |
+ "$ref": "Job" |
+ }, |
"response": { |
- "$ref": "Empty" |
+ "$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
- } |
- } |
- }, |
- "operations": { |
- "methods": { |
- "list": { |
- "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding below allows API services to override the binding to use different resource name schemes, such as `users/*/operations`.", |
+ }, |
+ "get": { |
+ "description": "Gets the resource representation for a job in a project.", |
"httpMethod": "GET", |
- "id": "dataproc.projects.regions.operations.list", |
+ "id": "dataproc.projects.regions.jobs.get", |
"parameterOrder": [ |
- "name" |
+ "projectId", |
+ "region", |
+ "jobId" |
], |
"parameters": { |
- "name": { |
- "description": "The name of the operation collection.", |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
"location": "path", |
- "pattern": "^projects/[^/]+/regions/[^/]+/operations$", |
"required": true, |
"type": "string" |
}, |
- "filter": { |
- "description": "The standard list filter.", |
- "location": "query", |
+ "jobId": { |
+ "description": "Required The job ID.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
}, |
- "pageSize": { |
- "description": "The standard list page size.", |
- "format": "int32", |
- "location": "query", |
- "type": "integer" |
- }, |
- "pageToken": { |
- "description": "The standard list page token.", |
- "location": "query", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
+ "location": "path", |
+ "required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", |
"response": { |
- "$ref": "ListOperationsResponse" |
+ "$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "get": { |
- "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", |
- "httpMethod": "GET", |
- "id": "dataproc.projects.regions.operations.get", |
+ "submit": { |
+ "description": "Submits a job to a cluster.", |
+ "httpMethod": "POST", |
+ "id": "dataproc.projects.regions.jobs.submit", |
"parameterOrder": [ |
- "name" |
+ "projectId", |
+ "region" |
], |
"parameters": { |
- "name": { |
- "description": "The name of the operation resource.", |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
"location": "path", |
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", |
+ "request": { |
+ "$ref": "SubmitJobRequest" |
+ }, |
"response": { |
- "$ref": "Operation" |
+ "$ref": "Job" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
"delete": { |
- "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", |
+ "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", |
"httpMethod": "DELETE", |
- "id": "dataproc.projects.regions.operations.delete", |
+ "id": "dataproc.projects.regions.jobs.delete", |
"parameterOrder": [ |
- "name" |
+ "projectId", |
+ "region", |
+ "jobId" |
], |
"parameters": { |
- "name": { |
- "description": "The name of the operation resource to be deleted.", |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "jobId": { |
+ "description": "Required The job ID.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
"location": "path", |
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
"required": true, |
"type": "string" |
} |
}, |
- "path": "v1/{+name}", |
+ "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", |
"response": { |
"$ref": "Empty" |
}, |
@@ -653,25 +671,62 @@ |
"https://www.googleapis.com/auth/cloud-platform" |
] |
}, |
- "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`.", |
- "httpMethod": "POST", |
- "id": "dataproc.projects.regions.operations.cancel", |
+ "list": { |
+ "description": "Lists regions/{region}/jobs in a project.", |
+ "httpMethod": "GET", |
+ "id": "dataproc.projects.regions.jobs.list", |
"parameterOrder": [ |
- "name" |
+ "projectId", |
+ "region" |
], |
"parameters": { |
- "name": { |
- "description": "The name of the operation resource to be cancelled.", |
+ "pageToken": { |
+ "description": "Optional The page token, returned by a previous call, to request the next page of results.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "pageSize": { |
+ "description": "Optional The number of results to return in each response.", |
+ "format": "int32", |
+ "location": "query", |
+ "type": "integer" |
+ }, |
+ "region": { |
+ "description": "Required The Cloud Dataproc region in which to handle the request.", |
+ "location": "path", |
+ "required": true, |
+ "type": "string" |
+ }, |
+ "clusterName": { |
+ "description": "Optional If set, the returned jobs list includes only jobs that were submitted to the named cluster.", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
"location": "path", |
- "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", |
"required": true, |
"type": "string" |
+ }, |
+ "filter": { |
+ "description": "Optional A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or 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 = *", |
+ "location": "query", |
+ "type": "string" |
+ }, |
+ "jobStateMatcher": { |
+ "description": "Optional Specifies enumerated categories of jobs to list (default = match ALL jobs).", |
+ "enum": [ |
+ "ALL", |
+ "ACTIVE", |
+ "NON_ACTIVE" |
+ ], |
+ "location": "query", |
+ "type": "string" |
} |
}, |
- "path": "v1/{+name}:cancel", |
+ "path": "v1/projects/{projectId}/regions/{region}/jobs", |
"response": { |
- "$ref": "Empty" |
+ "$ref": "ListJobsResponse" |
}, |
"scopes": [ |
"https://www.googleapis.com/auth/cloud-platform" |
@@ -684,50 +739,133 @@ |
} |
} |
}, |
- "revision": "20161102", |
+ "revision": "20170207", |
"rootUrl": "https://dataproc.googleapis.com/", |
"schemas": { |
- "Cluster": { |
- "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.", |
- "id": "Cluster", |
+ "DiagnoseClusterRequest": { |
+ "description": "A request to collect cluster diagnostic information.", |
+ "id": "DiagnoseClusterRequest", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "DiskConfig": { |
+ "description": "Specifies the config of disk options for a group of VM instances.", |
+ "id": "DiskConfig", |
"properties": { |
- "projectId": { |
- "description": "[Required] The Google Cloud Platform project ID that the cluster belongs to.", |
- "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" |
- }, |
- "config": { |
- "$ref": "ClusterConfig", |
- "description": "[Required] The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated." |
+ "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" |
}, |
+ "bootDiskSizeGb": { |
+ "description": "Optional Size in GB of the boot disk (default is 500GB).", |
+ "format": "int32", |
+ "type": "integer" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ClusterOperationMetadata": { |
+ "description": "Metadata describing the operation.", |
+ "id": "ClusterOperationMetadata", |
+ "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.", |
+ "description": "Output-only Labels associated with the operation", |
"type": "object" |
}, |
"status": { |
- "$ref": "ClusterStatus", |
- "description": "[Output-only] Cluster status." |
+ "$ref": "ClusterOperationStatus", |
+ "description": "Output-only Current operation status." |
}, |
"statusHistory": { |
- "description": "[Output-only] The previous cluster status.", |
+ "description": "Output-only The previous operation status.", |
"items": { |
- "$ref": "ClusterStatus" |
+ "$ref": "ClusterOperationStatus" |
}, |
"type": "array" |
}, |
"clusterUuid": { |
- "description": "[Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.", |
+ "description": "Output-only Cluster UUID for the operation.", |
"type": "string" |
}, |
- "metrics": { |
- "$ref": "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." |
+ "clusterName": { |
+ "description": "Output-only Name of the cluster for the operation.", |
+ "type": "string" |
+ }, |
+ "operationType": { |
+ "description": "Output-only The operation type.", |
+ "type": "string" |
+ }, |
+ "description": { |
+ "description": "Output-only Short description of operation.", |
+ "type": "string" |
+ }, |
+ "warnings": { |
+ "description": "Output-only Errors encountered during operation execution.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "HiveJob": { |
+ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", |
+ "id": "HiveJob", |
+ "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": { |
+ "$ref": "QueryList", |
+ "description": "A list of queries." |
+ }, |
+ "queryFileUri": { |
+ "description": "The HCFS URI of the script that contains Hive queries.", |
+ "type": "string" |
+ }, |
+ "scriptVariables": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "description": "Optional Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).", |
+ "type": "object" |
+ }, |
+ "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" |
+ }, |
+ "properties": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "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" |
+ } |
+ }, |
+ "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 object {}.", |
+ "id": "Empty", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "DiagnoseClusterResults": { |
+ "description": "The location of diagnostic output.", |
+ "id": "DiagnoseClusterResults", |
+ "properties": { |
+ "outputUri": { |
+ "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.", |
+ "type": "string" |
} |
}, |
"type": "object" |
@@ -736,246 +874,208 @@ |
"description": "The cluster config.", |
"id": "ClusterConfig", |
"properties": { |
- "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" |
- }, |
"gceClusterConfig": { |
"$ref": "GceClusterConfig", |
- "description": "[Required] The shared Google Compute Engine config settings for all instances in a cluster." |
+ "description": "Required The shared Google Compute Engine config settings for all instances in a cluster." |
}, |
- "masterConfig": { |
- "$ref": "InstanceGroupConfig", |
- "description": "[Optional] The Google Compute Engine config settings for the master instance in a cluster." |
+ "softwareConfig": { |
+ "$ref": "SoftwareConfig", |
+ "description": "Optional The config settings for software inside the cluster." |
}, |
- "workerConfig": { |
+ "masterConfig": { |
"$ref": "InstanceGroupConfig", |
- "description": "[Optional] The Google Compute Engine config settings for worker instances in a cluster." |
+ "description": "Optional The Google Compute Engine config settings for the master instance in a cluster." |
}, |
"secondaryWorkerConfig": { |
"$ref": "InstanceGroupConfig", |
- "description": "[Optional] The Google Compute Engine config settings for additional worker instances in a cluster." |
- }, |
- "softwareConfig": { |
- "$ref": "SoftwareConfig", |
- "description": "[Optional] The config settings for software inside the cluster." |
+ "description": "Optional The Google Compute Engine config settings for additional worker instances in a cluster." |
}, |
"initializationActions": { |
- "description": "[Optional] Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using `curl` (you can also use `wget`): ROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role) if [[ \"${ROLE}\" == 'Master' ]]; then ... master specific actions ... else ... worker specific actions ... fi", |
+ "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 <code>role</code> 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": "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." |
} |
}, |
"type": "object" |
}, |
- "GceClusterConfig": { |
- "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", |
- "id": "GceClusterConfig", |
+ "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.", |
+ "id": "PySparkJob", |
"properties": { |
- "zoneUri": { |
- "description": "[Required] The zone where the Google Compute Engine cluster will be located. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]`.", |
- "type": "string" |
- }, |
- "networkUri": { |
- "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](/compute/docs/subnetworks) for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.", |
- "type": "string" |
- }, |
- "subnetworkUri": { |
- "description": "[Optional] The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0`.", |
+ "mainPythonFileUri": { |
+ "description": "Required The HCFS URI of the main Python file to use as the driver. Must be a .py file.", |
"type": "string" |
}, |
- "internalIpOnly": { |
- "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.", |
- "type": "boolean" |
- }, |
- "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: * https://www.googleapis.com/auth/cloud.useraccounts.readonly * https://www.googleapis.com/auth/devstorage.read_write * https://www.googleapis.com/auth/logging.write If no scopes are specified, the following defaults are also provided: * https://www.googleapis.com/auth/bigquery * https://www.googleapis.com/auth/bigtable.admin.table * https://www.googleapis.com/auth/bigtable.data * https://www.googleapis.com/auth/devstorage.full_control", |
+ "archiveUris": { |
+ "description": "Optional HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
}, |
- "tags": { |
- "description": "The Google Compute Engine tags to add to all instances (see [Tagging instances](/compute/docs/label-or-tag-resources#tags)).", |
+ "jarFileUris": { |
+ "description": "Optional HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
}, |
- "metadata": { |
+ "loggingConfig": { |
+ "$ref": "LoggingConfig", |
+ "description": "Optional The runtime log config for job execution." |
+ }, |
+ "properties": { |
"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)).", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "InstanceGroupConfig": { |
- "description": "[Optional] The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", |
- "id": "InstanceGroupConfig", |
- "properties": { |
- "numInstances": { |
- "description": "[Required] The number of VM instances in the instance group. For master instance groups, must be set to 1.", |
- "format": "int32", |
- "type": "integer" |
}, |
- "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).", |
+ "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" |
}, |
- "imageUri": { |
- "description": "[Output-only] The Google Compute Engine image resource used for cluster instances. Inferred from `SoftwareConfig.image_version`.", |
- "type": "string" |
- }, |
- "machineTypeUri": { |
- "description": "[Required] The Google Compute Engine machine type used for cluster instances. Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2`.", |
- "type": "string" |
- }, |
- "diskConfig": { |
- "$ref": "DiskConfig", |
- "description": "[Optional] Disk option config settings." |
- }, |
- "isPreemptible": { |
- "description": "[Optional] Specifies that this instance group contains preemptible instances.", |
- "type": "boolean" |
- }, |
- "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." |
- } |
- }, |
- "type": "object" |
- }, |
- "DiskConfig": { |
- "description": "Specifies the config of disk options for a group of VM instances.", |
- "id": "DiskConfig", |
- "properties": { |
- "bootDiskSizeGb": { |
- "description": "[Optional] Size in GB of the boot disk (default is 500GB).", |
- "format": "int32", |
- "type": "integer" |
+ "fileUris": { |
+ "description": "Optional HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
}, |
- "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" |
+ "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" |
} |
}, |
"type": "object" |
}, |
- "ManagedGroupConfig": { |
- "description": "Specifies the resources used to actively manage an instance group.", |
- "id": "ManagedGroupConfig", |
+ "GceClusterConfig": { |
+ "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", |
+ "id": "GceClusterConfig", |
"properties": { |
- "instanceTemplateName": { |
- "description": "[Output-only] The name of the Instance Template used for the Managed Instance Group.", |
+ "networkUri": { |
+ "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). Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default.", |
"type": "string" |
}, |
- "instanceGroupManagerName": { |
- "description": "[Output-only] The name of the Instance Group Manager for this group.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "SoftwareConfig": { |
- "description": "Specifies the selection and config of software inside the cluster.", |
- "id": "SoftwareConfig", |
- "properties": { |
- "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](/dataproc/versioning)).", |
+ "zoneUri": { |
+ "description": "Required The zone where the Google Compute Engine cluster will be located. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone].", |
"type": "string" |
}, |
- "properties": { |
+ "metadata": { |
"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: * core: `core-site.xml` * hdfs: `hdfs-site.xml` * mapred: `mapred-site.xml` * yarn: `yarn-site.xml` * hive: `hive-site.xml` * pig: `pig.properties` * spark: `spark-defaults.conf`", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "NodeInitializationAction": { |
- "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", |
- "id": "NodeInitializationAction", |
- "properties": { |
- "executableFile": { |
- "description": "[Required] Google Cloud Storage URI of executable file.", |
- "type": "string" |
}, |
- "executionTimeout": { |
- "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "ClusterStatus": { |
- "description": "The status of a cluster and its instances.", |
- "id": "ClusterStatus", |
- "properties": { |
- "state": { |
- "description": "[Output-only] The cluster's state.", |
- "enum": [ |
- "UNKNOWN", |
- "CREATING", |
- "RUNNING", |
- "ERROR", |
- "DELETING", |
- "UPDATING" |
- ], |
- "type": "string" |
+ "internalIpOnly": { |
+ "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.", |
+ "type": "boolean" |
}, |
- "detail": { |
- "description": "[Output-only] Optional details of cluster's state.", |
+ "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" |
}, |
- "stateStartTime": { |
- "description": "[Output-only] Time when this state was entered.", |
+ "subnetworkUri": { |
+ "description": "Optional The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0.", |
"type": "string" |
} |
}, |
"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.", |
+ "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", |
"id": "ClusterMetrics", |
"properties": { |
- "hdfsMetrics": { |
+ "yarnMetrics": { |
"additionalProperties": { |
"format": "int64", |
"type": "string" |
}, |
- "description": "The HDFS metrics.", |
+ "description": "The YARN metrics.", |
"type": "object" |
}, |
- "yarnMetrics": { |
+ "hdfsMetrics": { |
"additionalProperties": { |
"format": "int64", |
"type": "string" |
}, |
- "description": "The YARN metrics.", |
+ "description": "The HDFS metrics.", |
"type": "object" |
} |
}, |
"type": "object" |
}, |
+ "LoggingConfig": { |
+ "description": "The runtime logging config of the job.", |
+ "id": "LoggingConfig", |
+ "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" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "DiagnoseClusterOutputLocation": { |
+ "description": "The location where output from diagnostic command can be found.", |
+ "id": "DiagnoseClusterOutputLocation", |
+ "properties": { |
+ "outputUri": { |
+ "description": "Output-only The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
"Operation": { |
"description": "This resource represents a long-running operation that is the result of a network API call.", |
"id": "Operation", |
"properties": { |
- "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" |
- }, |
"metadata": { |
"additionalProperties": { |
"description": "Properties of the object. Contains field @type with type URL.", |
@@ -985,26 +1085,92 @@ |
"type": "object" |
}, |
"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.", |
+ "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" |
}, |
- "error": { |
- "$ref": "Status", |
- "description": "The error result of the operation in case of failure or cancellation." |
- }, |
"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`.", |
+ "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": { |
+ "$ref": "Status", |
+ "description": "The error result of the operation in case of failure or cancellation." |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "OperationStatus": { |
+ "description": "The status of the operation.", |
+ "id": "OperationStatus", |
+ "properties": { |
+ "state": { |
+ "description": "A message containing the operation state.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "PENDING", |
+ "RUNNING", |
+ "DONE" |
+ ], |
+ "enumDescriptions": [ |
+ "Unused.", |
+ "The operation has been created.", |
+ "The operation is running.", |
+ "The operation is done; either cancelled or completed." |
+ ], |
+ "type": "string" |
+ }, |
+ "details": { |
+ "description": "A message containing any operation metadata details.", |
+ "type": "string" |
+ }, |
+ "innerState": { |
+ "description": "A message containing the detailed operation state.", |
+ "type": "string" |
+ }, |
+ "stateStartTime": { |
+ "description": "The time this state was entered.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "JobReference": { |
+ "description": "Encapsulates the full scoping used to reference a job.", |
+ "id": "JobReference", |
+ "properties": { |
+ "projectId": { |
+ "description": "Required The ID of the Google Cloud Platform project that the job belongs to.", |
+ "type": "string" |
+ }, |
+ "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 512 characters.", |
+ "type": "string" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "SubmitJobRequest": { |
+ "description": "A request to submit a job.", |
+ "id": "SubmitJobRequest", |
+ "properties": { |
+ "job": { |
+ "$ref": "Job", |
+ "description": "Required The job resource." |
} |
}, |
"type": "object" |
}, |
"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: - Simple to use and understand for most users - Flexible enough to meet unexpected needs # Overview The `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` which can be used for common error conditions. # Language mapping The `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 uses The 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: - Partial 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. - Workflow errors. A typical workflow has multiple steps. Each step may have a `Status` message for error reporting purpose. - Batch 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. - Asynchronous 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. - Logging. If some API errors are stored in logs, the message `Status` could be used directly after any stripping needed for security/privacy reasons.", |
+ "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 which 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 purpose.\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.", |
"id": "Status", |
"properties": { |
"code": { |
@@ -1030,390 +1196,321 @@ |
}, |
"type": "object" |
}, |
- "ListClustersResponse": { |
- "description": "The list of all clusters in a project.", |
- "id": "ListClustersResponse", |
- "properties": { |
- "clusters": { |
- "description": "[Output-only] The clusters in the project.", |
- "items": { |
- "$ref": "Cluster" |
- }, |
- "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 ListClustersRequest.", |
- "type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "DiagnoseClusterRequest": { |
- "description": "A request to collect cluster diagnostic information.", |
- "id": "DiagnoseClusterRequest", |
- "type": "object" |
- }, |
- "SubmitJobRequest": { |
- "description": "A request to submit a job.", |
- "id": "SubmitJobRequest", |
+ "JobScheduling": { |
+ "description": "Job scheduling options.Beta Feature: These options are available for testing purposes only. They may be changed before final release.", |
+ "id": "JobScheduling", |
"properties": { |
- "job": { |
- "$ref": "Job", |
- "description": "[Required] The job resource." |
+ "maxFailuresPerHour": { |
+ "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.", |
+ "format": "int32", |
+ "type": "integer" |
} |
}, |
"type": "object" |
}, |
- "Job": { |
- "description": "A Cloud Dataproc job resource.", |
- "id": "Job", |
+ "InstanceGroupConfig": { |
+ "description": "Optional The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", |
+ "id": "InstanceGroupConfig", |
"properties": { |
- "reference": { |
- "$ref": "JobReference", |
- "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 job_id." |
- }, |
- "placement": { |
- "$ref": "JobPlacement", |
- "description": "[Required] Job information, including how, when, and where to run the job." |
- }, |
- "hadoopJob": { |
- "$ref": "HadoopJob", |
- "description": "Job is a Hadoop job." |
- }, |
- "sparkJob": { |
- "$ref": "SparkJob", |
- "description": "Job is a Spark job." |
- }, |
- "pysparkJob": { |
- "$ref": "PySparkJob", |
- "description": "Job is a Pyspark job." |
+ "numInstances": { |
+ "description": "Required The number of VM instances in the instance group. For master instance groups, must be set to 1.", |
+ "format": "int32", |
+ "type": "integer" |
}, |
- "hiveJob": { |
- "$ref": "HiveJob", |
- "description": "Job is a Hive job." |
+ "diskConfig": { |
+ "$ref": "DiskConfig", |
+ "description": "Optional Disk option config settings." |
}, |
- "pigJob": { |
- "$ref": "PigJob", |
- "description": "Job is a Pig job." |
+ "machineTypeUri": { |
+ "description": "Required The Google Compute Engine machine type used for cluster instances. Example: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2.", |
+ "type": "string" |
}, |
- "sparkSqlJob": { |
- "$ref": "SparkSqlJob", |
- "description": "Job is a SparkSql job." |
+ "imageUri": { |
+ "description": "Output-only The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.", |
+ "type": "string" |
}, |
- "status": { |
- "$ref": "JobStatus", |
- "description": "[Output-only] The job status. Additional application-specific status information may be contained in the type_job and yarn_applications fields." |
+ "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." |
}, |
- "statusHistory": { |
- "description": "[Output-only] The previous job status.", |
- "items": { |
- "$ref": "JobStatus" |
- }, |
- "type": "array" |
+ "isPreemptible": { |
+ "description": "Optional Specifies that this instance group contains preemptible instances.", |
+ "type": "boolean" |
}, |
- "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.", |
+ "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": { |
- "$ref": "YarnApplication" |
- }, |
- "type": "array" |
- }, |
- "driverOutputResourceUri": { |
- "description": "[Output-only] A URI pointing to the location of the stdout of the job's driver program.", |
- "type": "string" |
- }, |
- "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" |
- }, |
- "labels": { |
- "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.", |
- "type": "object" |
+ "type": "array" |
} |
}, |
"type": "object" |
}, |
- "JobReference": { |
- "description": "Encapsulates the full scoping used to reference a job.", |
- "id": "JobReference", |
+ "NodeInitializationAction": { |
+ "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", |
+ "id": "NodeInitializationAction", |
"properties": { |
- "projectId": { |
- "description": "[Required] The ID of the Google Cloud Platform project that the job belongs to.", |
+ "executionTimeout": { |
+ "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.", |
+ "format": "google-duration", |
"type": "string" |
}, |
- "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 512 characters.", |
+ "executableFile": { |
+ "description": "Required Google Cloud Storage URI of executable file.", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "JobPlacement": { |
- "description": "Cloud Dataproc job config.", |
- "id": "JobPlacement", |
+ "ListJobsResponse": { |
+ "description": "A list of jobs in a project.", |
+ "id": "ListJobsResponse", |
"properties": { |
- "clusterName": { |
- "description": "[Required] The name of the cluster where the job will be submitted.", |
- "type": "string" |
+ "jobs": { |
+ "description": "Output-only Jobs list.", |
+ "items": { |
+ "$ref": "Job" |
+ }, |
+ "type": "array" |
}, |
- "clusterUuid": { |
- "description": "[Output-only] A cluster UUID generated by the Cloud Dataproc service when the job is submitted.", |
+ "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 <code>ListJobsRequest</code>.", |
"type": "string" |
} |
}, |
"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).", |
- "id": "HadoopJob", |
+ "CancelJobRequest": { |
+ "description": "A request to cancel a job.", |
+ "id": "CancelJobRequest", |
+ "properties": {}, |
+ "type": "object" |
+ }, |
+ "SparkSqlJob": { |
+ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.", |
+ "id": "SparkSqlJob", |
"properties": { |
- "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" |
- }, |
- "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" |
- }, |
- "args": { |
- "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.", |
- "items": { |
+ "scriptVariables": { |
+ "additionalProperties": { |
"type": "string" |
}, |
- "type": "array" |
+ "description": "Optional Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", |
+ "type": "object" |
}, |
"jarFileUris": { |
- "description": "[Optional] Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
- "fileUris": { |
- "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.", |
+ "description": "Optional HCFS URIs of jar files to be added to the Spark CLASSPATH.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
}, |
- "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" |
+ "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 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.", |
+ "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" |
}, |
- "loggingConfig": { |
- "$ref": "LoggingConfig", |
- "description": "[Optional] The runtime log config for job execution." |
+ "queryFileUri": { |
+ "description": "The HCFS URI of the script that contains SQL queries.", |
+ "type": "string" |
+ }, |
+ "queryList": { |
+ "$ref": "QueryList", |
+ "description": "A list of queries." |
} |
}, |
"type": "object" |
}, |
- "LoggingConfig": { |
- "description": "The runtime logging config of the job.", |
- "id": "LoggingConfig", |
+ "Cluster": { |
+ "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.", |
+ "id": "Cluster", |
"properties": { |
- "driverLogLevels": { |
+ "projectId": { |
+ "description": "Required The Google Cloud Platform project ID that the cluster belongs to.", |
+ "type": "string" |
+ }, |
+ "labels": { |
"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'", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "SparkJob": { |
- "description": "A Cloud Dataproc job for running [Apache Spark](http://spark.apache.org/) applications on YARN.", |
- "id": "SparkJob", |
- "properties": { |
- "mainJarFileUri": { |
- "description": "The HCFS URI of the jar file that contains the main class.", |
- "type": "string" |
}, |
- "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" |
+ "status": { |
+ "$ref": "ClusterStatus", |
+ "description": "Output-only Cluster status." |
}, |
- "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" |
+ "metrics": { |
+ "$ref": "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." |
}, |
- "jarFileUris": { |
- "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Spark driver and tasks.", |
- "items": { |
- "type": "string" |
- }, |
- "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." |
}, |
- "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.", |
+ "statusHistory": { |
+ "description": "Output-only The previous cluster status.", |
"items": { |
- "type": "string" |
+ "$ref": "ClusterStatus" |
}, |
"type": "array" |
}, |
- "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.", |
+ "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" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "ListOperationsResponse": { |
+ "description": "The response message for Operations.ListOperations.", |
+ "id": "ListOperationsResponse", |
+ "properties": { |
+ "operations": { |
+ "description": "A list of operations that matches the specified filter in the request.", |
"items": { |
- "type": "string" |
+ "$ref": "Operation" |
}, |
"type": "array" |
}, |
- "properties": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "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" |
- }, |
- "loggingConfig": { |
- "$ref": "LoggingConfig", |
- "description": "[Optional] The runtime log config for job execution." |
+ "nextPageToken": { |
+ "description": "The standard List next-page token.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
- "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.", |
- "id": "PySparkJob", |
+ "OperationMetadata": { |
+ "description": "Metadata describing the operation.", |
+ "id": "OperationMetadata", |
"properties": { |
- "mainPythonFileUri": { |
- "description": "[Required] The HCFS URI of the main Python file to use as the driver. Must be a .py file.", |
+ "details": { |
+ "description": "A message containing any operation metadata details.", |
"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" |
+ "state": { |
+ "description": "A message containing the operation state.", |
+ "enum": [ |
+ "UNKNOWN", |
+ "PENDING", |
+ "RUNNING", |
+ "DONE" |
+ ], |
+ "enumDescriptions": [ |
+ "Unused.", |
+ "The operation has been created.", |
+ "The operation is currently running.", |
+ "The operation is done, either cancelled or completed." |
+ ], |
+ "type": "string" |
}, |
- "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" |
+ "clusterName": { |
+ "description": "Name of the cluster for the operation.", |
+ "type": "string" |
}, |
- "jarFileUris": { |
- "description": "[Optional] HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
+ "clusterUuid": { |
+ "description": "Cluster UUId for the operation.", |
+ "type": "string" |
}, |
- "fileUris": { |
- "description": "[Optional] HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.", |
+ "innerState": { |
+ "description": "A message containing the detailed operation state.", |
+ "type": "string" |
+ }, |
+ "endTime": { |
+ "description": "The time that the operation completed.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "startTime": { |
+ "description": "The time that the operation was started by the server.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "warnings": { |
+ "description": "Output-only Errors encountered during operation execution.", |
"items": { |
"type": "string" |
}, |
"type": "array" |
}, |
- "archiveUris": { |
- "description": "[Optional] HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", |
+ "insertTime": { |
+ "description": "The time that the operation was requested.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
+ "statusHistory": { |
+ "description": "Output-only Previous operation status.", |
"items": { |
- "type": "string" |
+ "$ref": "OperationStatus" |
}, |
"type": "array" |
}, |
- "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" |
+ "operationType": { |
+ "description": "Output-only The operation type.", |
+ "type": "string" |
}, |
- "loggingConfig": { |
- "$ref": "LoggingConfig", |
- "description": "[Optional] The runtime log config for job execution." |
+ "description": { |
+ "description": "Output-only Short description of operation.", |
+ "type": "string" |
+ }, |
+ "status": { |
+ "$ref": "OperationStatus", |
+ "description": "Output-only Current operation status." |
} |
}, |
"type": "object" |
}, |
- "HiveJob": { |
- "description": "A Cloud Dataproc job for running [Apache Hive](https://hive.apache.org/) queries on YARN.", |
- "id": "HiveJob", |
+ "SoftwareConfig": { |
+ "description": "Specifies the selection and config of software inside the cluster.", |
+ "id": "SoftwareConfig", |
"properties": { |
- "queryFileUri": { |
- "description": "The HCFS URI of the script that contains Hive queries.", |
+ "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" |
}, |
- "queryList": { |
- "$ref": "QueryList", |
- "description": "A list of queries." |
- }, |
- "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" |
- }, |
- "scriptVariables": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "[Optional] Mapping of query variable names to values (equivalent to the Hive command: `SET name=\"value\";`).", |
- "type": "object" |
- }, |
"properties": { |
"additionalProperties": { |
"type": "string" |
}, |
- "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.", |
+ "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:\ncore: core-site.xml\nhdfs: hdfs-site.xml\nmapred: mapred-site.xml\nyarn: yarn-site.xml\nhive: hive-site.xml\npig: pig.properties\nspark: spark-defaults.conf", |
"type": "object" |
- }, |
- "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" |
} |
}, |
"type": "object" |
}, |
- "QueryList": { |
- "description": "A list of queries to run on a cluster.", |
- "id": "QueryList", |
+ "JobPlacement": { |
+ "description": "Cloud Dataproc job config.", |
+ "id": "JobPlacement", |
"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: \"hiveJob\": { \"queryList\": { \"queries\": [ \"query1\", \"query2\", \"query3;query4\", ] } }", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
+ "clusterName": { |
+ "description": "Required The name of the cluster where the job will be submitted.", |
+ "type": "string" |
+ }, |
+ "clusterUuid": { |
+ "description": "Output-only A cluster UUID generated by the Cloud Dataproc service when the job is submitted.", |
+ "type": "string" |
} |
}, |
"type": "object" |
}, |
"PigJob": { |
- "description": "A Cloud Dataproc job for running [Apache Pig](https://pig.apache.org/) queries on YARN.", |
+ "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", |
"id": "PigJob", |
"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" |
+ }, |
"queryFileUri": { |
"description": "The HCFS URI of the script that contains the Pig queries.", |
"type": "string" |
@@ -1422,370 +1519,423 @@ |
"$ref": "QueryList", |
"description": "A list of queries." |
}, |
- "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" |
- }, |
- "scriptVariables": { |
- "additionalProperties": { |
- "type": "string" |
- }, |
- "description": "[Optional] Mapping of query variable names to values (equivalent to the Pig command: `name=[value]`).", |
- "type": "object" |
- }, |
- "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" |
- }, |
"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.", |
+ "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" |
}, |
- "loggingConfig": { |
- "$ref": "LoggingConfig", |
- "description": "[Optional] The runtime log config for job execution." |
- } |
- }, |
- "type": "object" |
- }, |
- "SparkSqlJob": { |
- "description": "A Cloud Dataproc job for running [Apache Spark SQL](http://spark.apache.org/sql/) queries.", |
- "id": "SparkSqlJob", |
- "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\";`).", |
+ "description": "Optional Mapping of query variable names to values (equivalent to the Pig command: name=[value]).", |
"type": "object" |
}, |
+ "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 Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.", |
+ "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" |
- }, |
- "jarFileUris": { |
- "description": "[Optional] HCFS URIs of jar files to be added to the Spark CLASSPATH.", |
- "items": { |
- "type": "string" |
- }, |
- "type": "array" |
- }, |
- "loggingConfig": { |
- "$ref": "LoggingConfig", |
- "description": "[Optional] The runtime log config for job execution." |
} |
}, |
"type": "object" |
}, |
- "JobStatus": { |
- "description": "Cloud Dataproc job status.", |
- "id": "JobStatus", |
+ "ClusterStatus": { |
+ "description": "The status of a cluster and its instances.", |
+ "id": "ClusterStatus", |
"properties": { |
- "state": { |
- "description": "[Output-only] A state message specifying the overall job state.", |
- "enum": [ |
- "STATE_UNSPECIFIED", |
- "PENDING", |
- "SETUP_DONE", |
- "RUNNING", |
- "CANCEL_PENDING", |
- "CANCEL_STARTED", |
- "CANCELLED", |
- "DONE", |
- "ERROR" |
- ], |
- "type": "string" |
- }, |
- "details": { |
- "description": "[Output-only] Optional job state details, such as an error description if the state is ERROR.", |
- "type": "string" |
- }, |
"stateStartTime": { |
- "description": "[Output-only] The time when this state was entered.", |
+ "description": "Output-only Time when this state was entered.", |
+ "format": "google-datetime", |
"type": "string" |
- } |
- }, |
- "type": "object" |
- }, |
- "YarnApplication": { |
- "description": "A YARN application created by a job. Application information is a subset of org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto. **Beta Feature**: This report is available for testing purposes only. It may be changed before final release.", |
- "id": "YarnApplication", |
- "properties": { |
- "name": { |
- "description": "[Required] The application name.", |
+ }, |
+ "detail": { |
+ "description": "Output-only Optional details of cluster's state.", |
"type": "string" |
}, |
"state": { |
- "description": "[Required] The application state.", |
+ "description": "Output-only The cluster's state.", |
"enum": [ |
- "STATE_UNSPECIFIED", |
- "NEW", |
- "NEW_SAVING", |
- "SUBMITTED", |
- "ACCEPTED", |
+ "UNKNOWN", |
+ "CREATING", |
"RUNNING", |
- "FINISHED", |
- "FAILED", |
- "KILLED" |
+ "ERROR", |
+ "DELETING", |
+ "UPDATING" |
+ ], |
+ "enumDescriptions": [ |
+ "The cluster state is unknown.", |
+ "The cluster is being created and set up. It is not ready for use.", |
+ "The cluster is currently running and healthy. It is ready for use.", |
+ "The cluster encountered an error. It is not ready for use.", |
+ "The cluster is being deleted. It cannot be used.", |
+ "The cluster is being updated. It continues to accept and process jobs." |
], |
- "type": "string" |
- }, |
- "progress": { |
- "description": "[Required] The numerical progress of the application, from 1 to 100.", |
- "format": "float", |
- "type": "number" |
- }, |
- "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" |
} |
}, |
"type": "object" |
}, |
- "ListJobsResponse": { |
- "description": "A list of jobs in a project.", |
- "id": "ListJobsResponse", |
+ "ListClustersResponse": { |
+ "description": "The list of all clusters in a project.", |
+ "id": "ListClustersResponse", |
"properties": { |
- "jobs": { |
- "description": "[Output-only] Jobs list.", |
+ "clusters": { |
+ "description": "Output-only The clusters in the project.", |
"items": { |
- "$ref": "Job" |
+ "$ref": "Cluster" |
}, |
"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 ListJobsRequest.", |
+ "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 <code>ListClustersRequest</code>.", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "CancelJobRequest": { |
- "description": "A request to cancel a job.", |
- "id": "CancelJobRequest", |
- "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: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.", |
- "id": "Empty", |
- "type": "object" |
- }, |
- "ListOperationsResponse": { |
- "description": "The response message for Operations.ListOperations.", |
- "id": "ListOperationsResponse", |
+ "SparkJob": { |
+ "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.", |
+ "id": "SparkJob", |
"properties": { |
- "operations": { |
- "description": "A list of operations that matches the specified filter in the request.", |
+ "properties": { |
+ "additionalProperties": { |
+ "type": "string" |
+ }, |
+ "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" |
+ }, |
+ "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": { |
- "$ref": "Operation" |
+ "type": "string" |
}, |
"type": "array" |
}, |
- "nextPageToken": { |
- "description": "The standard List next-page token.", |
+ "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" |
- } |
- }, |
- "type": "object" |
- }, |
- "DiagnoseClusterResults": { |
- "description": "The location of diagnostic output.", |
- "id": "DiagnoseClusterResults", |
- "properties": { |
- "outputUri": { |
- "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.", |
+ }, |
+ "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" |
+ }, |
+ "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": { |
+ "$ref": "LoggingConfig", |
+ "description": "Optional The runtime log config for job execution." |
} |
}, |
"type": "object" |
}, |
- "ClusterOperationMetadata": { |
- "description": "Metadata describing the operation.", |
- "id": "ClusterOperationMetadata", |
+ "Job": { |
+ "description": "A Cloud Dataproc job resource.", |
+ "id": "Job", |
"properties": { |
- "clusterName": { |
- "description": "[Output-only] Name of the cluster for the operation.", |
- "type": "string" |
+ "scheduling": { |
+ "$ref": "JobScheduling", |
+ "description": "Optional Job scheduling configuration." |
}, |
- "clusterUuid": { |
- "description": "[Output-only] Cluster UUID for the operation.", |
- "type": "string" |
+ "pigJob": { |
+ "$ref": "PigJob", |
+ "description": "Job is a Pig job." |
}, |
- "status": { |
- "$ref": "ClusterOperationStatus", |
- "description": "[Output-only] Current operation status." |
+ "hiveJob": { |
+ "$ref": "HiveJob", |
+ "description": "Job is a Hive job." |
+ }, |
+ "labels": { |
+ "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.", |
+ "type": "object" |
+ }, |
+ "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 operation status.", |
+ "description": "Output-only The previous job status.", |
"items": { |
- "$ref": "ClusterOperationStatus" |
+ "$ref": "JobStatus" |
}, |
"type": "array" |
}, |
- "operationType": { |
- "description": "[Output-only] The operation type.", |
- "type": "string" |
+ "sparkSqlJob": { |
+ "$ref": "SparkSqlJob", |
+ "description": "Job is a SparkSql job." |
}, |
- "description": { |
- "description": "[Output-only] Short description of operation.", |
- "type": "string" |
+ "sparkJob": { |
+ "$ref": "SparkJob", |
+ "description": "Job is a Spark job." |
}, |
- "labels": { |
- "additionalProperties": { |
- "type": "string" |
+ "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" |
}, |
- "description": "[Output-only] labels associated with the operation", |
- "type": "object" |
+ "type": "array" |
+ }, |
+ "pysparkJob": { |
+ "$ref": "PySparkJob", |
+ "description": "Job is a Pyspark job." |
+ }, |
+ "reference": { |
+ "$ref": "JobReference", |
+ "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 <code>job_id</code>." |
+ }, |
+ "hadoopJob": { |
+ "$ref": "HadoopJob", |
+ "description": "Job is a Hadoop job." |
+ }, |
+ "status": { |
+ "$ref": "JobStatus", |
+ "description": "Output-only The job status. Additional application-specific status information may be contained in the <code>type_job</code> and <code>yarn_applications</code> 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" |
} |
}, |
"type": "object" |
}, |
- "ClusterOperationStatus": { |
- "description": "The status of the operation.", |
- "id": "ClusterOperationStatus", |
+ "JobStatus": { |
+ "description": "Cloud Dataproc job status.", |
+ "id": "JobStatus", |
"properties": { |
"state": { |
- "description": "[Output-only] A message containing the operation state.", |
+ "description": "Output-only A state message specifying the overall job state.", |
"enum": [ |
- "UNKNOWN", |
+ "STATE_UNSPECIFIED", |
"PENDING", |
+ "SETUP_DONE", |
"RUNNING", |
- "DONE" |
+ "CANCEL_PENDING", |
+ "CANCEL_STARTED", |
+ "CANCELLED", |
+ "DONE", |
+ "ERROR", |
+ "ATTEMPT_FAILURE" |
+ ], |
+ "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." |
], |
- "type": "string" |
- }, |
- "innerState": { |
- "description": "[Output-only] A message containing the detailed operation state.", |
"type": "string" |
}, |
"details": { |
- "description": "[Output-only]A message containing any operation metadata details.", |
+ "description": "Output-only Optional job state details, such as an error description if the state is <code>ERROR</code>.", |
"type": "string" |
}, |
"stateStartTime": { |
- "description": "[Output-only] The time this state was entered.", |
+ "description": "Output-only The time when this state was entered.", |
+ "format": "google-datetime", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "DiagnoseClusterOutputLocation": { |
- "description": "The location where output from diagnostic command can be found.", |
- "id": "DiagnoseClusterOutputLocation", |
+ "ManagedGroupConfig": { |
+ "description": "Specifies the resources used to actively manage an instance group.", |
+ "id": "ManagedGroupConfig", |
"properties": { |
- "outputUri": { |
- "description": "[Output-only] The Google Cloud Storage URI of the diagnostic output. This will be a plain text file with summary of collected diagnostics.", |
+ "instanceTemplateName": { |
+ "description": "Output-only The name of the Instance Template used for the Managed Instance Group.", |
+ "type": "string" |
+ }, |
+ "instanceGroupManagerName": { |
+ "description": "Output-only The name of the Instance Group Manager for this group.", |
"type": "string" |
} |
}, |
"type": "object" |
}, |
- "OperationMetadata": { |
- "description": "Metadata describing the operation.", |
- "id": "OperationMetadata", |
+ "ClusterOperationStatus": { |
+ "description": "The status of the operation.", |
+ "id": "ClusterOperationStatus", |
"properties": { |
+ "innerState": { |
+ "description": "Output-only A message containing the detailed operation state.", |
+ "type": "string" |
+ }, |
+ "stateStartTime": { |
+ "description": "Output-only The time this state was entered.", |
+ "format": "google-datetime", |
+ "type": "string" |
+ }, |
"state": { |
- "description": "A message containing the operation state.", |
+ "description": "Output-only A message containing the operation state.", |
"enum": [ |
"UNKNOWN", |
"PENDING", |
"RUNNING", |
"DONE" |
], |
- "type": "string" |
- }, |
- "innerState": { |
- "description": "A message containing the detailed operation state.", |
+ "enumDescriptions": [ |
+ "Unused.", |
+ "The operation has been created.", |
+ "The operation is running.", |
+ "The operation is done; either cancelled or completed." |
+ ], |
"type": "string" |
}, |
"details": { |
- "description": "A message containing any operation metadata details.", |
- "type": "string" |
- }, |
- "insertTime": { |
- "description": "The time that the operation was requested.", |
- "type": "string" |
- }, |
- "startTime": { |
- "description": "The time that the operation was started by the server.", |
+ "description": "Output-onlyA message containing any operation metadata details.", |
"type": "string" |
- }, |
- "endTime": { |
- "description": "The time that the operation completed.", |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "YarnApplication": { |
+ "description": "A YARN application created by a job. Application information is a subset of <code>org.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto</code>.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", |
+ "id": "YarnApplication", |
+ "properties": { |
+ "state": { |
+ "description": "Required The application state.", |
+ "enum": [ |
+ "STATE_UNSPECIFIED", |
+ "NEW", |
+ "NEW_SAVING", |
+ "SUBMITTED", |
+ "ACCEPTED", |
+ "RUNNING", |
+ "FINISHED", |
+ "FAILED", |
+ "KILLED" |
+ ], |
+ "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." |
+ ], |
"type": "string" |
}, |
- "clusterName": { |
- "description": "Name of the cluster for the operation.", |
+ "name": { |
+ "description": "Required The application name.", |
"type": "string" |
}, |
- "clusterUuid": { |
- "description": "Cluster UUId for the operation.", |
+ "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" |
}, |
- "status": { |
- "$ref": "OperationStatus", |
- "description": "[Output-only] Current operation status." |
- }, |
- "statusHistory": { |
- "description": "[Output-only] Previous operation status.", |
+ "progress": { |
+ "description": "Required The numerical progress of the application, from 1 to 100.", |
+ "format": "float", |
+ "type": "number" |
+ } |
+ }, |
+ "type": "object" |
+ }, |
+ "QueryList": { |
+ "description": "A list of queries to run on a cluster.", |
+ "id": "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": { |
- "$ref": "OperationStatus" |
+ "type": "string" |
}, |
"type": "array" |
- }, |
- "operationType": { |
- "description": "[Output-only] The operation type.", |
- "type": "string" |
- }, |
- "description": { |
- "description": "[Output-only] Short description of operation.", |
- "type": "string" |
} |
}, |
"type": "object" |
}, |
- "OperationStatus": { |
- "description": "The status of the operation.", |
- "id": "OperationStatus", |
+ "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).", |
+ "id": "HadoopJob", |
"properties": { |
- "state": { |
- "description": "A message containing the operation state.", |
- "enum": [ |
- "UNKNOWN", |
- "PENDING", |
- "RUNNING", |
- "DONE" |
- ], |
+ "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" |
}, |
- "innerState": { |
- "description": "A message containing the detailed operation state.", |
- "type": "string" |
+ "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" |
}, |
- "details": { |
- "description": "A message containing any operation metadata details.", |
+ "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" |
}, |
- "stateStartTime": { |
- "description": "The time this state was entered.", |
- "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": { |
+ "$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 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": { |
+ "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.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
+ }, |
+ "fileUris": { |
+ "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.", |
+ "items": { |
+ "type": "string" |
+ }, |
+ "type": "array" |
} |
}, |
"type": "object" |