Api-roll 42: 2016-11-08

discovery/googleapis_beta/dataproc__v1beta1.json

 {
     "auth": {
         "oauth2": {
             "scopes": {
                 "https://www.googleapis.com/auth/cloud-platform": {
                     "description": "View and manage your data across Google Cloud Platform services"
                 }
             }
         }
     },
     "basePath": "",
     "baseUrl": "https://dataproc.googleapis.com/",
     "batchPath": "batch",
-    "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.",
+    "description": "An API for managing Hadoop-based clusters and jobs on Google Cloud Platform.",
     "discoveryVersion": "v1",
     "documentationLink": "https://cloud.google.com/dataproc/",
-    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/xUykUeDoZBMkhqViXbAjUkEVLQw\"",
+    "etag": "\"C5oy1hgQsABtYOYIOXWcR3BgYqU/cZQ-6vqHhMM0YELMHYWsiSzNXAM\"",
     "icons": {
         "x16": "http://www.google.com/images/icons/product/search-16.gif",
         "x32": "http://www.google.com/images/icons/product/search-32.gif"
     },
     "id": "dataproc:v1beta1",
     "kind": "discovery#restDescription",
     "name": "dataproc",
     "ownerDomain": "google.com",
     "ownerName": "Google",
     "parameters": {
@@ skipping 212 matching lines @@
                             "parameterOrder": [
                                 "projectId"
                             ],
                             "parameters": {
                                 "projectId": {
                                     "description": "[Required] The ID of the Google Cloud Platform project that the cluster belongs to.",
                                     "location": "path",
                                     "required": true,
                                     "type": "string"
                                 },
+                                "filter": {
+                                    "description": "[Optional] A filter constraining which clusters to list. Valid filters contain label terms such as: labels.key1 = val1 AND (-labels.k2 = val2 OR labels.k3 = val3)",
+                                    "location": "query",
+                                    "type": "string"
+                                },
                                 "pageSize": {
                                     "description": "The standard List page size.",
                                     "format": "int32",
                                     "location": "query",
                                     "type": "integer"
                                 },
                                 "pageToken": {
                                     "description": "The standard List page token.",
                                     "location": "query",
                                     "type": "string"
@@ skipping 132 matching lines @@
                                 },
                                 "jobStateMatcher": {
                                     "description": "[Optional] Specifies enumerated categories of jobs to list.",
                                     "enum": [
                                         "ALL",
                                         "ACTIVE",
                                         "NON_ACTIVE"
                                     ],
                                     "location": "query",
                                     "type": "string"
+                                },
+                                "filter": {
+                                    "description": "[Optional] A filter constraining which jobs to list. Valid filters contain job state and label terms such as: labels.key1 = val1 AND (labels.k2 = val2 OR labels.k3 = val3)",
+                                    "location": "query",
+                                    "type": "string"
                                 }
                             },
                             "path": "v1beta1/projects/{projectId}/jobs",
                             "response": {
                                 "$ref": "ListJobsResponse"
                             },
                             "scopes": [
                                 "https://www.googleapis.com/auth/cloud-platform"
                             ]
                         },
@@ skipping 70 matching lines @@
                     "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.operations.get",
                     "parameterOrder": [
                         "name"
                     ],
                     "parameters": {
                         "name": {
                             "description": "The name of the operation resource.",
                             "location": "path",
-                            "pattern": "^operations/.*$",
+                            "pattern": "^operations/.+$",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "v1beta1/{+name}",
                     "response": {
                         "$ref": "Operation"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/cloud-platform"
@@ skipping 43 matching lines @@
                     "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.get](/dataproc/reference/rest/v1beta1/operations/get) or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation.",
                     "httpMethod": "POST",
                     "id": "dataproc.operations.cancel",
                     "parameterOrder": [
                         "name"
                     ],
                     "parameters": {
                         "name": {
                             "description": "The name of the operation resource to be cancelled.",
                             "location": "path",
-                            "pattern": "^operations/.*$",
+                            "pattern": "^operations/.+$",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "v1beta1/{+name}:cancel",
                     "request": {
                         "$ref": "CancelOperationRequest"
                     },
                     "response": {
                         "$ref": "Empty"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/cloud-platform"
                     ]
                 },
                 "delete": {
                     "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
                     "httpMethod": "DELETE",
                     "id": "dataproc.operations.delete",
                     "parameterOrder": [
                         "name"
                     ],
                     "parameters": {
                         "name": {
                             "description": "The name of the operation resource to be deleted.",
                             "location": "path",
-                            "pattern": "^operations/.*$",
+                            "pattern": "^operations/.+$",
                             "required": true,
                             "type": "string"
                         }
                     },
                     "path": "v1beta1/{+name}",
                     "response": {
                         "$ref": "Empty"
                     },
                     "scopes": [
                         "https://www.googleapis.com/auth/cloud-platform"
                     ]
                 }
             }
         }
     },
-    "revision": "20160503",
+    "revision": "20161102",
     "rootUrl": "https://dataproc.googleapis.com/",
     "schemas": {
         "Cluster": {
             "description": "Describes the identifying information, configuration, and status of a cluster of Google Compute Engine instances.",
             "id": "Cluster",
             "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 from deleted clusters can be reused.",
                     "type": "string"
                 },
                 "configuration": {
                     "$ref": "ClusterConfiguration",
                     "description": "[Required] The cluster configuration. Note that Cloud Dataproc may set default values, and values may change when clusters are updated."
                 },
+                "labels": {
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "[Optional] The labels to associate with this cluster. Label keys must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: \\p{Ll}\\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following PCRE regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given cluster.",
+                    "type": "object"
+                },
                 "status": {
                     "$ref": "ClusterStatus",
                     "description": "[Output-only] Cluster status."
                 },
                 "statusHistory": {
                     "description": "[Output-only] Previous cluster statuses.",
                     "items": {
                         "$ref": "ClusterStatus"
                     },
                     "type": "array"
                 },
                 "clusterUuid": {
                     "description": "[Output-only] A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.",
                     "type": "string"
+                },
+                "metrics": {
+                    "$ref": "ClusterMetrics",
+                    "description": "Contains cluster daemon metrics such as HDFS and YARN stats."
                 }
             },
             "type": "object"
         },
         "ClusterConfiguration": {
             "description": "The cluster configuration.",
             "id": "ClusterConfiguration",
             "properties": {
                 "configurationBucket": {
                     "description": "[Optional] A Google Cloud Storage staging bucket used for sharing generated SSH keys and configuration. 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.",
@@ skipping 38 matching lines @@
                     "type": "string"
                 },
                 "networkUri": {
                     "description": "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 https://cloud.google.com/compute/docs/subnetworks for more information). Example: `https://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default`.",
                     "type": "string"
                 },
                 "subnetworkUri": {
                     "description": "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"
                 },
+                "internalIpOnly": {
+                    "description": "If true, all instances in the cluser 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 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": "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 specfied, 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",
                     "items": {
                         "type": "string"
                     },
                     "type": "array"
                 },
                 "tags": {
                     "description": "The Google Compute Engine tags to add to all instances.",
                     "items": {
@@ skipping 135 matching lines @@
                     "description": "Optional details of cluster's state.",
                     "type": "string"
                 },
                 "stateStartTime": {
                     "description": "Time when this state was entered.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
+        "ClusterMetrics": {
+            "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.",
+            "id": "ClusterMetrics",
+            "properties": {
+                "hdfsMetrics": {
+                    "additionalProperties": {
+                        "format": "int64",
+                        "type": "string"
+                    },
+                    "description": "The HDFS metrics.",
+                    "type": "object"
+                },
+                "yarnMetrics": {
+                    "additionalProperties": {
+                        "format": "int64",
+                        "type": "string"
+                    },
+                    "description": "The YARN metrics.",
+                    "type": "object"
+                }
+            },
+            "type": "object"
+        },
         "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 @ype with type URL.",
+                        "description": "Properties of the object. Contains field @type with type URL.",
                         "type": "any"
                     },
                     "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
                     "type": "object"
                 },
                 "done": {
                     "description": "If the value is `false`, it means the operation is still in progress. If true, the operation is completed, and either `error` or `response` is available.",
                     "type": "boolean"
                 },
                 "error": {
                     "$ref": "Status",
-                    "description": "The error result of the operation in case of failure."
+                    "description": "The error result of the operation in case of failure or cancellation."
                 },
                 "response": {
                     "additionalProperties": {
-                        "description": "Properties of the object. Contains field @ype with type URL.",
+                        "description": "Properties of the object. Contains field @type with type URL.",
                         "type": "any"
                     },
                     "description": "The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
                     "type": "object"
                 }
             },
             "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.",
             "id": "Status",
             "properties": {
                 "code": {
                     "description": "The status code, which should be an enum value of google.rpc.Code.",
                     "format": "int32",
                     "type": "integer"
                 },
                 "message": {
                     "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
                     "type": "string"
                 },
                 "details": {
                     "description": "A list of messages that carry the error details. There will be a common set of message types for APIs to use.",
                     "items": {
                         "additionalProperties": {
-                            "description": "Properties of the object. Contains field @ype with type URL.",
+                            "description": "Properties of the object. Contains field @type with type URL.",
                             "type": "any"
                         },
                         "type": "object"
                     },
                     "type": "array"
                 }
             },
             "type": "object"
         },
         "ListClustersResponse": {
@@ skipping 96 matching lines @@
                     "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"
                 },
                 "interactive": {
                     "description": "[Optional] If set to `true`, the driver's stdin will be kept open and `driver_input_uri` will be set to provide a path at which additional input can be sent to the driver.",
                     "type": "boolean"
+                },
+                "labels": {
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "[Optional] The labels to associate with this job. Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62} Label values must be between 1 and 63 characters long, and must conform to the following regular expression: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63} No more than 64 labels can be associated with a given job.",
+                    "type": "object"
                 }
             },
             "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.",
