openapi-directory
Version:
Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS
1 lines • 114 kB
JSON
{"openapi":"3.0.0","info":{"contact":{"name":"Google","url":"https://google.com"},"description":"A data platform for customers to create, manage, share and query data.","title":"BigQuery","version":"v2","x-apiClientRegistration":{"url":"https://console.developers.google.com"},"x-apisguru-categories":["search"],"x-logo":{"url":"https://cloud.google.com/_static/images/new-gcp-logo.png"},"x-origin":[{"converter":{"url":"https://github.com/lucybot/api-spec-converter","version":"2.7.18"},"format":"google","url":"https://www.googleapis.com/discovery/v1/apis/bigquery/v2/rest","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"bigquery"},"externalDocs":{"url":"https://cloud.google.com/bigquery/"},"tags":[{"name":"datasets"},{"name":"jobs"},{"name":"projects"},{"name":"tabledata"},{"name":"tables"}],"paths":{"/projects":{"get":{"description":"Lists all projects to which you have been granted any project role.","operationId":"bigquery.projects.list","parameters":[{"description":"Maximum number of results to return","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ProjectList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/projects/{projectId}/datasets":{"get":{"description":"Lists all datasets in the specified project to which you have been granted the READER dataset role.","operationId":"bigquery.datasets.list","parameters":[{"description":"Whether to list all datasets, including hidden ones","in":"query","name":"all","schema":{"type":"boolean"}},{"description":"An expression for filtering the results of the request by label. The syntax is \"labels.<name>[:<value>]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels for details.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The maximum number of results to return","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Project ID of the datasets to be listed","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DatasetList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["datasets"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a new empty dataset.","operationId":"bigquery.datasets.insert","parameters":[{"description":"Project ID of the new dataset","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Dataset"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["datasets"]}},"/projects/{projectId}/datasets/{datasetId}":{"delete":{"description":"Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.","operationId":"bigquery.datasets.delete","parameters":[{"description":"Dataset ID of dataset being deleted","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False","in":"query","name":"deleteContents","schema":{"type":"boolean"}},{"description":"Project ID of the dataset being deleted","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["datasets"]},"get":{"description":"Returns the dataset specified by datasetID.","operationId":"bigquery.datasets.get","parameters":[{"description":"Dataset ID of the requested dataset","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the requested dataset","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["datasets"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics.","operationId":"bigquery.datasets.patch","parameters":[{"description":"Dataset ID of the dataset being updated","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the dataset being updated","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Dataset"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["datasets"]},"put":{"description":"Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.","operationId":"bigquery.datasets.update","parameters":[{"description":"Dataset ID of the dataset being updated","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the dataset being updated","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Dataset"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["datasets"]}},"/projects/{projectId}/datasets/{datasetId}/tables":{"get":{"description":"Lists all tables in the specified dataset. Requires the READER dataset role.","operationId":"bigquery.tables.list","parameters":[{"description":"Dataset ID of the tables to list","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Project ID of the tables to list","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TableList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["tables"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Creates a new, empty table in the dataset.","operationId":"bigquery.tables.insert","parameters":[{"description":"Dataset ID of the new table","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the new table","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Table"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Table"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["tables"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}":{"delete":{"description":"Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.","operationId":"bigquery.tables.delete","parameters":[{"description":"Dataset ID of the table to delete","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the table to delete","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Table ID of the table to delete","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["tables"]},"get":{"description":"Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table.","operationId":"bigquery.tables.get","parameters":[{"description":"Dataset ID of the requested table","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the requested table","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"List of fields to return (comma-separated). If unspecified, all fields are returned","in":"query","name":"selectedFields","schema":{"type":"string"}},{"description":"Table ID of the requested table","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Table"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["tables"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"patch":{"description":"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics.","operationId":"bigquery.tables.patch","parameters":[{"description":"Dataset ID of the table to update","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the table to update","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Table ID of the table to update","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Table"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Table"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["tables"]},"put":{"description":"Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource.","operationId":"bigquery.tables.update","parameters":[{"description":"Dataset ID of the table to update","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the table to update","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Table ID of the table to update","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"requestBody":{"$ref":"#/components/requestBodies/Table"},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Table"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["tables"]}},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/data":{"get":{"description":"Retrieves table data from a specified set of rows. Requires the READER dataset role.","operationId":"bigquery.tabledata.list","parameters":[{"description":"Dataset ID of the table to read","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, identifying the result set","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Project ID of the table to read","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"List of fields to return (comma-separated). If unspecified, all fields are returned","in":"query","name":"selectedFields","schema":{"type":"string"}},{"description":"Zero-based index of the starting row to read","in":"query","name":"startIndex","schema":{"type":"string"}},{"description":"Table ID of the table to read","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TableDataList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["tabledata"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/projects/{projectId}/datasets/{datasetId}/tables/{tableId}/insertAll":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.","operationId":"bigquery.tabledata.insertAll","parameters":[{"description":"Dataset ID of the destination table.","in":"path","name":"datasetId","required":true,"schema":{"type":"string"}},{"description":"Project ID of the destination table.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Table ID of the destination table.","in":"path","name":"tableId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableDataInsertAllRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TableDataInsertAllResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/bigquery.insertdata"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["tabledata"]}},"/projects/{projectId}/jobs":{"get":{"description":"Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property.","operationId":"bigquery.jobs.list","parameters":[{"description":"Whether to display jobs owned by all users in the project. Default false","in":"query","name":"allUsers","schema":{"type":"boolean"}},{"description":"Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned","in":"query","name":"maxCreationTime","schema":{"type":"string"}},{"description":"Maximum number of results to return","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned","in":"query","name":"minCreationTime","schema":{"type":"string"}},{"description":"Page token, returned by a previous call, to request the next page of results","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"Project ID of the jobs to list","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Restrict information returned to a set of selected fields","in":"query","name":"projection","schema":{"type":"string","enum":["full","minimal"]}},{"description":"Filter for job state","in":"query","name":"stateFilter","explode":true,"schema":{"type":"array","items":{"enum":["done","pending","running"],"type":"string"}}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobList"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["jobs"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Starts a new asynchronous job. Requires the Can View project role.","operationId":"bigquery.jobs.insert","parameters":[{"description":"Project ID of the project that will be billed for the job","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/devstorage.full_control"]},{"Oauth2":["https://www.googleapis.com/auth/devstorage.read_only"]},{"Oauth2":["https://www.googleapis.com/auth/devstorage.read_write"]}],"tags":["jobs"]}},"/projects/{projectId}/jobs/{jobId}":{"get":{"description":"Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role.","operationId":"bigquery.jobs.get","parameters":[{"description":"[Required] Job ID of the requested job","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.","in":"query","name":"location","schema":{"type":"string"}},{"description":"[Required] Project ID of the requested job","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Job"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["jobs"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/projects/{projectId}/jobs/{jobId}/cancel":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs.","operationId":"bigquery.jobs.cancel","parameters":[{"description":"[Required] Job ID of the job to cancel","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"The geographic location of the job. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.","in":"query","name":"location","schema":{"type":"string"}},{"description":"[Required] Project ID of the job to cancel","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/JobCancelResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["jobs"]}},"/projects/{projectId}/queries":{"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}],"post":{"description":"Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.","operationId":"bigquery.jobs.query","parameters":[{"description":"Project ID of the project billed for the query","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QueryRequest"}}}},"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/QueryResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["jobs"]}},"/projects/{projectId}/queries/{jobId}":{"get":{"description":"Retrieves the results of a query job.","operationId":"bigquery.jobs.getQueryResults","parameters":[{"description":"[Required] Job ID of the query job","in":"path","name":"jobId","required":true,"schema":{"type":"string"}},{"description":"The geographic location where the job should run. Required except for US and EU. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.","in":"query","name":"location","schema":{"type":"string"}},{"description":"Maximum number of results to read","in":"query","name":"maxResults","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results","in":"query","name":"pageToken","schema":{"type":"string"}},{"description":"[Required] Project ID of the query job","in":"path","name":"projectId","required":true,"schema":{"type":"string"}},{"description":"Zero-based index of the starting row","in":"query","name":"startIndex","schema":{"type":"string"}},{"description":"How long to wait for the query to complete, in milliseconds, before returning. Default is 10 seconds. If the timeout passes before the job completes, the 'jobComplete' field in the response will be false","in":"query","name":"timeoutMs","schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetQueryResultsResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["jobs"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]},"/projects/{projectId}/serviceAccount":{"get":{"description":"Returns the email address of the service account for your project used for interactions with Google Cloud KMS.","operationId":"bigquery.projects.getServiceAccount","parameters":[{"description":"Project ID for which the service account is requested.","in":"path","name":"projectId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"*/*":{"schema":{"$ref":"#/components/schemas/GetServiceAccountResponse"}}}}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform.read-only"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/userIp"}]}},"servers":[{"url":"https://www.googleapis.com/bigquery/v2"}],"components":{"parameters":{"alt":{"description":"Data format for the response.","in":"query","name":"alt","schema":{"type":"string","enum":["json"],"default":"json"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean","default":true}},"quotaUser":{"description":"An opaque string that represents a user for quota purposes. Must not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"userIp":{"description":"Deprecated. Please use quotaUser instead.","in":"query","name":"userIp","schema":{"type":"string"}}},"requestBodies":{"Table":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Table"}}}},"Dataset":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dataset"}}}}},"securitySchemes":{"Oauth2":{"description":"Oauth 2.0 authentication","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://accounts.google.com/o/oauth2/auth","scopes":{"https://www.googleapis.com/auth/bigquery":"View and manage your data in Google BigQuery","https://www.googleapis.com/auth/bigquery.insertdata":"Insert data into Google BigQuery","https://www.googleapis.com/auth/cloud-platform":"View and manage your data across Google Cloud Platform services","https://www.googleapis.com/auth/cloud-platform.read-only":"View your data across Google Cloud Platform services","https://www.googleapis.com/auth/devstorage.full_control":"Manage your data and permissions in Google Cloud Storage","https://www.googleapis.com/auth/devstorage.read_only":"View your data in Google Cloud Storage","https://www.googleapis.com/auth/devstorage.read_write":"Manage your data in Google Cloud Storage"}}}}},"schemas":{"BigQueryModelTraining":{"properties":{"currentIteration":{"description":"[Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.","format":"int32","type":"integer"},"expectedTotalIterations":{"description":"[Output-only, Beta] Expected number of iterations for the create model query job specified as num_iterations in the input query. The actual total number of iterations may be less than this number due to early stop.","format":"int64","type":"string"}},"type":"object"},"BigtableColumn":{"properties":{"encoding":{"description":"[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column family level. However, the setting at this level takes precedence if 'encoding' is set at both levels.","type":"string"},"fieldName":{"description":"[Optional] If the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as the column field name and is used as field name in queries.","type":"string"},"onlyReadLatest":{"description":"[Optional] If this is set, only the latest version of value in this column are exposed. 'onlyReadLatest' can also be set at the column family level. However, the setting at this level takes precedence if 'onlyReadLatest' is set at both levels.","type":"boolean"},"qualifierEncoded":{"description":"[Required] Qualifier of the column. Columns in the parent column family that has this exact qualifier are exposed as . field. If the qualifier is valid UTF-8 string, it can be specified in the qualifier_string field. Otherwise, a base-64 encoded value must be set to qualifier_encoded. The column field name is the same as the column qualifier. However, if the qualifier is not a valid BigQuery field identifier i.e. does not match [a-zA-Z][a-zA-Z0-9_]*, a valid identifier must be provided as field_name.","format":"byte","type":"string"},"qualifierString":{"type":"string"},"type":{"description":"[Optional] The type to convert the value in cells of this column. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. 'type' can also be set at the column family level. However, the setting at this level takes precedence if 'type' is set at both levels.","type":"string"}},"type":"object"},"BigtableColumnFamily":{"properties":{"columns":{"description":"[Optional] Lists of columns that should be exposed as individual fields as opposed to a list of (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be accessed as .. Other columns can be accessed as a list through .Column field.","items":{"$ref":"#/components/schemas/BigtableColumn"},"type":"array"},"encoding":{"description":"[Optional] The encoding of the values when the type is not STRING. Acceptable encoding values are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are encoded using HBase Bytes.toBytes family of functions. This can be overridden for a specific column by listing that column in 'columns' and specifying an encoding for it.","type":"string"},"familyId":{"description":"Identifier of the column family.","type":"string"},"onlyReadLatest":{"description":"[Optional] If this is set only the latest version of value are exposed for all columns in this column family. This can be overridden for a specific column by listing that column in 'columns' and specifying a different setting for that column.","type":"boolean"},"type":{"description":"[Optional] The type to convert the value in cells of this column family. The values are expected to be encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following BigQuery types are allowed (case-sensitive) - BYTES STRING INTEGER FLOAT BOOLEAN Default type is BYTES. This can be overridden for a specific column by listing that column in 'columns' and specifying a type for it.","type":"string"}},"type":"object"},"BigtableOptions":{"properties":{"columnFamilies":{"description":"[Optional] List of column families to expose in the table schema along with their types. This list restricts the column families that can be referenced in queries and specifies their value types. You can use this list to do type conversions - see the 'type' field for more details. If you leave this list empty, all column families are present in the table schema and their values are read as BYTES. During a query only the column families referenced in that query are read from Bigtable.","items":{"$ref":"#/components/schemas/BigtableColumnFamily"},"type":"array"},"ignoreUnspecifiedColumnFamilies":{"description":"[Optional] If field is true, then the column families that are not specified in columnFamilies list are not exposed in the table schema. Otherwise, they are read with BYTES type values. The default value is false.","type":"boolean"},"readRowkeyAsString":{"description":"[Optional] If field is true, then the rowkey column families will be read and converted to string. Otherwise they are read with BYTES type values and users need to manually cast them with CAST if necessary. The default value is false.","type":"boolean"}},"type":"object"},"Clustering":{"properties":{"fields":{"description":"[Repeated] One or more fields on which data should be clustered. Only top-level, non-repeated, simple-type fields are supported. When you cluster a table using multiple columns, the order of columns you specify is important. The order of the specified columns determines the sort order of the data.","items":{"type":"string"},"type":"array"}},"type":"object"},"CsvOptions":{"properties":{"allowJaggedRows":{"description":"[Optional] Indicates if BigQuery should accept rows that are missing trailing optional columns. If true, BigQuery treats missing trailing columns as null values. If false, records with missing trailing columns are treated as bad records, and if there are too many bad records, an invalid error is returned in the job result. The default value is false.","type":"boolean"},"allowQuotedNewlines":{"description":"[Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.","type":"boolean"},"encoding":{"description":"[Optional] The character encoding of the data. The supported values are UTF-8 or ISO-8859-1. The default value is UTF-8. BigQuery decodes the data after the raw, binary data has been split using the values of the quote and fieldDelimiter properties.","type":"string"},"fieldDelimiter":{"description":"[Optional] The separator for fields in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. BigQuery also supports the escape sequence \"\\t\" to specify a tab separator. The default value is a comma (',').","type":"string"},"quote":{"default":"\"","description":"[Optional] The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the data in its raw, binary state. The default value is a double-quote ('\"'). If your data does not contain quoted sections, set the property value to an empty string. If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.","pattern":".?","type":"string"},"skipLeadingRows":{"description":"[Optional] The number of rows at the top of a CSV file that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.","format":"int64","type":"string"}},"type":"object"},"Dataset":{"properties":{"access":{"description":"[Optional] An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;","items":{"properties":{"domain":{"description":"[Pick one] A domain to grant access to. Any users signed in with the domain specified will be granted the specified access. Example: \"example.com\". Maps to IAM policy member \"domain:DOMAIN\".","type":"string"},"groupByEmail":{"description":"[Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member \"group:GROUP\".","type":"string"},"iamMember":{"description":"[Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.","type":"string"},"role":{"description":"[Required] Describes the rights granted to the user specified by the other member of the access object. The following string values are supported: READER, WRITER, OWNER.","type":"string"},"specialGroup":{"description":"[Pick one] A special group to grant access to. Possible values include: projectOwners: Owners of the enclosing project. projectReaders: Readers of the enclosing project. projectWriters: Writers of the enclosing project. allAuthenticatedUsers: All authenticated BigQuery users. Maps to similarly-named IAM members.","type":"string"},"userByEmail":{"description":"[Pick one] An email address of a user to grant access to. For example: fred@example.com. Maps to IAM policy member \"user:EMAIL\" or \"serviceAccount:EMAIL\".","type":"string"},"view":{"$ref":"#/components/schemas/TableReference"}},"type":"object"},"type":"array"},"creationTime":{"description":"[Output-only] The time when this dataset was created, in milliseconds since the epoch.","format":"int64","type":"string"},"datasetReference":{"$ref":"#/components/schemas/DatasetReference"},"defaultPartitionExpirationMs":{"description":"[Optional] The default partition expiration for all partitioned tables in the dataset, in milliseconds. Once this property is set, all newly-created partitioned tables in the dataset will have an expirationMs property in the timePartitioning settings set to this value, and changing the value will only affect new tables, not existing ones. The storage in a partition will have an expiration time of its partition time plus this value. Setting this property overrides the use of defaultTableExpirationMs for partitioned tables: only one of defaultTableExpirationMs and defaultPartitionExpirationMs will be used for any new partitioned table. If you provide an explicit timePartitioning.expirationMs when creating or updating a partitioned table, that value takes precedence over the default partition expiration time indicated by this property.","format":"int64","type":"string"},"defaultTableExpirationMs":{"description":"[Optional] The default lifetime of all tables in the dataset, in milliseconds. The minimum value is 3600000 milliseconds (one hour). Once this property is set, all newly-created tables in the dataset will have an expirationTime property set to the creation time plus the value in this property, and changing the value will only affect new tables, not existing ones. When the expirationTime for a given table is reached, that table will be deleted automatically. If a table's expirationTime is modified or removed before the table expires, or if you provide an explicit expirationTime when creating a table, that value takes precedence over the default expiration time indicated by this property.","format":"int64","type":"string"},"description":{"description":"[Optional] A user-friendly description of the dataset.","type":"string"},"etag":{"description":"[Output-only] A hash of the resource.","type":"string"},"friendlyName":{"description":"[Optional] A descriptive name for the dataset.","type":"string"},"id":{"description":"[Output-only] The fully-qualified unique name of the dataset in the format projectId:datasetId. The dataset name without the project name is given in the datasetId field. When creating a new dataset, leave this field blank, and instead specify the datasetId field.","type":"string"},"kind":{"default":"bigquery#dataset","description":"[Output-only] The resource type.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See Creating and Updating Dataset Labels for more information.","type":"object"},"lastModifiedTime":{"description":"[Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.","format":"int64","type":"string"},"location":{"description":"The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.","type":"string"},"selfLink":{"description":"[Output-only] A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.","type":"string"}},"type":"object"},"DatasetList":{"properties":{"datasets":{"description":"An array of the dataset resources in the project. Each resource contains basic information. For full information about a particular dataset resource, use the Datasets: get method. This property is omitted when there are no datasets in the project.","items":{"properties":{"datasetReference":{"$ref":"#/components/schemas/DatasetReference"},"friendlyName":{"description":"A descriptive name for the dataset, if one exists.","type":"string"},"id":{"description":"The fully-qualified, unique, opaque ID of the dataset.","type":"string"},"kind":{"default":"bigquery#dataset","description":"The resource type. This property always returns the value \"bigquery#dataset\".","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"The labels associated with this dataset. You can use these to organize and group your datasets.","type":"object"},"location":{"description":"The geographic location where the data resides.","type":"string"}},"type":"object"},"type":"array"},"etag":{"description":"A hash value of the results page. You can use this property to determine if the page has changed since the last request.","type":"string"},"kind":{"default":"bigquery#datasetList","description":"The list type. This property always returns the value \"bigquery#datasetList\".","type":"string"},"nextPageToken":{"description":"A token that can be used to request the next results page. This property is omitted on the final results page.","type":"string"}},"type":"object"},"DatasetReference":{"properties":{"datasetId":{"description":"[Required] A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"[Optional] The ID of the project containing this dataset.","type":"string"}},"type":"object"},"DestinationTableProperties":{"properties":{"description":{"description":"[Optional] The description for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current description is provided, the job will fail.","type":"string"},"friendlyName":{"description":"[Optional] The friendly name for the destination table. This will only be used if the destination table is newly created. If the table already exists and a value different than the current friendly name is provided, the job will fail.","type":"string"}},"type":"object"},"EncryptionConfiguration":{"properties":{"kmsKeyName":{"description":"[Optional] Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table. The BigQuery Service Account associated with your project requires access to this encryption key.","type":"string"}},"type":"object"},"ErrorProto":{"properties":{"debugInfo":{"description":"Debugging information. This property is internal to Google and should not be used.","type":"string"},"location":{"description":"Specifies where the error occurred, if present.","type":"string"},"message":{"description":"A human-readable description of the error.","type":"string"},"reason":{"description":"A short error code that summarizes the error.","type":"string"}},"type":"object"},"ExplainQueryStage":{"properties":{"completedParallelInputs":{"description":"Number of parallel input segments completed.","format":"int64","type":"string"},"computeMsAvg":{"description":"Milliseconds the average shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeMsMax":{"description":"Milliseconds the slowest shard spent on CPU-bound tasks.","format":"int64","type":"string"},"computeRatioAvg":{"description":"Relative amount of time the average shard spent on CPU-bound tasks.","format":"double","type":"number"},"computeRatioMax":{"description":"Relative amount of time the slowest shard spent on CPU-bound tasks.","format":"double","type":"number"},"endMs":{"description":"Stage end time represented as milliseconds since epoch.","format":"int64","type":"string"},"id":{"description":"Unique ID for stage within plan.","format":"int64","type":"string"},"inputStages":{"description":"IDs for stages that are inputs to this stage.","items":{"format":"int64","type":"string"},"type":"array"},"name":{"description":"Human-readable name for stage.","type":"string"},"parallelInputs":{"description":"Number of parallel input segments to be processed.","format":"int64","type":"string"},"readMsAvg":{"description":"Milliseconds the average shard spent reading input.","format":"int64","type":"string"},"readMsMax":{"description":"Milliseconds the slowest shard spent reading input.","format":"int64","type":"string"},"readRatioAvg":{"description":"Relative amount of time the average shard spent reading input.","format":"double","type":"number"},"readRatioMax":{"description":"Relative amount of time the slowest shard spent reading input.","format":"double","type":"number"},"recordsRead":{"description":"Number of records read into the stage.","format":"int64","type":"string"},"recordsWritten":{"description":"Number of records written by the stage.","format":"int64","type":"string"},"shuffleOutputBytes":{"description":"Total number of bytes written to shuffle.","format":"int64","type":"string"},"shuffleOutputBytesSpilled":{"description":"Total number of bytes written to shuffle and spilled to disk.","format":"int64","type":"string"},"startMs":{"description":"Stage start time represented as milliseconds since epoch.","format":"int64","type":"string"},"status":{"description":"Current status for the stage.","type":"string"},"steps":{"description":"List of operations within the stage in dependency order (approximately chronological).","items":{"$ref":"#/components/schemas/ExplainQueryStep"},"type":"array"},"waitMsAvg":{"description"