Module googleapis.bigquery

ballerinax/googleapis.bigquery Ballerina library

1.5.1

Overview

This is a generated connector for Google BigQuery API v2.0 OpenAPI specification. The BigQuery API provides access to create, manage, share and query data.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Create a Google account
Obtain tokens
1. Follow this link

Quickstart

To use the Google BigQuery connector in your Ballerina application, update the .bal file as follows:

Step 1: Import connector

First, import the ballerinax/googleapis.bigquery module into the Ballerina project.


import ballerinax/googleapis.bigquery;

Step 2: Create a new connector instance

Create a bigquery:ClientConfig with the OAuth2 tokens obtained, and initialize the connector with it.


bigquery:ClientConfig clientConfig = {auth : {token: "<Your access token>"}};
bigquery:Client baseClient = check new Client(clientConfig);

Step 3: Invoke connector operation

Now you can invoke the connector operations as follows,

List projects


public function main() returns error? {
    bigquery:ProjectList projectList = check baseClient->listProjects();
}

Use bal run command to compile and run the Ballerina program.

Clients

googleapis.bigquery: Client

Isolated

This is a generated connector for Google BigQuery API v2.0 OpenAPI specification. The BigQuery API provides access to create, manage, share and query data.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an google account and obtain tokens following this guide

init (ConnectionConfig config, string serviceUrl)

config ConnectionConfig - The configurations to be used when initializing the connector

serviceUrl string "https://bigquery.googleapis.com/bigquery/v2" - URL of the target service

listProjects

Isolated FunctionRemote Function

function listProjects(string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, int? maxResults, string? pageToken) returns ProjectList|error

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

Parameters

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

maxResults int? (default ()) - Maximum number of results to return

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results

Return Type

ProjectList|error - Successful response

listDatasets

Isolated FunctionRemote Function