@@ skipping 463 matching lines @@
         "CancelOperationRequest": {
             "description": "The request message for Operations.CancelOperation.",
             "id": "CancelOperationRequest",
             "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. This is a plain text file with a summary of collected diagnostics.",
+                    "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"
         },
         "ClusterOperationMetadata": {
             "description": "Metadata describing the operation.",
             "id": "ClusterOperationMetadata",
             "properties": {
                 "clusterName": {
-                    "description": "Name of the cluster for the operation.",
+                    "description": "[Output-only] Name of the cluster for the operation.",
                     "type": "string"
                 },
                 "clusterUuid": {
-                    "description": "Cluster UUId for the operation.",
+                    "description": "[Output-only] Cluster UUID for the operation.",
                     "type": "string"
                 },
                 "status": {
                     "$ref": "ClusterOperationStatus",
                     "description": "[Output-only] Current operation status."
                 },
                 "statusHistory": {
                     "description": "[Output-only] The previous operation status.",
                     "items": {
                         "$ref": "ClusterOperationStatus"
                     },
                     "type": "array"
                 },
                 "operationType": {
                     "description": "[Output-only] The operation type.",
                     "type": "string"
                 },
                 "description": {
                     "description": "[Output-only] Short description of operation.",
                     "type": "string"
+                },
+                "labels": {
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "[Output-only] labels associated with the operation",
+                    "type": "object"
                 }
             },
             "type": "object"
         },
         "ClusterOperationStatus": {
             "description": "The status of the operation.",
             "id": "ClusterOperationStatus",
             "properties": {
                 "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.",
+                    "description": "[Output-only] A message containing the detailed operation state.",
                     "type": "string"
                 },
                 "details": {
-                    "description": "A message containing any operation metadata details.",
+                    "description": "[Output-only]A message containing any operation metadata details.",
                     "type": "string"
                 },
                 "stateStartTime": {
-                    "description": "The time this state was entered.",
+                    "description": "[Output-only] The time this state was entered.",
                     "type": "string"
                 }
             },
             "type": "object"
         },
         "DiagnoseClusterOutputLocation": {
             "description": "The location where output from diagnostic command can be found.",
             "id": "DiagnoseClusterOutputLocation",
             "properties": {
                 "outputUri": {
@@ skipping 94 matching lines @@
                     "type": "string"
                 }
             },
             "type": "object"
         }
     },
     "servicePath": "",
     "title": "Google Cloud Dataproc API",
     "version": "v1beta1"
 }