npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/google_bigquery

v6.0.0

Published

DataFire integration for BigQuery API

Downloads

5

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/google_bigquery

Client library for BigQuery API

Installation and Usage

npm install --save @datafire/google_bigquery
let google_bigquery = require('@datafire/google_bigquery').create({
  access_token: "",
  refresh_token: "",
  client_id: "",
  client_secret: "",
  redirect_uri: ""
});

.then(data => {
  console.log(data);
});

Description

A data platform for customers to create, manage, share and query data.

Actions

oauthCallback

Exchange the code passed to your redirect URI for an access_token

google_bigquery.oauthCallback({
  "code": ""
}, context)

Input

  • input object
    • code required string

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

oauthRefresh

Exchange a refresh_token for an access_token

google_bigquery.oauthRefresh(null, context)

Input

This action has no parameters

Output

  • output object
    • access_token string
    • refresh_token string
    • token_type string
    • scope string
    • expiration string

bigquery.projects.list

Lists all projects to which you have been granted any project role.

google_bigquery.bigquery.projects.list({}, context)

Input

  • input object
    • maxResults integer: Maximum number of results to return
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.datasets.list

Lists all datasets in the specified project to which you have been granted the READER dataset role.

google_bigquery.bigquery.datasets.list({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the datasets to be listed
    • all boolean: Whether to list all datasets, including hidden ones
    • filter string: An expression for filtering the results of the request by label. The syntax is "labels.[:]". Multiple filters can be ANDed together by connecting with a space. Example: "labels.department:receiving labels.active". See Filtering datasets using labels for details.
    • maxResults integer: The maximum number of results to return
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.datasets.insert

Creates a new empty dataset.

google_bigquery.bigquery.datasets.insert({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the new dataset
    • body Dataset
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.datasets.delete

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.

google_bigquery.bigquery.datasets.delete({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the dataset being deleted
    • datasetId required string: Dataset ID of dataset being deleted
    • deleteContents boolean: If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

bigquery.datasets.get

Returns the dataset specified by datasetID.

google_bigquery.bigquery.datasets.get({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the requested dataset
    • datasetId required string: Dataset ID of the requested dataset
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.datasets.patch

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.

google_bigquery.bigquery.datasets.patch({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the dataset being updated
    • datasetId required string: Dataset ID of the dataset being updated
    • body Dataset
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.datasets.update

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.

google_bigquery.bigquery.datasets.update({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the dataset being updated
    • datasetId required string: Dataset ID of the dataset being updated
    • body Dataset
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.models.list

Lists all models in the specified dataset. Requires the READER dataset role.

google_bigquery.bigquery.models.list({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the models to list.
    • datasetId required string: Required. Dataset ID of the models to list.
    • maxResults integer: The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
    • pageToken string: Page token, returned by a previous call to request the next page of results
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.models.delete

Deletes the model specified by modelId from the dataset.

google_bigquery.bigquery.models.delete({
  "projectId": "",
  "datasetId": "",
  "modelId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the model to delete.
    • datasetId required string: Required. Dataset ID of the model to delete.
    • modelId required string: Required. Model ID of the model to delete.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

bigquery.models.get

Gets the specified model resource by model ID.

google_bigquery.bigquery.models.get({
  "projectId": "",
  "datasetId": "",
  "modelId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the requested model.
    • datasetId required string: Required. Dataset ID of the requested model.
    • modelId required string: Required. Model ID of the requested model.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.models.patch

Patch specific fields in the specified model.

google_bigquery.bigquery.models.patch({
  "projectId": "",
  "datasetId": "",
  "modelId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the model to patch.
    • datasetId required string: Required. Dataset ID of the model to patch.
    • modelId required string: Required. Model ID of the model to patch.
    • body Model
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.routines.list

Lists all routines in the specified dataset. Requires the READER dataset role.

google_bigquery.bigquery.routines.list({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the routines to list
    • datasetId required string: Required. Dataset ID of the routines to list
    • filter string: If set, then only the Routines matching this filter are returned. The current supported form is either "routine_type:" or "routineType:", where is a RoutineType enum. Example: "routineType:SCALAR_FUNCTION".
    • maxResults integer: The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • readMask string: If set, then only the Routine fields in the field mask, as well as project_id, dataset_id and routine_id, are returned in the response. If unset, then the following Routine fields are returned: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.routines.insert

Creates a new routine in the dataset.

google_bigquery.bigquery.routines.insert({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the new routine
    • datasetId required string: Required. Dataset ID of the new routine
    • body Routine
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.routines.delete

Deletes the routine specified by routineId from the dataset.

google_bigquery.bigquery.routines.delete({
  "projectId": "",
  "datasetId": "",
  "routineId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the routine to delete
    • datasetId required string: Required. Dataset ID of the routine to delete
    • routineId required string: Required. Routine ID of the routine to delete
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

bigquery.routines.get

Gets the specified routine resource by routine ID.

google_bigquery.bigquery.routines.get({
  "projectId": "",
  "datasetId": "",
  "routineId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the requested routine
    • datasetId required string: Required. Dataset ID of the requested routine
    • routineId required string: Required. Routine ID of the requested routine
    • readMask string: If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.routines.update

Updates information in an existing routine. The update method replaces the entire Routine resource.

google_bigquery.bigquery.routines.update({
  "projectId": "",
  "datasetId": "",
  "routineId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the routine to update
    • datasetId required string: Required. Dataset ID of the routine to update
    • routineId required string: Required. Routine ID of the routine to update
    • body Routine
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.list

Lists all tables in the specified dataset. Requires the READER dataset role.

google_bigquery.bigquery.tables.list({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the tables to list
    • datasetId required string: Dataset ID of the tables to list
    • maxResults integer: Maximum number of results to return
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.insert

Creates a new, empty table in the dataset.

google_bigquery.bigquery.tables.insert({
  "projectId": "",
  "datasetId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the new table
    • datasetId required string: Dataset ID of the new table
    • body Table
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.delete

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted.

google_bigquery.bigquery.tables.delete({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the table to delete
    • datasetId required string: Dataset ID of the table to delete
    • tableId required string: Table ID of the table to delete
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Output schema unknown

bigquery.tables.get

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.

google_bigquery.bigquery.tables.get({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the requested table
    • datasetId required string: Dataset ID of the requested table
    • tableId required string: Table ID of the requested table
    • selectedFields string: List of fields to return (comma-separated). If unspecified, all fields are returned
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.patch

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.

google_bigquery.bigquery.tables.patch({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the table to update
    • datasetId required string: Dataset ID of the table to update
    • tableId required string: Table ID of the table to update
    • body Table
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.update

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.

google_bigquery.bigquery.tables.update({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the table to update
    • datasetId required string: Dataset ID of the table to update
    • tableId required string: Table ID of the table to update
    • body Table
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tabledata.list

Retrieves table data from a specified set of rows. Requires the READER dataset role.

google_bigquery.bigquery.tabledata.list({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the table to read
    • datasetId required string: Dataset ID of the table to read
    • tableId required string: Table ID of the table to read
    • maxResults integer: Maximum number of results to return
    • pageToken string: Page token, returned by a previous call, identifying the result set
    • selectedFields string: List of fields to return (comma-separated). If unspecified, all fields are returned
    • startIndex string: Zero-based index of the starting row to read
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tabledata.insertAll

Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role.

google_bigquery.bigquery.tabledata.insertAll({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the destination table.
    • datasetId required string: Dataset ID of the destination table.
    • tableId required string: Table ID of the destination table.
    • body TableDataInsertAllRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.rowAccessPolicies.list

Lists all row access policies on the specified table.

google_bigquery.bigquery.rowAccessPolicies.list({
  "projectId": "",
  "datasetId": "",
  "tableId": ""
}, context)

Input

  • input object
    • projectId required string: Required. Project ID of the row access policies to list.
    • datasetId required string: Required. Dataset ID of row access policies to list.
    • tableId required string: Required. Table ID of the table to list row access policies.
    • pageSize integer: The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.
    • pageToken string: Page token, returned by a previous call, to request the next page of results.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.list

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.

google_bigquery.bigquery.jobs.list({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the jobs to list
    • allUsers boolean: Whether to display jobs owned by all users in the project. Default false
    • maxCreationTime string: Max value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created before or at this timestamp are returned
    • maxResults integer: Maximum number of results to return
    • minCreationTime string: Min value for job creation time, in milliseconds since the POSIX epoch. If set, only jobs created after or at this timestamp are returned
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • parentJobId string: If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent
    • projection string (values: full, minimal): Restrict information returned to a set of selected fields
    • stateFilter array: Filter for job state
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.insert

Starts a new asynchronous job. Requires the Can View project role.

google_bigquery.bigquery.jobs.insert({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the project that will be billed for the job
    • body Job
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.get

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.

google_bigquery.bigquery.jobs.get({
  "projectId": "",
  "jobId": ""
}, context)

Input

  • input object
    • projectId required string: [Required] Project ID of the requested job
    • jobId required string: [Required] Job ID of the requested job
    • location string: 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.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.cancel

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.

google_bigquery.bigquery.jobs.cancel({
  "projectId": "",
  "jobId": ""
}, context)

Input

  • input object
    • projectId required string: [Required] Project ID of the job to cancel
    • jobId required string: [Required] Job ID of the job to cancel
    • location string: 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.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.query

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout.

google_bigquery.bigquery.jobs.query({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID of the project billed for the query
    • body QueryRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.jobs.getQueryResults

Retrieves the results of a query job.

google_bigquery.bigquery.jobs.getQueryResults({
  "projectId": "",
  "jobId": ""
}, context)

Input

  • input object
    • projectId required string: [Required] Project ID of the query job
    • jobId required string: [Required] Job ID of the query job
    • location string: 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.
    • maxResults integer: Maximum number of results to read
    • pageToken string: Page token, returned by a previous call, to request the next page of results
    • startIndex string: Zero-based index of the starting row
    • timeoutMs integer: 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
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.projects.getServiceAccount

Returns the email address of the service account for your project used for interactions with Google Cloud KMS.

google_bigquery.bigquery.projects.getServiceAccount({
  "projectId": ""
}, context)

Input

  • input object
    • projectId required string: Project ID for which the service account is requested.
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.getIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

google_bigquery.bigquery.tables.getIamPolicy({
  "resource": ""
}, context)

Input

  • input object
    • resource required string: REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
    • body GetIamPolicyRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.setIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

google_bigquery.bigquery.tables.setIamPolicy({
  "resource": ""
}, context)

Input

  • input object
    • resource required string: REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
    • body SetIamPolicyRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

bigquery.tables.testIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

google_bigquery.bigquery.tables.testIamPermissions({
  "resource": ""
}, context)

Input

  • input object
    • resource required string: REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
    • body TestIamPermissionsRequest
    • alt string (values: json): Data format for the response.
    • fields string: Selector specifying which fields to include in a partial response.
    • key string: 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.
    • oauth_token string: OAuth 2.0 token for the current user.
    • prettyPrint boolean: Returns response with indentations and line breaks.
    • quotaUser string: An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    • userIp string: Deprecated. Please use quotaUser instead.

Output

Definitions

AggregateClassificationMetrics

  • AggregateClassificationMetrics object: Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.
    • accuracy number: Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.
    • f1Score number: The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.
    • logLoss number: Logarithmic Loss. For multiclass this is a macro-averaged metric.
    • precision number: Precision is the fraction of actual positive predictions that had positive actual labels. For multiclass this is a macro-averaged metric treating each class as a binary classifier.
    • recall number: Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.
    • rocAuc number: Area Under a ROC Curve. For multiclass this is a macro-averaged metric.
    • threshold number: Threshold at which the metrics are computed. For binary classification models this is the positive class threshold. For multi-class classfication models this is the confidence threshold.

Argument

  • Argument object: Input/output argument of a function or a stored procedure.
    • argumentKind string (values: ARGUMENT_KIND_UNSPECIFIED, FIXED_TYPE, ANY_TYPE): Optional. Defaults to FIXED_TYPE.
    • dataType StandardSqlDataType
    • mode string (values: MODE_UNSPECIFIED, IN, OUT, INOUT): Optional. Specifies whether the argument is input or output. Can be set for procedures only.
    • name string: Optional. The name of this argument. Can be absent for function return argument.

ArimaCoefficients

  • ArimaCoefficients object: Arima coefficients.
    • autoRegressiveCoefficients array: Auto-regressive coefficients, an array of double.
      • items number
    • interceptCoefficient number: Intercept coefficient, just a double not an array.
    • movingAverageCoefficients array: Moving-average coefficients, an array of double.
      • items number

ArimaFittingMetrics

  • ArimaFittingMetrics object: ARIMA model fitting metrics.
    • aic number: AIC.
    • logLikelihood number: Log-likelihood.
    • variance number: Variance.

ArimaForecastingMetrics

  • ArimaForecastingMetrics object: Model evaluation metrics for ARIMA forecasting models.
    • arimaFittingMetrics array: Arima model fitting metrics.
    • arimaSingleModelForecastingMetrics array: Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.
    • hasDrift array: Whether Arima model fitted with drift or not. It is always false when d is not 1.
      • items boolean
    • nonSeasonalOrder array: Non-seasonal order.
    • seasonalPeriods array: Seasonal periods. Repeated because multiple periods are supported for one time series.
      • items string (values: SEASONAL_PERIOD_TYPE_UNSPECIFIED, NO_SEASONALITY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)
    • timeSeriesId array: Id to differentiate different time series for the large-scale case.
      • items string

ArimaModelInfo

  • ArimaModelInfo object: Arima model information.
    • arimaCoefficients ArimaCoefficients
    • arimaFittingMetrics ArimaFittingMetrics
    • hasDrift boolean: Whether Arima model fitted with drift or not. It is always false when d is not 1.
    • nonSeasonalOrder ArimaOrder
    • seasonalPeriods array: Seasonal periods. Repeated because multiple periods are supported for one time series.
      • items string (values: SEASONAL_PERIOD_TYPE_UNSPECIFIED, NO_SEASONALITY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)
    • timeSeriesId string: The id to indicate different time series.

ArimaOrder

  • ArimaOrder object: Arima order, can be used for both non-seasonal and seasonal parts.
    • d string: Order of the differencing part.
    • p string: Order of the autoregressive part.
    • q string: Order of the moving-average part.

ArimaResult

  • ArimaResult object: (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.
    • arimaModelInfo array: This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.
    • seasonalPeriods array: Seasonal periods. Repeated because multiple periods are supported for one time series.
      • items string (values: SEASONAL_PERIOD_TYPE_UNSPECIFIED, NO_SEASONALITY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)

ArimaSingleModelForecastingMetrics

  • ArimaSingleModelForecastingMetrics object: Model evaluation metrics for a single ARIMA forecasting model.
    • arimaFittingMetrics ArimaFittingMetrics
    • hasDrift boolean: Is arima model fitted with drift or not. It is always false when d is not 1.
    • nonSeasonalOrder ArimaOrder
    • seasonalPeriods array: Seasonal periods. Repeated because multiple periods are supported for one time series.
      • items string (values: SEASONAL_PERIOD_TYPE_UNSPECIFIED, NO_SEASONALITY, DAILY, WEEKLY, MONTHLY, QUARTERLY, YEARLY)
    • timeSeriesId string: The id to indicate different time series.

AuditConfig

  • AuditConfig object: Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[email protected]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [email protected] from DATA_READ logging, and [email protected] from DATA_WRITE logging.
    • auditLogConfigs array: The configuration for logging of each type of permission.
    • service string: Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.

AuditLogConfig

  • AuditLogConfig object: Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[email protected]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [email protected] from DATA_READ logging.
    • exemptedMembers array: Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
      • items string
    • logType string (values: LOG_TYPE_UNSPECIFIED, ADMIN_READ, DATA_WRITE, DATA_READ): The log type that this config enables.

BigQueryModelTraining

  • BigQueryModelTraining object
    • currentIteration integer: [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress.
    • expectedTotalIterations string: [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.

BigtableColumn

  • BigtableColumn object
    • encoding string: [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.
    • fieldName string: [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.
    • onlyReadLatest boolean: [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.
    • qualifierEncoded string: [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.
    • qualifierString string
    • type string: [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.

BigtableColumnFamily

  • BigtableColumnFamily object
    • columns array: [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.
    • encoding string: [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.
    • familyId string: Identifier of the column family.
    • onlyReadLatest boolean: [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 string: [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.

BigtableOptions

  • BigtableOptions object
    • columnFamilies array: [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.
    • ignoreUnspecifiedColumnFamilies boolean: [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.
    • readRowkeyAsString boolean: [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.

BinaryClassificationMetrics

  • BinaryClassificationMetrics object: Evaluation metrics for binary classification/classifier models.
    • aggregateClassificationMetrics AggregateClassificationMetrics
    • binaryConfusionMatrixList array: Binary confusion matrix at multiple thresholds.
    • negativeLabel string: Label representing the negative class.
    • positiveLabel string: Label representing the positive class.

BinaryConfusionMatrix

  • BinaryConfusionMatrix object: Confusion matrix for binary classification models.
    • accuracy number: The fraction of predictions given the correct label.
    • f1Score number: The equally weighted average of recall and precision.
    • falseNegatives string: Number of false samples predicted as false.
    • falsePositives string: Number of false samples predicted as true.
    • positiveClassThreshold number: Threshold value used when computing each of the following metric.
    • precision number: The fraction of actual positive predictions that had positive actual labels.
    • recall number: The fraction of actual positive labels that were given a positive prediction.
    • trueNegatives string: Number of true samples predicted as false.
    • truePositives string: Number of true samples predicted as true.

Binding

  • Binding object: Associates members with a role.
    • bindingId string
    • condition Expr
    • members array: Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: * allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. * allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. * user:{emailid}: An email address that represents a specific Google account. For example, [email protected] . * serviceAccount:{emailid}: An email address that represents a service account. For example, [email protected]. * group:{emailid}: An email address that represents a Google group. For example, [email protected]. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. * deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. * deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, [email protected]?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. * domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.
      • items string
    • role string: Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

BqmlIterationResult

  • BqmlIterationResult object
    • durationMs string: [Output-only, Beta] Time taken to run the training iteration in milliseconds.
    • evalLoss number: [Output-only, Beta] Eval loss computed on the eval data at the end of the iteration. The eval loss is used for early stopping to avoid overfitting. No eval loss if eval_split_method option is specified as no_split or auto_split with input data size less than 500 rows.
    • index integer: [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.
    • learnRate number: [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.
    • trainingLoss number: [Output-only, Beta] Training loss computed on the training data at the end of the iteration. The training loss function is defined by model type.

BqmlTrainingRun

  • BqmlTrainingRun object
    • iterationResults array: [Output-only, Beta] List of each iteration results.
    • startTime string: [Output-only, Beta] Training run start time in milliseconds since the epoch.
    • state string: [Output-only, Beta] Different state applicable for a training run. IN PROGRESS: Training run is in progress. FAILED: Training run ended due to a non-retryable failure. SUCCEEDED: Training run successfully completed. CANCELLED: Training run cancelled by the user.
    • trainingOptions object: [Output-only, Beta] Training options used by this training run. These options are mutable for subsequent training runs. Default values are explicitly stored for options not specified in the input query of the first training run. For subsequent training runs, any option not explicitly specified in the input query will be copied from the previous training run.
      • earlyStop boolean
      • l1Reg number
      • l2Reg number
      • learnRate number
      • learnRateStrategy string
      • lineSearchInitLearnRate number
      • maxIteration string
      • minRelProgress number
      • warmStart boolean

CategoricalValue

  • CategoricalValue object: Representative value of a categorical feature.
    • categoryCounts array: Counts of all categories for the categorical feature. If there are more than ten categories, we return top ten (by count) and return one more CategoryCount with category "OTHER" and count as aggregate counts of remaining categories.

CategoryCount

  • CategoryCount object: Represents the count of a