function listDatasets(string projectId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, boolean? 'all, string? filter, int? maxResults, string? pageToken) returns DatasetList|error

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

Parameters

projectId string - Project ID of the datasets to be listed

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

'all boolean? (default ()) - Whether to list all datasets, including hidden ones

filter string? (default ()) - 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.

maxResults int? (default ()) - The maximum number of results to return

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results

Return Type

DatasetList|error - Successful response

insertDataset

Isolated FunctionRemote Function

function insertDataset(string projectId, Dataset payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Dataset|error

Creates a new empty dataset.

Parameters

projectId string - Project ID of the new dataset

payload Dataset - Dataset Detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Dataset|error - Successful response

getDataset

Isolated FunctionRemote Function

function getDataset(string projectId, string datasetId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Dataset|error

Returns the dataset specified by datasetID.

Parameters

projectId string - Project ID of the requested dataset

datasetId string - Dataset ID of the requested dataset

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Dataset|error - Successful response

updateDataset

Isolated FunctionRemote Function

function updateDataset(string projectId, string datasetId, Dataset payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Dataset|error

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.

Parameters

projectId string - Project ID of the dataset being updated

datasetId string - Dataset ID of the dataset being updated

payload Dataset - Dataset detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Dataset|error - Successful response

deleteDataset

Isolated FunctionRemote Function

function deleteDataset(string projectId, string datasetId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, boolean? deleteContents) returns Response|error

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.

Parameters

projectId string - Project ID of the dataset being deleted

datasetId string - Dataset ID of dataset being deleted

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

deleteContents boolean? (default ()) - If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

Return Type

Response|error - Successful response

patchDataset

Isolated FunctionRemote Function

function patchDataset(string projectId, string datasetId, Dataset payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Dataset|error

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.

Parameters

projectId string - Project ID of the dataset being updated

datasetId string - Dataset ID of the dataset being updated

payload Dataset - Dataset detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Dataset|error - Successful response

listModel

Isolated FunctionRemote Function

function listModel(string projectId, string datasetId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, int? maxResults, string? pageToken) returns ListModelsResponse|error

Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method.

Parameters

projectId string - Required. Project ID of the models to list.

datasetId string - Required. Dataset ID of the models to list.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

maxResults int? (default ()) - The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

pageToken string? (default ()) - Page token, returned by a previous call to request the next page of results

Return Type

ListModelsResponse|error - Successful response

getModel

Isolated FunctionRemote Function

function getModel(string projectId, string datasetId, string modelId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Model|error

Gets the specified model resource by model ID.

Parameters

projectId string - Required. Project ID of the requested model.

datasetId string - Required. Dataset ID of the requested model.

modelId string - Required. Model ID of the requested model.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Model|error - Successful response

deleteModel

Isolated FunctionRemote Function

function deleteModel(string projectId, string datasetId, string modelId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Response|error

Deletes the model specified by modelId from the dataset.

Parameters

projectId string - Required. Project ID of the model to delete.

datasetId string - Required. Dataset ID of the model to delete.

modelId string - Required. Model ID of the model to delete.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Response|error - Successful response

patchModel

Isolated FunctionRemote Function

function patchModel(string projectId, string datasetId, string modelId, Model payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Model|error

Patch specific fields in the specified model.

Parameters

projectId string - Required. Project ID of the model to patch.

datasetId string - Required. Dataset ID of the model to patch.

modelId string - Required. Model ID of the model to patch.

payload Model - Model detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Model|error - Successful response

listRoutines

Isolated FunctionRemote Function

function listRoutines(string projectId, string datasetId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? filter, int? maxResults, string? pageToken, string? readMask) returns ListRoutinesResponse|error

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

Parameters

projectId string - Required. Project ID of the routines to list

datasetId string - Required. Dataset ID of the routines to list

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

filter string? (default ()) - 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 int? (default ()) - The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results

readMask string? (default ()) - 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.

Return Type

ListRoutinesResponse|error - Successful response

insertRoutine

Isolated FunctionRemote Function

function insertRoutine(string projectId, string datasetId, Routine payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Routine|error

Creates a new routine in the dataset.

Parameters

projectId string - Required. Project ID of the new routine

datasetId string - Required. Dataset ID of the new routine

payload Routine - Routine detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Routine|error - Successful response

getRoutine

Isolated FunctionRemote Function

function getRoutine(string projectId, string datasetId, string routineId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? readMask) returns Routine|error

Gets the specified routine resource by routine ID.

Parameters

projectId string - Required. Project ID of the requested routine

datasetId string - Required. Dataset ID of the requested routine

routineId string - Required. Routine ID of the requested routine

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

readMask string? (default ()) - If set, only the Routine fields in the field mask are returned in the response. If unset, all Routine fields are returned.

Return Type

Routine|error - Successful response

updateRoutine

Isolated FunctionRemote Function

function updateRoutine(string projectId, string datasetId, string routineId, Routine payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Routine|error

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

Parameters

projectId string - Required. Project ID of the routine to update

datasetId string - Required. Dataset ID of the routine to update

routineId string - Required. Routine ID of the routine to update

payload Routine - Routine detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Routine|error - Successful response

deleteRoutine

Isolated FunctionRemote Function

function deleteRoutine(string projectId, string datasetId, string routineId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Response|error

Deletes the routine specified by routineId from the dataset.

Parameters

projectId string - Required. Project ID of the routine to delete

datasetId string - Required. Dataset ID of the routine to delete

routineId string - Required. Routine ID of the routine to delete

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Response|error - Successful response

listTables

Isolated FunctionRemote Function

function listTables(string projectId, string datasetId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, int? maxResults, string? pageToken) returns TableList|error

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

Parameters

projectId string - Project ID of the tables to list

datasetId string - Dataset ID of the tables to list

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

maxResults int? (default ()) - Maximum number of results to return

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results

Return Type

TableList|error - Successful response

insertTable

Isolated FunctionRemote Function

function insertTable(string projectId, string datasetId, Table payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Table|error

Creates a new, empty table in the dataset.

Parameters

projectId string - Project ID of the new table

datasetId string - Dataset ID of the new table

payload Table - Table detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Table|error - Successful response

getTable

Isolated FunctionRemote Function

function getTable(string projectId, string datasetId, string tableId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? selectedFields) returns Table|error

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.

Parameters

projectId string - Project ID of the requested table

datasetId string - Dataset ID of the requested table

tableId string - Table ID of the requested table

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

selectedFields string? (default ()) - List of fields to return (comma-separated). If unspecified, all fields are returned

Return Type

Table|error - Successful response

updateTable

Isolated FunctionRemote Function

function updateTable(string projectId, string datasetId, string tableId, Table payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Table|error

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.

Parameters

projectId string - Project ID of the table to update

datasetId string - Dataset ID of the table to update

tableId string - Table ID of the table to update

payload Table - Table detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Table|error - Successful response

deleteTable

Isolated FunctionRemote Function

function deleteTable(string projectId, string datasetId, string tableId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Response|error

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

Parameters

projectId string - Project ID of the table to delete

datasetId string - Dataset ID of the table to delete

tableId string - Table ID of the table to delete

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Response|error - Successful response

patchTable

Isolated FunctionRemote Function

function patchTable(string projectId, string datasetId, string tableId, Table payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Table|error

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.

Parameters

projectId string - Project ID of the table to update

datasetId string - Dataset ID of the table to update

tableId string - Table ID of the table to update

payload Table - Table detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Table|error - Successful response

listTableData

Isolated FunctionRemote Function

function listTableData(string projectId, string datasetId, string tableId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, int? maxResults, string? pageToken, string? selectedFields, string? startIndex) returns TableDataList|error

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

Parameters

projectId string - Project ID of the table to read

datasetId string - Dataset ID of the table to read

tableId string - Table ID of the table to read

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

maxResults int? (default ()) - Maximum number of results to return

pageToken string? (default ()) - Page token, returned by a previous call, identifying the result set

selectedFields string? (default ()) - List of fields to return (comma-separated). If unspecified, all fields are returned

startIndex string? (default ()) - Zero-based index of the starting row to read

Return Type

TableDataList|error - Successful response

insertAllTableData

Isolated FunctionRemote Function

function insertAllTableData(string projectId, string datasetId, string tableId, TableDataInsertAllRequest payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns TableDataInsertAllResponse|error

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

Parameters

projectId string - Project ID of the destination table.

datasetId string - Dataset ID of the destination table.

tableId string - Table ID of the destination table.

payload TableDataInsertAllRequest - Table data insert all request detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

TableDataInsertAllResponse|error - Successful response

listRowAccessPolicies

Isolated FunctionRemote Function

function listRowAccessPolicies(string projectId, string datasetId, string tableId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, int? pageSize, string? pageToken) returns ListRowAccessPoliciesResponse|error

Lists all row access policies on the specified table.

Parameters

projectId string - Required. Project ID of the row access policies to list.

datasetId string - Required. Dataset ID of row access policies to list.

tableId string - Required. Table ID of the table to list row access policies.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

pageSize int? (default ()) - The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results.

Return Type

ListRowAccessPoliciesResponse|error - Successful response

listJobs

Isolated FunctionRemote Function

function listJobs(string projectId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, boolean? allUsers, string? maxCreationTime, int? maxResults, string? minCreationTime, string? pageToken, string? parentJobId, string? projection, string[]? stateFilter) returns JobList|error

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.

Parameters

projectId string - Project ID of the jobs to list

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

allUsers boolean? (default ()) - Whether to display jobs owned by all users in the project. Default false

maxCreationTime string? (default ()) - 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 int? (default ()) - Maximum number of results to return

minCreationTime string? (default ()) - 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? (default ()) - Page token, returned by a previous call, to request the next page of results

parentJobId string? (default ()) - If set, retrieves only jobs whose parent is this job. Otherwise, retrieves only jobs which have no parent

projection string? (default ()) - Restrict information returned to a set of selected fields

stateFilter string[]? (default ()) - Filter for job state

Return Type

JobList|error - Successful response

insertJob

Isolated FunctionRemote Function

function insertJob(string projectId, Job payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Job|error

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

Parameters

projectId string - Project ID of the project that will be billed for the job

payload Job - Job detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Job|error - Successful response

getJob

Isolated FunctionRemote Function

function getJob(string projectId, string jobId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? location) returns Job|error

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.

Parameters

projectId string - [Required] Project ID of the requested job

jobId string - [Required] Job ID of the requested job

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

location string? (default ()) - 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.

Return Type

Job|error - Successful response

cancelJob

Isolated FunctionRemote Function

function cancelJob(string projectId, string jobId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? location) returns JobCancelResponse|error

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.

Parameters

projectId string - [Required] Project ID of the job to cancel

jobId string - [Required] Job ID of the job to cancel

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

location string? (default ()) - 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.

Return Type

JobCancelResponse|error - Successful response

deleteJob

Isolated FunctionRemote Function

function deleteJob(string projectId, string jobId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? location) returns Response|error

Requests that a job is deleted. This call will return when the job is deleted. This method is available in limited preview.

Parameters

projectId string - Required. Project ID of the job to be deleted.

jobId string - Required. Job ID of the job to be deleted. If this is a parent job which has child jobs, all child jobs will be deleted as well. Deletion of child jobs directly is not allowed.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

location string? (default ()) - The geographic location of the job. Required. See details at: https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

Return Type

Response|error - Successful response

queryJob

Isolated FunctionRemote Function

function queryJob(string projectId, QueryRequest payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns QueryResponse|error

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

Parameters

projectId string - Project ID of the project billed for the query

payload QueryRequest - Query Request Detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

QueryResponse|error - Successful response

getJobQueryResults

Isolated FunctionRemote Function

function getJobQueryResults(string projectId, string jobId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp, string? location, int? maxResults, string? pageToken, string? startIndex, int? timeoutMs) returns GetQueryResultsResponse|error

Retrieves the results of a query job.

Parameters

projectId string - [Required] Project ID of the query job

jobId string - [Required] Job ID of the query job

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

location string? (default ()) - 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 int? (default ()) - Maximum number of results to read

pageToken string? (default ()) - Page token, returned by a previous call, to request the next page of results

startIndex string? (default ()) - Zero-based index of the starting row

timeoutMs int? (default ()) - 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

Return Type

GetQueryResultsResponse|error - Successful response

getProjectServiceAccount

Isolated FunctionRemote Function

function getProjectServiceAccount(string projectId, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns GetServiceAccountResponse|error

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

Parameters

projectId string - Project ID for which the service account is requested.

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

GetServiceAccountResponse|error - Successful response

getIamPolicy

Isolated FunctionRemote Function

function getIamPolicy(string 'resource, GetIamPolicyRequest payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Policy|error

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

Parameters

'resource string - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.

payload GetIamPolicyRequest - Policy detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Policy|error - Successful response

setIamPolicy

Isolated FunctionRemote Function

function setIamPolicy(string 'resource, SetIamPolicyRequest payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns Policy|error

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

Parameters

'resource string - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.

payload SetIamPolicyRequest - Policy detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

Policy|error - Successful response

testIamPermissions

Isolated FunctionRemote Function

function testIamPermissions(string 'resource, TestIamPermissionsRequest payload, string? alt, string? fields, boolean? prettyPrint, string? quotaUser, string? userIp) returns TestIamPermissionsResponse|error

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.

Parameters

'resource string - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.

payload TestIamPermissionsRequest - Permission request detail

alt string? (default ()) - Data format for the response.

fields string? (default ()) - Selector specifying which fields to include in a partial response.

prettyPrint boolean? (default ()) - Returns response with indentations and line breaks.

quotaUser string? (default ()) - An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

userIp string? (default ()) - Deprecated. Please use quotaUser instead.

Return Type

TestIamPermissionsResponse|error - Successful response

Records

googleapis.bigquery: AggregateClassificationMetrics

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.

Fields

accuracy float? - Accuracy is the fraction of predictions given the correct label. For multiclass this is a micro-averaged metric.

f1Score float? - The F1 score is an average of recall and precision. For multiclass this is a macro-averaged metric.

logLoss float? - Logarithmic Loss. For multiclass this is a macro-averaged metric.

precision float? - 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 float? - Recall is the fraction of actual positive labels that were given a positive prediction. For multiclass this is a macro-averaged metric.

rocAuc float? - Area Under a ROC Curve. For multiclass this is a macro-averaged metric.

threshold float? - 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.

googleapis.bigquery: Argument

Input/output argument of a function or a stored procedure.

Fields

argumentKind string? - Optional. Defaults to FIXED_TYPE.

dataType StandardSqlDataType? - The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

mode string? - 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.

googleapis.bigquery: ArimaCoefficients

Arima coefficients.

Fields

autoRegressiveCoefficients decimal[]? - Auto-regressive coefficients, an array of double.

interceptCoefficient float? - Intercept coefficient, just a double not an array.

movingAverageCoefficients decimal[]? - Moving-average coefficients, an array of double.

googleapis.bigquery: ArimaFittingMetrics

ARIMA model fitting metrics.

Fields

aic float? - AIC.

logLikelihood float? - Log-likelihood.

variance float? - Variance.

googleapis.bigquery: ArimaForecastingMetrics

Model evaluation metrics for ARIMA forecasting models.

Fields

arimaFittingMetrics ArimaFittingMetrics[]? - Arima model fitting metrics.

arimaSingleModelForecastingMetrics ArimaSingleModelForecastingMetrics[]? - Repeated as there can be many metric sets (one for each model) in auto-arima and the large-scale case.

hasDrift boolean[]? - Whether Arima model fitted with drift or not. It is always false when d is not 1.

nonSeasonalOrder ArimaOrder[]? - Non-seasonal order.

seasonalPeriods string[]? - Seasonal periods. Repeated because multiple periods are supported for one time series.

timeSeriesId string[]? - Id to differentiate different time series for the large-scale case.

googleapis.bigquery: ArimaModelInfo

Arima model information.

Fields

arimaCoefficients ArimaCoefficients? - Arima coefficients.

arimaFittingMetrics ArimaFittingMetrics? - ARIMA model fitting metrics.

hasDrift boolean? - Whether Arima model fitted with drift or not. It is always false when d is not 1.

hasHolidayEffect boolean? - If true, holiday_effect is a part of time series decomposition result.

hasSpikesAndDips boolean? - If true, spikes_and_dips is a part of time series decomposition result.

hasStepChanges boolean? - If true, step_changes is a part of time series decomposition result.

nonSeasonalOrder ArimaOrder? - Arima order, can be used for both non-seasonal and seasonal parts.

seasonalPeriods string[]? - Seasonal periods. Repeated because multiple periods are supported for one time series.

timeSeriesId string? - The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.

timeSeriesIds string[]? - The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.

googleapis.bigquery: ArimaOrder

Arima order, can be used for both non-seasonal and seasonal parts.

Fields

d string? - Order of the differencing part.

p string? - Order of the autoregressive part.

q string? - Order of the moving-average part.

googleapis.bigquery: ArimaResult

(Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.

Fields

arimaModelInfo ArimaModelInfo[]? - This message is repeated because there are multiple arima models fitted in auto-arima. For non-auto-arima model, its size is one.

seasonalPeriods string[]? - Seasonal periods. Repeated because multiple periods are supported for one time series.

googleapis.bigquery: ArimaSingleModelForecastingMetrics

Model evaluation metrics for a single ARIMA forecasting model.

Fields

arimaFittingMetrics ArimaFittingMetrics? - ARIMA model fitting metrics.

hasDrift boolean? - Is arima model fitted with drift or not. It is always false when d is not 1.

hasHolidayEffect boolean? - If true, holiday_effect is a part of time series decomposition result.

hasSpikesAndDips boolean? - If true, spikes_and_dips is a part of time series decomposition result.

hasStepChanges boolean? - If true, step_changes is a part of time series decomposition result.

nonSeasonalOrder ArimaOrder? - Arima order, can be used for both non-seasonal and seasonal parts.

seasonalPeriods string[]? - Seasonal periods. Repeated because multiple periods are supported for one time series.

timeSeriesId string? - The time_series_id value for this time series. It will be one of the unique values from the time_series_id_column specified during ARIMA model training. Only present when time_series_id_column training option was used.

timeSeriesIds string[]? - The tuple of time_series_ids identifying this time series. It will be one of the unique tuples of values present in the time_series_id_columns specified during ARIMA model training. Only present when time_series_id_columns training option was used and the order of values here are same as the order of time_series_id_columns.

googleapis.bigquery: AuditConfig

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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Fields

auditLogConfigs AuditLogConfig[]? - 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.

googleapis.bigquery: AuditLogConfig

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

Fields

exemptedMembers string[]? - Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

logType string? - The log type that this config enables.

googleapis.bigquery: BiEngineReason

Fields

code string? - [Output-only] High-level BI Engine reason for partial or disabled acceleration.

message string? - [Output-only] Free form human-readable reason for partial or disabled acceleration.

googleapis.bigquery: BiEngineStatistics

Fields

biEngineMode string? - [Output-only] Specifies which mode of BI Engine acceleration was performed (if any).

biEngineReasons BiEngineReason[]? - In case of DISABLED or PARTIAL bi_engine_mode, these contain the explanatory reasons as to why BI Engine could not accelerate. In case the full query was accelerated, this field is not populated.

googleapis.bigquery: BigQueryModelTraining

Fields

currentIteration int? - [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.

googleapis.bigquery: BigtableColumn

Fields

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.

googleapis.bigquery: BigtableColumnFamily

Fields

columns BigtableColumn[]? - [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.

googleapis.bigquery: BigtableOptions

Fields

columnFamilies BigtableColumnFamily[]? - [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.

googleapis.bigquery: BinaryClassificationMetrics

Evaluation metrics for binary classification/classifier models.

Fields

aggregateClassificationMetrics AggregateClassificationMetrics? - 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.

binaryConfusionMatrixList BinaryConfusionMatrix[]? - Binary confusion matrix at multiple thresholds.

negativeLabel string? - Label representing the negative class.

positiveLabel string? - Label representing the positive class.

googleapis.bigquery: BinaryConfusionMatrix

Confusion matrix for binary classification models.

Fields

accuracy float? - The fraction of predictions given the correct label.

f1Score float? - 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 float? - Threshold value used when computing each of the following metric.

precision float? - The fraction of actual positive predictions that had positive actual labels.

recall float? - 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.

googleapis.bigquery: Binding

Associates members with a role.

Fields

condition Expr? - Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

members string[]? - 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, alice@example.com . * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * group:{emailid}: An email address that represents a Google group. For example, admins@example.com. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?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, my-other-app@appspot.gserviceaccount.com?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, admins@example.com?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.

role string? - Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

googleapis.bigquery: BqmlIterationResult

Fields

durationMs string? - [Output-only, Beta] Time taken to run the training iteration in milliseconds.

evalLoss float? - [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 int? - [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run.

learnRate float? - [Output-only, Beta] Learning rate used for this iteration, it varies for different training iterations if learn_rate_strategy option is not constant.

trainingLoss float? - [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.

googleapis.bigquery: BqmlTrainingRun

Fields

iterationResults BqmlIterationResult[]? - [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 BqmltrainingrunTrainingoptions? - [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.

googleapis.bigquery: BqmltrainingrunTrainingoptions

[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.

Fields

earlyStop boolean? - Whether to stop early when the loss doesn't improve significantly any more (compared to minRelativeProgress). Used only for iterative training algorithms

l1Reg float? - L1 regularization coefficient

l2Reg float? - L2 regularization coefficient

learnRate float? - Learning rate in training. Used only for iterative training algorithms

learnRateStrategy string? - The strategy to determine learn rate for the current iteration

lineSearchInitLearnRate float? - Specifies the initial learning rate for the line search learn rate strategy

maxIteration string? - The maximum number of iterations in training. Used only for iterative training algorithms

minRelProgress float? - When earlyStop is true, stops training when accuracy improvement is less than 'minRelativeProgress'. Used only for iterative training algorithms

warmStart boolean? - Whether to train a model from the last checkpoint

googleapis.bigquery: CategoricalValue

Representative value of a categorical feature.

Fields

categoryCounts CategoryCount[]? - 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.

googleapis.bigquery: CategoryCount

Represents the count of a single category within the cluster.

Fields

category string? - The name of category.

count string? - The count of training samples matching the category within the cluster.

googleapis.bigquery: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields

keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests

chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

proxy ProxyConfig? - Proxy server related options

googleapis.bigquery: Cluster

Message containing the information about one cluster.

Fields

centroidId string? - Centroid id.

count string? - Count of training data rows that were assigned to this cluster.

featureValues FeatureValue[]? - Values of highly variant features for this cluster.

googleapis.bigquery: ClusterInfo

Information about a single cluster for clustering model.

Fields

centroidId string? - Centroid id.

clusterRadius float? - Cluster radius, the average distance from centroid to each point assigned to the cluster.

clusterSize string? - Cluster size, the total number of points assigned to the cluster.

googleapis.bigquery: Clustering

Fields

fields string[]? - [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.

googleapis.bigquery: ClusteringMetrics

Evaluation metrics for clustering models.

Fields

clusters Cluster[]? - Information for all clusters.

daviesBouldinIndex float? - Davies-Bouldin index.

meanSquaredDistance float? - Mean of squared distances between each sample to its cluster centroid.

googleapis.bigquery: ConfusionMatrix

Confusion matrix for multi-class classification models.

Fields

confidenceThreshold float? - Confidence threshold used when computing the entries of the confusion matrix.

rows Row[]? - One row per actual label.

googleapis.bigquery: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields

auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication

httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client

http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol

http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol

timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection

forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header

poolConfig PoolConfiguration? - Configurations associated with request pooling

cache CacheConfig? - HTTP caching related configurations

compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header

circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker

retryConfig RetryConfig? - Configurations associated with retrying

responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits

secureSocket ClientSecureSocket? - SSL/TLS-related options

proxy ProxyConfig? - Proxy server related options

validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

googleapis.bigquery: ConnectionProperty

Fields

'key string? - [Required] Name of the connection property to set.

value string? - [Required] Value of the connection property.

googleapis.bigquery: CsvOptions

Fields

allowJaggedRows boolean? - [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.

allowQuotedNewlines boolean? - [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

encoding string? - [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.

fieldDelimiter string? - [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 (',').

null_marker string? - [Optional] An custom string that will represent a NULL value in CSV import data.

quote string? - [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.

skipLeadingRows string? - [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. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

googleapis.bigquery: Dataset

Fields

access DatasetAccess[]? - [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;

creationTime string? - [Output-only] The time when this dataset was created, in milliseconds since the epoch.

datasetReference DatasetReference? -

defaultEncryptionConfiguration EncryptionConfiguration? -

defaultPartitionExpirationMs string? - [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.

defaultTableExpirationMs string? - [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.

description string? - [Optional] A user-friendly description of the dataset.

etag string? - [Output-only] A hash of the resource.

friendlyName string? - [Optional] A descriptive name for the dataset.

id string? - [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.

isCaseInsensitive boolean? - [Optional] Indicates if table names are case insensitive in the dataset.

kind string? - [Output-only] The resource type.

labels record {}? - 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.

lastModifiedTime string? - [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch.

location string? - The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations.

satisfiesPZS boolean? - [Output-only] Reserved for future use.

selfLink string? - [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.

googleapis.bigquery: DatasetAccess

Fields

dataset DatasetAccessEntry? -

domain string? - [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".

groupByEmail string? - [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP".

iamMember string? - [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group.

role string? - [Required] An IAM role ID that should be granted to the user, group, or domain specified in this access entry. The following legacy mappings will be applied: OWNER roles/bigquery.dataOwner WRITER roles/bigquery.dataEditor READER roles/bigquery.dataViewer This field will accept any of the above formats, but will return only the legacy format. For example, if you set this field to "roles/bigquery.dataOwner", it will be returned back as "OWNER".

routine RoutineReference? - Reference describing the ID of this routine

specialGroup string? - [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.

userByEmail string? - [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".

view TableReference? - [Required] Reference describing the ID of the table that was snapshot

googleapis.bigquery: DatasetAccessEntry

Fields

dataset DatasetReference? -

target_types DatasetaccessentryTargetTypes[]? -

googleapis.bigquery: DatasetaccessentryTargetTypes

Fields

targetType string? - [Required] Which resources in the dataset this entry applies to. Currently, only views are supported, but additional target types may be added in the future. Possible values: VIEWS: This entry applies to all views in the dataset.

googleapis.bigquery: DatasetList

Fields

datasets DatasetlistDatasets[]? - 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.

etag string? - A hash value of the results page. You can use this property to determine if the page has changed since the last request.

kind string? - The list type. This property always returns the value "bigquery#datasetList".

nextPageToken string? - A token that can be used to request the next results page. This property is omitted on the final results page.

googleapis.bigquery: DatasetlistDatasets

Fields

datasetReference DatasetReference? -

friendlyName string? - A descriptive name for the dataset, if one exists.

id string? - The fully-qualified, unique, opaque ID of the dataset.

kind string? - The resource type. This property always returns the value "bigquery#dataset".

labels record {}? - The labels associated with this dataset. You can use these to organize and group your datasets.

location string? - The geographic location where the data resides.

googleapis.bigquery: DatasetReference

Fields

datasetId string? - [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.

projectId string? - [Optional] The ID of the project containing this dataset.

googleapis.bigquery: DataSplitResult

Data split result. This contains references to the training and evaluation data tables that were used to train the model.

Fields

evaluationTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

trainingTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

googleapis.bigquery: DestinationTableProperties

Fields

description string? - [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.

friendlyName string? - [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.

labels record {}? - [Optional] The labels associated with this table. You can use these to organize and group your tables. This will only be used if the destination table is newly created. If the table already exists and labels are different than the current labels are provided, the job will fail.

googleapis.bigquery: DmlStatistics

Fields

deletedRowCount string? - Number of deleted Rows. populated by DML DELETE, MERGE and TRUNCATE statements.

insertedRowCount string? - Number of inserted Rows. Populated by DML INSERT and MERGE statements.

updatedRowCount string? - Number of updated Rows. Populated by DML UPDATE and MERGE statements.

googleapis.bigquery: EncryptionConfiguration

Fields

kmsKeyName string? - [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.

googleapis.bigquery: Entry

A single entry in the confusion matrix.

Fields

itemCount string? - Number of items being predicted as this label.

predictedLabel string? - The predicted label. For confidence_threshold > 0, we will also add an entry indicating the number of items under the confidence threshold.

googleapis.bigquery: ErrorProto

Fields

debugInfo string? - Debugging information. This property is internal to Google and should not be used.

location string? - Specifies where the error occurred, if present.

message string? - A human-readable description of the error.

reason string? - A short error code that summarizes the error.

googleapis.bigquery: EvaluationMetrics

Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.

Fields

arimaForecastingMetrics ArimaForecastingMetrics? - Model evaluation metrics for ARIMA forecasting models.

binaryClassificationMetrics BinaryClassificationMetrics? - Evaluation metrics for binary classification/classifier models.

clusteringMetrics ClusteringMetrics? - Evaluation metrics for clustering models.

multiClassClassificationMetrics MultiClassClassificationMetrics? - Evaluation metrics for multi-class classification/classifier models.

rankingMetrics RankingMetrics? - Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.

regressionMetrics RegressionMetrics? - Evaluation metrics for regression and explicit feedback type matrix factorization models.

googleapis.bigquery: ExplainQueryStage

Fields

completedParallelInputs string? - Number of parallel input segments completed.

computeMsAvg string? - Milliseconds the average shard spent on CPU-bound tasks.

computeMsMax string? - Milliseconds the slowest shard spent on CPU-bound tasks.

computeRatioAvg float? - Relative amount of time the average shard spent on CPU-bound tasks.

computeRatioMax float? - Relative amount of time the slowest shard spent on CPU-bound tasks.

endMs string? - Stage end time represented as milliseconds since epoch.

id string? - Unique ID for stage within plan.

inputStages string[]? - IDs for stages that are inputs to this stage.

name string? - Human-readable name for stage.

parallelInputs string? - Number of parallel input segments to be processed.

readMsAvg string? - Milliseconds the average shard spent reading input.

readMsMax string? - Milliseconds the slowest shard spent reading input.

readRatioAvg float? - Relative amount of time the average shard spent reading input.

readRatioMax float? - Relative amount of time the slowest shard spent reading input.

recordsRead string? - Number of records read into the stage.

recordsWritten string? - Number of records written by the stage.

shuffleOutputBytes string? - Total number of bytes written to shuffle.

shuffleOutputBytesSpilled string? - Total number of bytes written to shuffle and spilled to disk.

slotMs string? - Slot-milliseconds used by the stage.

startMs string? - Stage start time represented as milliseconds since epoch.

status string? - Current status for the stage.

steps ExplainQueryStep[]? - List of operations within the stage in dependency order (approximately chronological).

waitMsAvg string? - Milliseconds the average shard spent waiting to be scheduled.

waitMsMax string? - Milliseconds the slowest shard spent waiting to be scheduled.

waitRatioAvg float? - Relative amount of time the average shard spent waiting to be scheduled.

waitRatioMax float? - Relative amount of time the slowest shard spent waiting to be scheduled.

writeMsAvg string? - Milliseconds the average shard spent on writing output.

writeMsMax string? - Milliseconds the slowest shard spent on writing output.

writeRatioAvg float? - Relative amount of time the average shard spent on writing output.

writeRatioMax float? - Relative amount of time the slowest shard spent on writing output.

googleapis.bigquery: ExplainQueryStep

Fields

kind string? - Machine-readable operation type.

substeps string[]? - Human-readable stage descriptions.

googleapis.bigquery: Expr

Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.

Fields

description string? - Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

expression string? - Textual representation of an expression in Common Expression Language syntax.

location string? - Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

title string? - Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.

googleapis.bigquery: ExternalDataConfiguration

Fields

autodetect boolean? - Try to detect schema and format options automatically. Any option specified explicitly will be honored.

bigtableOptions BigtableOptions? -

compression string? - [Optional] The compression type of the data source. Possible values include GZIP and NONE. The default value is NONE. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

connectionId string? - [Optional, Trusted Tester] Connection for external data source.

csvOptions CsvOptions? -

decimalTargetTypes string[]? - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

googleSheetsOptions GoogleSheetsOptions? -

hivePartitioningOptions HivePartitioningOptions? -

ignoreUnknownValues boolean? - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra 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. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names Google Cloud Bigtable: This setting is ignored. Google Cloud Datastore backups: This setting is ignored. Avro: This setting is ignored.

maxBadRecords int? - [Optional] The maximum number of bad records that BigQuery can ignore when reading data. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV, JSON, and Google Sheets. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups and Avro formats.

parquetOptions ParquetOptions? -

schema TableSchema? -

sourceFormat string? - [Required] The data format. For CSV files, specify "CSV". For Google sheets, specify "GOOGLE_SHEETS". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro files, specify "AVRO". For Google Cloud Datastore backups, specify "DATASTORE_BACKUP". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".

sourceUris string[]? - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups, exactly one URI can be specified. Also, the '' wildcard character is not allowed.

googleapis.bigquery: FeatureValue

Representative value of a single feature within the cluster.

Fields

categoricalValue CategoricalValue? - Representative value of a categorical feature.

featureColumn string? - The feature column name.

numericalValue float? - The numerical feature value. This is the centroid value for this feature.

googleapis.bigquery: GetIamPolicyRequest

Request message for GetIamPolicy method.

Fields

options GetPolicyOptions? - Encapsulates settings provided to GetIamPolicy.

googleapis.bigquery: GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

Fields

requestedPolicyVersion int? - Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

googleapis.bigquery: GetQueryResultsResponse

Fields

cacheHit boolean? - Whether the query result was fetched from the query cache.

errors ErrorProto[]? - [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

etag string? - A hash of this response.

jobComplete boolean? - Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

jobReference JobReference? -

kind string? - The resource type of the response.

numDmlAffectedRows string? - [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

pageToken string? - A token used for paging results.

rows TableRow[]? - An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above. Present only when the query completes successfully.

schema TableSchema? -

totalBytesProcessed string? - The total number of bytes processed for this query.

totalRows string? - The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. Present only when the query completes successfully.

googleapis.bigquery: GetServiceAccountResponse

Fields

email string? - The service account email address.

kind string? - The resource type of the response.

googleapis.bigquery: GoogleSheetsOptions

Fields

range string? - [Optional] Range of a sheet to query from. Only used when non-empty. Typical format: sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20

skipLeadingRows string? - [Optional] The number of rows at the top of a sheet that BigQuery will skip when reading the data. The default value is 0. This property is useful if you have header rows that should be skipped. When autodetect is on, behavior is the following: * skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected, the row is read as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract column names for the detected schema.

googleapis.bigquery: HivePartitioningOptions

Fields

mode string? - [Optional] When set, what mode of hive partitioning to use when reading data. The following modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2) STRINGS: automatically infer partition key name(s). All types are interpreted as strings. (3) CUSTOM: partition key schema is encoded in the source URI prefix. Not all storage formats support hive partitioning. Requesting hive partitioning on an unsupported format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and Parquet.

requirePartitionFilter boolean? - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

sourceUriPrefix string? - [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied. The prefix must end immediately before the partition key encoding begins. For example, consider files following this data layout. gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is requested with either AUTO or STRINGS detection, the common prefix can be either of gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

googleapis.bigquery: IterationResult

Information about a single iteration of the training run.

Fields

arimaResult ArimaResult? - (Auto-)arima fitting result. Wrap everything in ArimaResult for easier refactoring if we want to use model-specific iteration results.

clusterInfos ClusterInfo[]? - Information about top clusters for clustering models.

durationMs string? - Time taken to run the iteration in milliseconds.

evalLoss float? - Loss computed on the eval data at the end of iteration.

index int? - Index of the iteration, 0 based.

learnRate float? - Learn rate used for this iteration.

trainingLoss float? - Loss computed on the training data at the end of iteration.

googleapis.bigquery: Job

Fields

configuration JobConfiguration? -

etag string? - [Output-only] A hash of this resource.

id string? - [Output-only] Opaque ID field of the job

jobReference JobReference? -

kind string? - [Output-only] The type of the resource.

selfLink string? - [Output-only] A URL that can be used to access this resource again.

statistics JobStatistics? -

status JobStatus? -

user_email string? - [Output-only] Email address of the user who ran the job.

googleapis.bigquery: JobCancelResponse

Fields

job Job? -

kind string? - The resource type of the response.

googleapis.bigquery: JobConfiguration

Fields

copy JobConfigurationTableCopy? -

dryRun boolean? - [Optional] If set, don't actually run this job. A valid query will return a mostly empty response with some processing statistics, while an invalid query will return the same error it would if it wasn't a dry run. Behavior of non-query jobs is undefined.

extract JobConfigurationExtract? -

jobTimeoutMs string? - [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.

jobType string? - [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.

labels record {}? - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

load JobConfigurationLoad? -

query JobConfigurationQuery? -

googleapis.bigquery: JobConfigurationExtract

Fields

compression string? - [Optional] The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE. The default value is NONE. DEFLATE and SNAPPY are only supported for Avro. Not applicable when extracting models.

destinationFormat string? - [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON, PARQUET or AVRO for tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV. The default value for models is ML_TF_SAVED_MODEL.

destinationUri string? - [Pick one] DEPRECATED: Use destinationUris instead, passing only one URI as necessary. The fully-qualified Google Cloud Storage URI where the extracted table should be written.

destinationUris string[]? - [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.

fieldDelimiter string? - [Optional] Delimiter to use between fields in the exported data. Default is ','. Not applicable when extracting models.

printHeader boolean? - [Optional] Whether to print out a header row in the results. Default is true. Not applicable when extracting models.

sourceModel ModelReference? -

sourceTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

useAvroLogicalTypes boolean? - [Optional] If destinationFormat is set to "AVRO", this flag indicates whether to enable extracting applicable column types (such as TIMESTAMP) to their corresponding AVRO logical types (timestamp-micros), instead of only using their raw types (avro-long). Not applicable when extracting models.

googleapis.bigquery: JobConfigurationLoad

Fields

allowJaggedRows boolean? - [Optional] Accept rows that are missing trailing optional columns. The missing values are treated as nulls. 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. Only applicable to CSV, ignored for other formats.

allowQuotedNewlines boolean? - Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false.

autodetect boolean? - [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources.

clustering Clustering? -

createDisposition string? - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

decimalTargetTypes string[]? - [Optional] Defines the list of possible SQL data types to which the source decimal values are converted. This list and the precision and the scale parameters of the decimal field determine the target type. In the order of NUMERIC, BIGNUMERIC, and STRING, a type is picked if it is in the specified list and if it supports the precision and the scale. STRING supports all precision and scale values. If none of the listed types supports the precision and the scale, the type supporting the widest range in the specified list is picked, and if a value exceeds the supported range when reading the data, an error will be thrown. Example: Suppose the value of this field is ["NUMERIC", "BIGNUMERIC"]. If (precision,scale) is: (38,9) -> NUMERIC; (39,9) -> BIGNUMERIC (NUMERIC cannot hold 30 integer digits); (38,10) -> BIGNUMERIC (NUMERIC cannot hold 10 fractional digits); (76,38) -> BIGNUMERIC; (77,38) -> BIGNUMERIC (error if value exeeds supported range). This field cannot contain duplicate types. The order of the types in this field is ignored. For example, ["BIGNUMERIC", "NUMERIC"] is the same as ["NUMERIC", "BIGNUMERIC"] and NUMERIC always takes precedence over BIGNUMERIC. Defaults to ["NUMERIC", "STRING"] for ORC and ["NUMERIC"] for the other file formats.

destinationEncryptionConfiguration EncryptionConfiguration? -

destinationTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

destinationTableProperties DestinationTableProperties? -

encoding string? - [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.

fieldDelimiter string? - [Optional] The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character. To use a character in the range 128-255, you must encode the character as UTF8. 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 (',').

hivePartitioningOptions HivePartitioningOptions? -

ignoreUnknownValues boolean? - [Optional] Indicates if BigQuery should allow extra values that are not represented in the table schema. If true, the extra values are ignored. If false, records with extra 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. The sourceFormat property determines what BigQuery treats as an extra value: CSV: Trailing columns JSON: Named values that don't match any column names

jsonExtension string? - [Optional] If sourceFormat is set to newline-delimited JSON, indicates whether it should be processed as a JSON variant such as GeoJSON. For a sourceFormat other than JSON, omit this field. If the sourceFormat is newline-delimited JSON: - for newline-delimited GeoJSON: set to GEOJSON.

maxBadRecords int? - [Optional] The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value, an invalid error is returned in the job result. This is only valid for CSV and JSON. The default value is 0, which requires that all records are valid.

nullMarker string? - [Optional] Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as an empty value.

parquetOptions ParquetOptions? -

projectionFields string[]? - If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup. Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties. If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.

quote string? - [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.

rangePartitioning RangePartitioning? -

schema TableSchema? -

schemaInline string? - [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT".

schemaInlineFormat string? - [Deprecated] The format of the schemaInline property.

schemaUpdateOptions string[]? - Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

skipLeadingRows int? - [Optional] The number of rows at the top of a CSV file that BigQuery will skip when loading the data. The default value is 0. This property is useful if you have header rows in the file that should be skipped.

sourceFormat string? - [Optional] The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP". For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET". For orc, specify "ORC". The default value is CSV.

sourceUris string[]? - [Required] The fully-qualified URIs that point to your data in Google Cloud. For Google Cloud Storage URIs: Each URI can contain one '' wildcard character and it must come after the 'bucket' name. Size limits related to load jobs apply to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table. For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '' wildcard character is not allowed.

timePartitioning TimePartitioning? -

useAvroLogicalTypes boolean? - [Optional] If sourceFormat is set to "AVRO", indicates whether to enable interpreting logical types into their corresponding types (ie. TIMESTAMP), instead of only using their raw types (ie. INTEGER).

writeDisposition string? - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_APPEND. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

googleapis.bigquery: JobConfigurationQuery

Fields

allowLargeResults boolean? - [Optional] If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance. Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed. However, you must still set destinationTable when result size exceeds the allowed maximum response size.

clustering Clustering? -

connectionProperties ConnectionProperty[]? - Connection properties.

createDisposition string? - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

createSession boolean? - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.

defaultDataset DatasetReference? -

destinationEncryptionConfiguration EncryptionConfiguration? -

destinationTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

flattenResults boolean? - [Optional] If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results. allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.

maximumBillingTier int? - [Optional] Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge). If unspecified, this will be set to your project default.

maximumBytesBilled string? - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

parameterMode string? - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

preserveNulls boolean? - [Deprecated] This property is deprecated.

priority string? - [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE.

query string? - [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.

queryParameters QueryParameter[]? - Query parameters for standard SQL queries.

rangePartitioning RangePartitioning? -

schemaUpdateOptions string[]? - Allows the schema of the destination table to be updated as a side effect of the query job. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND; when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified: ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema. ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.

tableDefinitions record {}? - [Optional] If querying an external data source outside of BigQuery, describes the data format, location and other properties of the data source. By defining these properties, the data source can then be queried as if it were a standard BigQuery table.

timePartitioning TimePartitioning? -

useLegacySql boolean? - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

useQueryCache boolean? - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified. The default value is true.

userDefinedFunctionResources UserDefinedFunctionResource[]? - Describes user-defined function resources used in the query.

writeDisposition string? - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

googleapis.bigquery: JobConfigurationTableCopy

Fields

createDisposition string? - [Optional] Specifies whether the job is allowed to create new tables. The following values are supported: CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table. CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result. The default value is CREATE_IF_NEEDED. Creation, truncation and append actions occur as one atomic update upon job completion.

destinationEncryptionConfiguration EncryptionConfiguration? -

destinationExpirationTime anydata? - [Optional] The time when the destination table expires. Expired tables will be deleted and their storage reclaimed.

destinationTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

operationType string? - [Optional] Supported operation types in table copy job.

sourceTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

sourceTables TableReference[]? - [Pick one] Source tables to copy.

writeDisposition string? - [Optional] Specifies the action that occurs if the destination table already exists. The following values are supported: WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data. WRITE_APPEND: If the table already exists, BigQuery appends the data to the table. WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result. The default value is WRITE_EMPTY. Each action is atomic and only occurs if BigQuery is able to complete the job successfully. Creation, truncation and append actions occur as one atomic update upon job completion.

googleapis.bigquery: JobList

Fields

etag string? - A hash of this page of results.

jobs JoblistJobs[]? - List of jobs that were requested.

kind string? - The resource type of the response.

nextPageToken string? - A token to request the next page of results.

googleapis.bigquery: JoblistJobs

Fields

configuration JobConfiguration? -

errorResult ErrorProto? -

id string? - Unique opaque ID of the job.

jobReference JobReference? -

kind string? - The resource type.

state string? - Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed.

statistics JobStatistics? -

status JobStatus? -

user_email string? - [Full-projection-only] Email address of the user who ran the job.

googleapis.bigquery: JobReference

Fields

jobId string? - [Required] The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.

location string? - The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

projectId string? - [Required] The ID of the project containing this job.

googleapis.bigquery: JobStatistics

Fields

completionRatio float? - [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs.

creationTime string? - [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs.

endTime string? - [Output-only] End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.

extract JobStatistics4? -

load JobStatistics3? -

numChildJobs string? - [Output-only] Number of child jobs executed.

parentJobId string? - [Output-only] If this is a child job, the id of the parent.

query JobStatistics2? -

quotaDeferments string[]? - [Output-only] Quotas which delayed this job's start time.

reservationUsage JobstatisticsReservationusage[]? - [Output-only] Job resource usage breakdown by reservation.

reservation_id string? - [Output-only] Name of the primary reservation assigned to this job. Note that this could be different than reservations reported in the reservation usage field if parent reservations were used to execute this job.

rowLevelSecurityStatistics RowLevelSecurityStatistics? -

scriptStatistics ScriptStatistics? -

sessionInfo SessionInfo? -

startTime string? - [Output-only] Start time of this job, in milliseconds since the epoch. This field will be present when the job transitions from the PENDING state to either RUNNING or DONE.

totalBytesProcessed string? - [Output-only] [Deprecated] Use the bytes processed in the query statistics instead.

totalSlotMs string? - [Output-only] Slot-milliseconds for the job.

transactionInfo TransactionInfo? -

googleapis.bigquery: JobStatistics2

Fields

biEngineStatistics BiEngineStatistics? -

billingTier int? - [Output-only] Billing tier for the job.

cacheHit boolean? - [Output-only] Whether the query result was fetched from the query cache.

ddlAffectedRowAccessPolicyCount string? - [Output-only] [Preview] The number of row access policies affected by a DDL statement. Present only for DROP ALL ROW ACCESS POLICIES queries.

ddlDestinationTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

ddlOperationPerformed string? - The DDL operation performed, possibly dependent on the pre-existence of the DDL target. Possible values (new values might be added in the future): "CREATE": The query created the DDL target. "SKIP": No-op. Example cases: the query is CREATE TABLE IF NOT EXISTS while the table already exists, or the query is DROP TABLE IF EXISTS while the table does not exist. "REPLACE": The query replaced the DDL target. Example case: the query is CREATE OR REPLACE TABLE, and the table already exists. "DROP": The query deleted the DDL target.

ddlTargetDataset DatasetReference? -

ddlTargetRoutine RoutineReference? - Reference describing the ID of this routine

ddlTargetRowAccessPolicy RowAccessPolicyReference? - [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

ddlTargetTable TableReference? - [Required] Reference describing the ID of the table that was snapshot

dmlStats DmlStatistics? -

estimatedBytesProcessed string? - [Output-only] The original estimate of bytes processed for the job.

modelTraining BigQueryModelTraining? -

modelTrainingCurrentIteration int? - [Output-only, Beta] Deprecated; do not use.

modelTrainingExpectedTotalIteration string? - [Output-only, Beta] Deprecated; do not use.

numDmlAffectedRows string? - [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

queryPlan ExplainQueryStage[]? - [Output-only] Describes execution plan for the query.

referencedRoutines RoutineReference[]? - [Output-only] Referenced routines (persistent user-defined functions and stored procedures) for the job.

referencedTables TableReference[]? - [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list.

reservationUsage JobstatisticsReservationusage[]? - [Output-only] Job resource usage breakdown by reservation.

schema TableSchema? -

statementType string? - The type of query statement, if valid. Possible values (new values might be added in the future): "SELECT": SELECT query. "INSERT": INSERT query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "UPDATE": UPDATE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "DELETE": DELETE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "MERGE": MERGE query; see https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language. "ALTER_TABLE": ALTER TABLE query. "ALTER_VIEW": ALTER VIEW query. "ASSERT": ASSERT condition AS 'description'. "CREATE_FUNCTION": CREATE FUNCTION query. "CREATE_MODEL": CREATE [OR REPLACE] MODEL ... AS SELECT ... . "CREATE_PROCEDURE": CREATE PROCEDURE query. "CREATE_TABLE": CREATE [OR REPLACE] TABLE without AS SELECT. "CREATE_TABLE_AS_SELECT": CREATE [OR REPLACE] TABLE ... AS SELECT ... . "CREATE_VIEW": CREATE [OR REPLACE] VIEW ... AS SELECT ... . "DROP_FUNCTION" : DROP FUNCTION query. "DROP_PROCEDURE": DROP PROCEDURE query. "DROP_TABLE": DROP TABLE query. "DROP_VIEW": DROP VIEW query.

timeline QueryTimelineSample[]? - [Output-only] [Beta] Describes a timeline of job execution.

totalBytesBilled string? - [Output-only] Total bytes billed for the job.

totalBytesProcessed string? - [Output-only] Total bytes processed for the job.

totalBytesProcessedAccuracy string? - [Output-only] For dry-run jobs, totalBytesProcessed is an estimate and this field specifies the accuracy of the estimate. Possible values can be: UNKNOWN: accuracy of the estimate is unknown. PRECISE: estimate is precise. LOWER_BOUND: estimate is lower bound of what the query would cost. UPPER_BOUND: estimate is upper bound of what the query would cost.

totalPartitionsProcessed string? - [Output-only] Total number of partitions processed from all partitioned tables referenced in the job.

totalSlotMs string? - [Output-only] Slot-milliseconds for the job.

undeclaredQueryParameters QueryParameter[]? - Standard SQL only: list of undeclared query parameters detected during a dry run validation.

googleapis.bigquery: JobStatistics3

Fields

badRecords string? - [Output-only] The number of bad records encountered. Note that if the job has failed because of more bad records encountered than the maximum allowed in the load job configuration, then this number can be less than the total number of bad records present in the input data.

inputFileBytes string? - [Output-only] Number of bytes of source data in a load job.

inputFiles string? - [Output-only] Number of source files in a load job.

outputBytes string? - [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change.

outputRows string? - [Output-only] Number of rows imported in a load job. Note that while an import job is in the running state, this value may change.

googleapis.bigquery: JobStatistics4

Fields

destinationUriFileCounts string[]? - [Output-only] Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.

inputBytes string? - [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes.

googleapis.bigquery: JobstatisticsReservationusage

Fields

name string? - [Output-only] Reservation name or "unreserved" for on-demand resources usage.

slotMs string? - [Output-only] Slot-milliseconds the job spent in the given reservation.

googleapis.bigquery: JobStatus

Fields

errorResult ErrorProto? -

errors ErrorProto[]? - [Output-only] The first errors encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

state string? - [Output-only] Running state of the job.

googleapis.bigquery: JsonObject

Represents a single JSON object.

googleapis.bigquery: ListModelsResponse

Fields

models Model[]? - Models in the requested dataset. Only the following fields are populated: model_reference, model_type, creation_time, last_modified_time and labels.

nextPageToken string? - A token to request the next page of results.

googleapis.bigquery: ListRoutinesResponse

Fields

nextPageToken string? - A token to request the next page of results.

routines Routine[]? - Routines in the requested dataset. Unless read_mask is set in the request, only the following fields are populated: etag, project_id, dataset_id, routine_id, routine_type, creation_time, last_modified_time, and language.

googleapis.bigquery: ListRowAccessPoliciesResponse

Response message for the ListRowAccessPolicies method.

Fields

nextPageToken string? - A token to request the next page of results.

rowAccessPolicies RowAccessPolicy[]? - Row access policies on the requested table.

googleapis.bigquery: LocationMetadata

BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.

Fields

legacyLocationId string? - The legacy BigQuery location ID, e.g. “EU” for the “europe” location. This is for any API consumers that need the legacy “US” and “EU” locations.

googleapis.bigquery: MaterializedViewDefinition

Fields

enableRefresh boolean? - [Optional] [TrustedTester] Enable automatic refresh of the materialized view when the base table is updated. The default value is "true".

lastRefreshTime string? - [Output-only] [TrustedTester] The time when this materialized view was last modified, in milliseconds since the epoch.

query string? - [Required] A query whose result is persisted.

refreshIntervalMs string? - [Optional] [TrustedTester] The maximum frequency at which this materialized view will be refreshed. The default value is "1800000" (30 minutes).

googleapis.bigquery: Model

Fields

bestTrialId string? - The best trial_id across all training runs.

creationTime string? - Output only. The time when this model was created, in millisecs since the epoch.

description string? - Optional. A user-friendly description of this model.

encryptionConfiguration EncryptionConfiguration? -

etag string? - Output only. A hash of this resource.

expirationTime string? - Optional. The time when this model expires, in milliseconds since the epoch. If not present, the model will persist indefinitely. Expired models will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created models.

featureColumns StandardSqlField[]? - Output only. Input feature columns that were used to train this model.

friendlyName string? - Optional. A descriptive name for this model.

labelColumns StandardSqlField[]? - Output only. Label columns that were used to train this model. The output of the model will have a "predicted_" prefix to these columns.

labels record {}? - The labels associated with this model. You can use these to organize and group your models. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

lastModifiedTime string? - Output only. The time when this model was last modified, in millisecs since the epoch.

location string? - Output only. The geographic location where the model resides. This value is inherited from the dataset.

modelReference ModelReference? -

modelType string? - Output only. Type of the model resource.

trainingRuns TrainingRun[]? - Output only. Information for all training runs in increasing order of start_time.

googleapis.bigquery: ModelDefinition

Fields

modelOptions ModeldefinitionModeloptions? - [Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

trainingRuns BqmlTrainingRun[]? - [Output-only, Beta] Information about ml training runs, each training run comprises of multiple iterations and there may be multiple training runs for the model if warm start is used or if a user decides to continue a previously cancelled query.

googleapis.bigquery: ModeldefinitionModeloptions

[Output-only, Beta] Model options used for the first training run. These options are immutable for subsequent training runs. Default values are used for any options not specified in the input query.

Fields

labels string[]? - The labels associated with this model

lossType string? - Type of loss function used during training run.

modelType string? - Output only. Type of the model resource.

googleapis.bigquery: ModelReference

Fields

datasetId string? - [Required] The ID of the dataset containing this model.

modelId string? - [Required] The ID of the model. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

projectId string? - [Required] The ID of the project containing this model.

googleapis.bigquery: MultiClassClassificationMetrics

Evaluation metrics for multi-class classification/classifier models.

Fields

aggregateClassificationMetrics AggregateClassificationMetrics? - 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.

confusionMatrixList ConfusionMatrix[]? - Confusion matrix at different thresholds.

googleapis.bigquery: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields

Fields Included from *OAuth2RefreshTokenGrantConfig

refreshUrl string
refreshToken string
clientId string
clientSecret string
scopes string|string[]
defaultTokenExpTime decimal
clockSkew decimal
optionalParams map<string>
credentialBearer CredentialBearer
clientConfig ClientConfiguration

refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL

googleapis.bigquery: ParquetOptions

Fields

enableListInference boolean? - [Optional] Indicates whether to use schema inference specifically for Parquet LIST logical type.

enumAsString boolean? - [Optional] Indicates whether to infer Parquet ENUM logical type as STRING instead of BYTES by default.

googleapis.bigquery: Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.

Fields

auditConfigs AuditConfig[]? - Specifies cloud audit logging configuration for this policy.

bindings Binding[]? - Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

etag string? - etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

'version int? - Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

googleapis.bigquery: ProjectList

Fields

etag string? - A hash of the page of results

kind string? - The type of list.

nextPageToken string? - A token to request the next page of results.

projects ProjectlistProjects[]? - Projects to which you have at least READ access.

totalItems int? - The total number of projects in the list.

googleapis.bigquery: ProjectlistProjects

Fields

friendlyName string? - A descriptive name for this project.

id string? - An opaque ID of this project.

kind string? - The resource type.

numericId string? - The numeric ID of this project.

projectReference ProjectReference? -

googleapis.bigquery: ProjectReference

Fields

projectId string? - [Required] ID of the project. Can be either the numeric ID or the assigned ID of the project.

googleapis.bigquery: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields

host string(default "") - Host name of the proxy server

port int(default 0) - Proxy server port

userName string(default "") - Proxy server username

password string(default "") - Proxy server password

googleapis.bigquery: QueryParameter

Fields

name string? - [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query.

parameterType QueryParameterType? -

parameterValue QueryParameterValue? -

googleapis.bigquery: QueryParameterType

Fields

arrayType QueryParameterType? -

structTypes QueryparametertypeStructtypes[]? - [Optional] The types of the fields of this struct, in order, if this is a struct.

'type string? - [Required] The top level type of this field.

googleapis.bigquery: QueryparametertypeStructtypes

Fields

description string? - [Optional] Human-oriented description of the field.

name string? - [Optional] The name of this field.

'type QueryParameterType? -

googleapis.bigquery: QueryParameterValue

Fields

arrayValues QueryParameterValue[]? - [Optional] The array values, if this is an array type.

structValues record {}? - [Optional] The struct field values, in order of the struct type's declaration.

value string? - [Optional] The value of this value, if a simple scalar type.

googleapis.bigquery: QueryRequest

Fields

connectionProperties ConnectionProperty[]? - Connection properties.

createSession boolean? - If true, creates a new session, where session id will be a server generated random id. If false, runs query with an existing session_id passed in ConnectionProperty, otherwise runs query in non-session mode.

defaultDataset DatasetReference? -

dryRun boolean? - [Optional] If set to true, BigQuery doesn't run the job. Instead, if the query is valid, BigQuery returns statistics about the job such as how many bytes would be processed. If the query is invalid, an error returns. The default value is false.

kind string? - The resource type of the request.

labels record {}? - The labels associated with this job. You can use these to organize and group your jobs. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

location string? - The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location.

maxResults int? - [Optional] The maximum number of rows of data to return per page of results. Setting this flag to a small value such as 1000 and then paging through results might improve reliability when the query result set is large. In addition to this limit, responses are also limited to 10 MB. By default, there is no maximum row count, and only the byte limit applies.

maximumBytesBilled string? - [Optional] Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge). If unspecified, this will be set to your project default.

parameterMode string? - Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.

preserveNulls boolean? - [Deprecated] This property is deprecated.

query string? - [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]".

queryParameters QueryParameter[]? - Query parameters for Standard SQL queries.

requestId string? - A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of the previous request, all parameters in the request that may affect the behavior are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed.

timeoutMs int? - [Optional] How long to wait for the query to complete, in milliseconds, before the request times out and returns. Note that this is only a timeout for the request, not the query. If the query takes longer to run than the timeout value, the call returns without any results and with the 'jobComplete' flag set to false. You can call GetQueryResults() to wait for the query to complete and read the results. The default value is 10000 milliseconds (10 seconds).

useLegacySql boolean? - Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false.

useQueryCache boolean? - [Optional] Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true.

googleapis.bigquery: QueryResponse

Fields

cacheHit boolean? - Whether the query result was fetched from the query cache.

dmlStats DmlStatistics? -

errors ErrorProto[]? - [Output-only] The first errors or warnings encountered during the running of the job. The final message includes the number of errors that caused the process to stop. Errors here do not necessarily mean that the job has completed or was unsuccessful.

jobComplete boolean? - Whether the query has completed or not. If rows or totalRows are present, this will always be true. If this is false, totalRows will not be available.

jobReference JobReference? -

kind string? - The resource type.

numDmlAffectedRows string? - [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.

pageToken string? - A token used for paging results.

rows TableRow[]? - An object with as many results as can be contained within the maximum permitted reply size. To get any additional rows, you can call GetQueryResults and specify the jobReference returned above.

schema TableSchema? -

sessionInfoTemplate SessionInfo? -

totalBytesProcessed string? - The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run.

totalRows string? - The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results.

googleapis.bigquery: QueryTimelineSample

Fields

activeUnits string? - Total number of units currently being processed by workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample.

completedUnits string? - Total parallel units of work completed by this query.

elapsedMs string? - Milliseconds elapsed since the start of query execution.

pendingUnits string? - Total parallel units of work remaining for the active stages.

totalSlotMs string? - Cumulative slot-ms consumed by the query.

googleapis.bigquery: RangePartitioning

Fields

'field string? - [TrustedTester] [Required] The table is partitioned by this field. The field must be a top-level NULLABLE/REQUIRED field. The only supported type is INTEGER/INT64.

range RangepartitioningRange? - [TrustedTester] [Required] Defines the ranges for range partitioning.

googleapis.bigquery: RangepartitioningRange

[TrustedTester] [Required] Defines the ranges for range partitioning.

Fields

end string? - [TrustedTester] [Required] The end of range partitioning, exclusive.

interval string? - [TrustedTester] [Required] The width of each interval.

'start string? - [TrustedTester] [Required] The start of range partitioning, inclusive.

googleapis.bigquery: RankingMetrics

Evaluation metrics used by weighted-ALS models specified by feedback_type=implicit.

Fields

averageRank float? - Determines the goodness of a ranking by computing the percentile rank from the predicted confidence and dividing it by the original rank.

meanAveragePrecision float? - Calculates a precision per user for all the items by ranking them and then averages all the precisions across all the users.

meanSquaredError float? - Similar to the mean squared error computed in regression and explicit recommendation models except instead of computing the rating directly, the output from evaluate is computed against a preference which is 1 or 0 depending on if the rating exists or not.

normalizedDiscountedCumulativeGain float? - A metric to determine the goodness of a ranking calculated from the predicted confidence by comparing it to an ideal rank measured by the original ratings.

googleapis.bigquery: RegressionMetrics

Evaluation metrics for regression and explicit feedback type matrix factorization models.

Fields

meanAbsoluteError float? - Mean absolute error.

meanSquaredError float? - Mean squared error.

meanSquaredLogError float? - Mean squared log error.

medianAbsoluteError float? - Median absolute error.

rSquared float? - R^2 score. This corresponds to r2_score in ML.EVALUATE.

googleapis.bigquery: Routine

A user-defined function or a stored procedure.

Fields

arguments Argument[]? - Optional.

creationTime string? - Output only. The time when this routine was created, in milliseconds since the epoch.

definitionBody string? - Required. The body of the routine. For functions, this is the expression in the AS clause. If language=SQL, it is the substring inside (but excluding) the parentheses. For example, for the function created with the following statement: CREATE FUNCTION JoinLines(x string, y string) as (concat(x, "\n", y)) The definition_body is concat(x, "\n", y) (\n is not replaced with linebreak). If language=JAVASCRIPT, it is the evaluated string in the AS clause. For example, for the function created with the following statement: CREATE FUNCTION f() RETURNS STRING LANGUAGE js AS 'return "\n";\n' The definition_body is return "\n";\n Note that both \n are replaced with linebreaks.

description string? - Optional. [Experimental] The description of the routine if defined.

determinismLevel string? - Optional. [Experimental] The determinism level of the JavaScript UDF if defined.

etag string? - Output only. A hash of this resource.

importedLibraries string[]? - Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries.

language string? - Optional. Defaults to "SQL".

lastModifiedTime string? - Output only. The time when this routine was last modified, in milliseconds since the epoch.

returnTableType StandardSqlTableType? - A table type

returnType StandardSqlDataType? - The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

routineReference RoutineReference? - Reference describing the ID of this routine

routineType string? - Required. The type of routine.

googleapis.bigquery: RoutineReference

Reference describing the ID of this routine

Fields

datasetId string? - [Required] The ID of the dataset containing this routine.

projectId string? - [Required] The ID of the project containing this routine.

routineId string? - [Required] The ID of the routine. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

googleapis.bigquery: Row

A single row in the confusion matrix.

Fields

actualLabel string? - The original label of this row.

entries Entry[]? - Info describing predicted label distribution.

googleapis.bigquery: RowAccessPolicy

Represents access on a subset of rows on the specified table, defined by its filter predicate. Access to the subset of rows is controlled by its IAM policy.

Fields

creationTime string? - Output only. The time when this row access policy was created, in milliseconds since the epoch.

etag string? - Output only. A hash of this resource.

filterPredicate string? - Required. A SQL boolean expression that represents the rows defined by this row access policy, similar to the boolean expression in a WHERE clause of a SELECT query on a table. References to other tables, routines, and temporary functions are not supported. Examples: region="EU" date_field = CAST('2019-9-27' as DATE) nullable_field is not NULL numeric_field BETWEEN 1.0 AND 5.0

lastModifiedTime string? - Output only. The time when this row access policy was last modified, in milliseconds since the epoch.

rowAccessPolicyReference RowAccessPolicyReference? - [Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

googleapis.bigquery: RowAccessPolicyReference

[Output-only] [Preview] The DDL target row access policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.

Fields

datasetId string? - [Required] The ID of the dataset containing this row access policy.

policyId string? - [Required] The ID of the row access policy. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 256 characters.

projectId string? - [Required] The ID of the project containing this row access policy.

tableId string? - [Required] The ID of the table containing this row access policy.

googleapis.bigquery: RowLevelSecurityStatistics

Fields

rowLevelSecurityApplied boolean? - [Output-only] [Preview] Whether any accessed data was protected by row access policies.

googleapis.bigquery: ScriptStackFrame

Fields

endColumn int? - [Output-only] One-based end column.

endLine int? - [Output-only] One-based end line.

procedureId string? - [Output-only] Name of the active procedure, empty if in a top-level script.

startColumn int? - [Output-only] One-based start column.

startLine int? - [Output-only] One-based start line.

text string? - [Output-only] Text of the current statement/expression.

googleapis.bigquery: ScriptStatistics

Fields

evaluationKind string? - [Output-only] Whether this child job was a statement or expression.

stackFrames ScriptStackFrame[]? - Stack trace showing the line/column/procedure name of each frame on the stack at the point where the current evaluation happened. The leaf frame is first, the primary script is last. Never empty.

googleapis.bigquery: SessionInfo

Fields

sessionId string? - [Output-only] // [Preview] Id of the session.

googleapis.bigquery: SetIamPolicyRequest

Request message for SetIamPolicy method.

Fields

policy Policy? - An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3 For a description of IAM and its features, see the IAM documentation.

updateMask string? - OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

googleapis.bigquery: SnapshotDefinition

Fields

baseTableReference TableReference? - [Required] Reference describing the ID of the table that was snapshot

snapshotTime string? - [Required] The time at which the base table was snapshot. This value is reported in the JSON response using RFC3339 format.

googleapis.bigquery: StandardSqlDataType

The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

Fields

arrayElementType StandardSqlDataType? - The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

structType StandardSqlStructType? - The fields of this struct, in order, if type_kind = "STRUCT"

typeKind string? - Required. The top level type of this field. Can be any standard SQL data type (e.g., "INT64", "DATE", "ARRAY").

googleapis.bigquery: StandardSqlField

A field or a column.

Fields

name string? - Optional. The name of this field. Can be absent for struct fields.

'type StandardSqlDataType? - The type of a variable, e.g., a function argument. Examples: INT64: {type_kind="INT64"} ARRAY: {type_kind="ARRAY", array_element_type="STRING"} STRUCT>: {type_kind="STRUCT", struct_type={fields=[ {name="x", type={type_kind="STRING"}}, {name="y", type={type_kind="ARRAY", array_element_type="DATE"}} ]}}

googleapis.bigquery: StandardSqlStructType

The fields of this struct, in order, if type_kind = "STRUCT"

Fields

fields StandardSqlField[]? - Array of standard sql fields

googleapis.bigquery: StandardSqlTableType

A table type

Fields

columns StandardSqlField[]? - The columns in this table type

googleapis.bigquery: Streamingbuffer

Fields

estimatedBytes string? - [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer.

estimatedRows string? - [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer.

oldestEntryTime string? - [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

googleapis.bigquery: Table

Fields

clustering Clustering? -

creationTime string? - [Output-only] The time when this table was created, in milliseconds since the epoch.

description string? - [Optional] A user-friendly description of this table.

encryptionConfiguration EncryptionConfiguration? -

etag string? - [Output-only] A hash of the table metadata. Used to ensure there were no concurrent modifications to the resource when attempting an update. Not guaranteed to change when the table contents or the fields numRows, numBytes, numLongTermBytes or lastModifiedTime change.

expirationTime string? - [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed. The defaultTableExpirationMs property of the encapsulating dataset can be used to set a default expirationTime on newly created tables.

externalDataConfiguration ExternalDataConfiguration? -

friendlyName string? - [Optional] A descriptive name for this table.

id string? - [Output-only] An opaque ID uniquely identifying the table.

kind string? - [Output-only] The type of the resource.

labels record {}? - The labels associated with this table. You can use these to organize and group your tables. Label keys and values can be no longer than 63 characters, can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter and each label in the list must have a different key.

lastModifiedTime string? - [Output-only] The time when this table was last modified, in milliseconds since the epoch.

location string? - [Output-only] The geographic location where the table resides. This value is inherited from the dataset.

materializedView MaterializedViewDefinition? -

model ModelDefinition? -

numBytes string? - [Output-only] The size of this table in bytes, excluding any data in the streaming buffer.

numLongTermBytes string? - [Output-only] The number of bytes in the table that are considered "long-term storage".

numPhysicalBytes string? - [Output-only] [TrustedTester] The physical size of this table in bytes, excluding any data in the streaming buffer. This includes compression and storage used for time travel.

numRows string? - [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer.

rangePartitioning RangePartitioning? -

requirePartitionFilter boolean? - [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.

schema TableSchema? -

selfLink string? - [Output-only] A URL that can be used to access this resource again.

snapshotDefinition SnapshotDefinition? -

streamingBuffer Streamingbuffer? -

tableReference TableReference? - [Required] Reference describing the ID of the table that was snapshot

timePartitioning TimePartitioning? -

'type string? - [Output-only] Describes the table type. The following values are supported: TABLE: A normal BigQuery table. VIEW: A virtual table defined by a SQL query. SNAPSHOT: An immutable, read-only table that is a copy of another table. [TrustedTester] MATERIALIZED_VIEW: SQL query whose result is persisted. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. The default value is TABLE.

view ViewDefinition? -

googleapis.bigquery: TableCell

Fields

v anydata? -

googleapis.bigquery: TableDataInsertAllRequest

Fields

ignoreUnknownValues boolean? - [Optional] Accept rows that contain values that do not match the schema. The unknown values are ignored. Default is false, which treats unknown values as errors.

kind string? - The resource type of the response.

rows TabledatainsertallrequestRows[]? - The rows to insert.

skipInvalidRows boolean? - [Optional] Insert all valid rows of a request, even if invalid rows exist. The default value is false, which causes the entire request to fail if any invalid rows exist.

templateSuffix string? - If specified, treats the destination table as a base template, and inserts the rows into an instance table named "{destination}{templateSuffix}". BigQuery will manage creation of the instance table, using the schema of the base template table. See https://cloud.google.com/bigquery/streaming-data-into-bigquery#template-tables for considerations when working with templates tables.

googleapis.bigquery: TabledatainsertallrequestRows

Fields

insertId string? - [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis.

'json JsonObject? - Represents a single JSON object.

googleapis.bigquery: TableDataInsertAllResponse

Fields

insertErrors TabledatainsertallresponseInserterrors[]? - An array of errors for rows that were not inserted.

kind string? - The resource type of the response.

googleapis.bigquery: TabledatainsertallresponseInserterrors

Fields

errors ErrorProto[]? - Error information for the row indicated by the index property.

index int? - The index of the row that error applies to.

googleapis.bigquery: TableDataList

Fields

etag string? - A hash of this page of results.

kind string? - The resource type of the response.

pageToken string? - A token used for paging results. Providing this token instead of the startIndex parameter can help you retrieve stable results when an underlying table is changing.

rows TableRow[]? - Rows of results.

totalRows string? - The total number of rows in the complete table.

googleapis.bigquery: TableFieldSchema

Fields

categories TablefieldschemaCategories? - [Optional] The categories attached to this field, used for field-level access control.

collationSpec string? - Optional. Collation specification of the field. It only can be set on string type field.

description string? - [Optional] The field description. The maximum length is 1,024 characters.

fields TableFieldSchema[]? - [Optional] Describes the nested schema fields if the type property is set to RECORD.

maxLength string? - [Optional] Maximum length of values of this field for STRINGS or BYTES. If max_length is not specified, no maximum length constraint is imposed on this field. If type = "STRING", then max_length represents the maximum UTF-8 length of strings in this field. If type = "BYTES", then max_length represents the maximum number of bytes in this field. It is invalid to set this field if type ≠ "STRING" and ≠ "BYTES".

mode string? - [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE.

name string? - [Required] The field name. The name must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_), and must start with a letter or underscore. The maximum length is 300 characters.

policyTags TablefieldschemaPolicytags? -

precision string? - [Optional] Precision (maximum number of total digits in base 10) and scale (maximum number of digits in the fractional part in base 10) constraints for values of this field for NUMERIC or BIGNUMERIC. It is invalid to set precision or scale if type ≠ "NUMERIC" and ≠ "BIGNUMERIC". If precision and scale are not specified, no value range constraint is imposed on this field insofar as values are permitted by the type. Values of this NUMERIC or BIGNUMERIC field must be in this range when: - Precision (P) and scale (S) are specified: [-10P-S + 10-S, 10P-S - 10-S] - Precision (P) is specified but not scale (and thus scale is interpreted to be equal to zero): [-10P + 1, 10P - 1]. Acceptable values for precision and scale if both are specified: - If type = "NUMERIC": 1 ≤ precision - scale ≤ 29 and 0 ≤ scale ≤ 9. - If type = "BIGNUMERIC": 1 ≤ precision - scale ≤ 38 and 0 ≤ scale ≤ 38. Acceptable values for precision if only precision is specified but not scale (and thus scale is interpreted to be equal to zero): - If type = "NUMERIC": 1 ≤ precision ≤ 29. - If type = "BIGNUMERIC": 1 ≤ precision ≤ 38. If scale is specified but not precision, then it is invalid.

scale string? - [Optional] See documentation for precision.

'type string? - [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), NUMERIC, BIGNUMERIC, BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, INTERVAL, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD).

googleapis.bigquery: TablefieldschemaCategories

[Optional] The categories attached to this field, used for field-level access control.

Fields

names string[]? - A list of category resource names. For example, "projects/1/taxonomies/2/categories/3". At most 5 categories are allowed.

googleapis.bigquery: TablefieldschemaPolicytags

Fields

names string[]? - A list of category resource names. For example, "projects/1/location/eu/taxonomies/2/policyTags/3". At most 1 policy tag is allowed.

googleapis.bigquery: TableList

Fields

etag string? - A hash of this page of results.

kind string? - The type of list.

nextPageToken string? - A token to request the next page of results.

tables TablelistTables[]? - Tables in the requested dataset.

totalItems int? - The total number of tables in the dataset.

googleapis.bigquery: TablelistTables

Fields

clustering Clustering? -

creationTime string? - The time when this table was created, in milliseconds since the epoch.

expirationTime string? - [Optional] The time when this table expires, in milliseconds since the epoch. If not present, the table will persist indefinitely. Expired tables will be deleted and their storage reclaimed.

friendlyName string? - The user-friendly name for this table.

id string? - An opaque ID of the table

kind string? - The resource type.

labels record {}? - The labels associated with this table. You can use these to organize and group your tables.

rangePartitioning RangePartitioning? -

tableReference TableReference? - [Required] Reference describing the ID of the table that was snapshot

timePartitioning TimePartitioning? -

'type string? - The type of table. Possible values are: TABLE, VIEW.

view TablelistView? - Additional details for a view.

googleapis.bigquery: TablelistView

Additional details for a view.

Fields

useLegacySql boolean? - True if view is defined in legacy SQL dialect, false if in standard SQL.

googleapis.bigquery: TableReference

[Required] Reference describing the ID of the table that was snapshot

Fields

datasetId string? - [Required] The ID of the dataset containing this table.

projectId string? - [Required] The ID of the project containing this table.

tableId string? - [Required] The ID of the table. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.

googleapis.bigquery: TableRow

Fields

f TableCell[]? - Represents a single row in the result set, consisting of one or more fields.

googleapis.bigquery: TableSchema

Fields

fields TableFieldSchema[]? - Describes the fields in a table.

googleapis.bigquery: TestIamPermissionsRequest

Request message for TestIamPermissions method.

Fields

permissions string[]? - The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

googleapis.bigquery: TestIamPermissionsResponse

Response message for TestIamPermissions method.

Fields

permissions string[]? - A subset of TestPermissionsRequest.permissions that the caller is allowed.

googleapis.bigquery: TimePartitioning

Fields

expirationMs string? - [Optional] Number of milliseconds for which to keep the storage for partitions in the table. The storage in a partition will have an expiration time of its partition time plus this value.

'field string? - [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified, the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.

requirePartitionFilter boolean? -

'type string? - [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively. When the type is not specified, the default behavior is DAY.

googleapis.bigquery: TrainingOptions

Options used in model training.

Fields

adjustStepChanges boolean? - If true, detect step changes and make data adjustment in the input time series.

autoArima boolean? - Whether to enable auto ARIMA or not.

autoArimaMaxOrder string? - The max value of non-seasonal p and q.

batchSize string? - Batch size for dnn models.

cleanSpikesAndDips boolean? - If true, clean spikes and dips in the input time series.

dataFrequency string? - The data frequency of a time series.

dataSplitColumn string? - The column to split data with. This column won't be used as a feature. 1. When data_split_method is CUSTOM, the corresponding column should be boolean. The rows with true value tag are eval data, and the false are training data. 2. When data_split_method is SEQ, the first DATA_SPLIT_EVAL_FRACTION rows (from smallest to largest) in the corresponding column are used as training data, and the rest are eval data. It respects the order in Orderable data types: https://cloud.google.com/bigquery/docs/reference/standard-sql/data-types#data-type-properties

dataSplitEvalFraction float? - The fraction of evaluation data over the whole input data. The rest of data will be used as training data. The format should be double. Accurate to two decimal places. Default value is 0.2.

dataSplitMethod string? - The data split type for training and evaluation, e.g. RANDOM.

decomposeTimeSeries boolean? - If true, perform decompose time series and save the results.

distanceType string? - Distance type for clustering models.

dropout float? - Dropout probability for dnn models.

earlyStop boolean? - Whether to stop early when the loss doesn't improve significantly any more (compared to min_relative_progress). Used only for iterative training algorithms.

feedbackType string? - Feedback type that specifies which algorithm to run for matrix factorization.

hiddenUnits string[]? - Hidden units for dnn models.

holidayRegion string? - The geographical region based on which the holidays are considered in time series modeling. If a valid value is specified, then holiday effects modeling is enabled.

horizon string? - The number of periods ahead that need to be forecasted.

includeDrift boolean? - Include drift when fitting an ARIMA model.

initialLearnRate float? - Specifies the initial learning rate for the line search learn rate strategy.

inputLabelColumns string[]? - Name of input label columns in training data.

itemColumn string? - Item column specified for matrix factorization models.

kmeansInitializationColumn string? - The column used to provide the initial centroids for kmeans algorithm when kmeans_initialization_method is CUSTOM.

kmeansInitializationMethod string? - The method used to initialize the centroids for kmeans algorithm.

l1Regularization float? - L1 regularization coefficient.

l2Regularization float? - L2 regularization coefficient.

labelClassWeights record {}? - Weights associated with each label class, for rebalancing the training data. Only applicable for classification models.

learnRate float? - Learning rate in training. Used only for iterative training algorithms.

learnRateStrategy string? - The strategy to determine learn rate for the current iteration.

lossType string? - Type of loss function used during training run.

maxIterations string? - The maximum number of iterations in training. Used only for iterative training algorithms.

maxTreeDepth string? - Maximum depth of a tree for boosted tree models.

minRelativeProgress float? - When early_stop is true, stops training when accuracy improvement is less than 'min_relative_progress'. Used only for iterative training algorithms.

minSplitLoss float? - Minimum split loss for boosted tree models.

modelUri string? - Google Cloud Storage URI from which the model was imported. Only applicable for imported models.

nonSeasonalOrder ArimaOrder? - Arima order, can be used for both non-seasonal and seasonal parts.

numClusters string? - Number of clusters for clustering models.

numFactors string? - Num factors specified for matrix factorization models.

optimizationStrategy string? - Optimization strategy for training linear regression models.

preserveInputStructs boolean? - Whether to preserve the input structs in output feature names. Suppose there is a struct A with field b. When false (default), the output feature name is A_b. When true, the output feature name is A.b.

subsample float? - Subsample fraction of the training data to grow tree to prevent overfitting for boosted tree models.

timeSeriesDataColumn string? - Column to be designated as time series data for ARIMA model.

timeSeriesIdColumn string? - The time series id column that was used during ARIMA model training.

timeSeriesIdColumns string[]? - The time series id columns that were used during ARIMA model training.

timeSeriesTimestampColumn string? - Column to be designated as time series timestamp for ARIMA model.

userColumn string? - User column specified for matrix factorization models.

walsAlpha float? - Hyperparameter for matrix factoration when implicit feedback type is specified.

warmStart boolean? - Whether to train a model from the last checkpoint.

googleapis.bigquery: TrainingRun

Information about a single training query run for the model.

Fields

dataSplitResult DataSplitResult? - Data split result. This contains references to the training and evaluation data tables that were used to train the model.

evaluationMetrics EvaluationMetrics? - Evaluation metrics of a model. These are either computed on all training data or just the eval data based on whether eval data was used during training. These are not present for imported models.

results IterationResult[]? - Output of each iteration run, results.size() <= max_iterations.

startTime string? - The start time of this training run.

trainingOptions TrainingOptions? - Options used in model training.

googleapis.bigquery: TransactionInfo

Fields

transactionId string? - [Output-only] // [Alpha] Id of the transaction.

googleapis.bigquery: UserDefinedFunctionResource

This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of Standard SQL should leverage either DDL (e.g. CREATE [TEMPORARY] FUNCTION ... ) or the Routines API to define UDF resources. For additional information on migrating, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/migrating-from-legacy-sql#differences_in_user-defined_javascript_functions

Fields

inlineCode string? - [Pick one] An inline resource that contains code for a user-defined function (UDF). Providing a inline code resource is equivalent to providing a URI for a file containing the same code.

resourceUri string? - [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path).

googleapis.bigquery: ViewDefinition

Fields

query string? - [Required] A query that BigQuery executes when the view is referenced.

useExplicitColumnNames boolean? - True if the column names are explicitly specified. For example by using the 'CREATE VIEW v(c1, c2) AS ...' syntax. Can only be set using BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/

useLegacySql boolean? - Specifies whether to use BigQuery's legacy SQL for this view. The default value is true. If set to false, the view will use BigQuery's standard SQL: https://cloud.google.com/bigquery/sql-reference/ Queries and views that reference this view must use the same flag value.

userDefinedFunctionResources UserDefinedFunctionResource[]? - Describes user-defined function resources used in the query.

Import

import ballerinax/googleapis.bigquery;

Metadata

Released date: over 1 year ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 8

Current verison: 5

Weekly downloads

Source repository

Keywords

IT Operations/Databases

Cost/Freemium

Vendor/Google

Contributors

Other versions

1.5.1

1.5.0 1.4.0 1.2.0 1.1.0

Dependencies

ballerina/url/2.2.3 ballerina/http/2.6.1

Cookie policy

Delete policy

clients

records

ballerinax/googleapis.bigquery Ballerina library

Overview

Prerequisites

Quickstart

Step 1: Import connector

Step 2: Create a new connector instance

Step 3: Invoke connector operation

Clients

googleapis.bigquery: Client

Constructor

listProjects

Parameters

Return Type

listDatasets

Parameters

Return Type

insertDataset

Parameters

Return Type

getDataset

Parameters

Return Type

updateDataset

Parameters

Return Type

deleteDataset

Parameters

Return Type

patchDataset

Parameters

Return Type

listModel

Parameters

Return Type

getModel

Parameters

Return Type

deleteModel

Parameters

Return Type

patchModel

Parameters

Return Type

listRoutines

Parameters

Return Type

insertRoutine

Parameters

Return Type

getRoutine

Parameters

Return Type

updateRoutine

Parameters

Return Type

deleteRoutine

Parameters

Return Type

listTables

Parameters

Return Type

insertTable

Parameters

Return Type

getTable

Parameters

Return Type

updateTable

Parameters

Return Type

deleteTable

Parameters

Return Type

patchTable

Parameters

Return Type

listTableData

Parameters