google_api_big_query v0.12.0 API Reference
Modules
API calls for all endpoints tagged Datasets
.
API calls for all endpoints tagged Jobs
.
API calls for all endpoints tagged Models
.
API calls for all endpoints tagged Projects
.
API calls for all endpoints tagged Routines
.
API calls for all endpoints tagged Tabledata
.
API calls for all endpoints tagged Tables
.
Handle Tesla connections for GoogleApi.BigQuery.V2.
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.
Input/output argument of a function or a stored procedure.
Attributes
- currentIteration (integer()): [Output-only, Beta] Index of current ML training iteration. Updated during create model query job to show job progress. Defaults to
nil
. - expectedTotalIterations (String.t): [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. Defaults to
nil
.
Attributes
- encoding (String.t): [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. Defaults to
nil
. - fieldName (String.t): [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. Defaults to
nil
. - 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. Defaults to
nil
. - qualifierEncoded (String.t): [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 qualifierstring 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. Defaults to
nil
. - qualifierString (String.t): Defaults to
nil
. - type (String.t): [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. Defaults to
nil
.
Attributes
- columns (list(GoogleApi.BigQuery.V2.Model.BigtableColumn.t)): [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. Defaults to
nil
. - encoding (String.t): [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. Defaults to
nil
. - familyId (String.t): Identifier of the column family. Defaults to
nil
. - 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. Defaults to
nil
. - type (String.t): [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. Defaults to
nil
.
Attributes
- columnFamilies (list(GoogleApi.BigQuery.V2.Model.BigtableColumnFamily.t)): [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. Defaults to
nil
. - 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. Defaults to
nil
. - 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. Defaults to
nil
.
Evaluation metrics for binary classification/classifier models.
Confusion matrix for binary classification models.
Attributes
- durationMs (String.t): [Output-only, Beta] Time taken to run the training iteration in milliseconds. Defaults to
nil
. - 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. Defaults to
nil
. - index (integer()): [Output-only, Beta] Index of the ML training iteration, starting from zero for each training run. Defaults to
nil
. - 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. Defaults to
nil
. - 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. Defaults to
nil
.
Attributes
- iterationResults (list(GoogleApi.BigQuery.V2.Model.BqmlIterationResult.t)): [Output-only, Beta] List of each iteration results. Defaults to
nil
. - startTime (DateTime.t): [Output-only, Beta] Training run start time in milliseconds since the epoch. Defaults to
nil
. - state (String.t): [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. Defaults to
nil
. - trainingOptions (GoogleApi.BigQuery.V2.Model.BqmlTrainingRunTrainingOptions.t): [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. Defaults to
nil
.
[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.
Information about a single cluster for clustering model.
Attributes
- fields (list(String.t)): [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. Defaults to
nil
.
Evaluation metrics for clustering models.
Confusion matrix for multi-class classification models.
Attributes
- 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. Defaults to
nil
. - allowQuotedNewlines (boolean()): [Optional] Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. Defaults to
nil
. - encoding (String.t): [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. Defaults to
nil
. - fieldDelimiter (String.t): [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 " " to specify a tab separator. The default value is a comma (','). Defaults to
nil
. - quote (String.t): [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. Defaults to
"
. - skipLeadingRows (String.t): [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. Defaults to
nil
.
Attributes
- access (list(GoogleApi.BigQuery.V2.Model.DatasetAccess.t)): [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; Defaults to
nil
. - creationTime (String.t): [Output-only] The time when this dataset was created, in milliseconds since the epoch. Defaults to
nil
. - datasetReference (GoogleApi.BigQuery.V2.Model.DatasetReference.t): [Required] A reference that identifies the dataset. Defaults to
nil
. - defaultPartitionExpirationMs (String.t): [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. Defaults to
nil
. - defaultTableExpirationMs (String.t): [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. Defaults to
nil
. - description (String.t): [Optional] A user-friendly description of the dataset. Defaults to
nil
. - etag (String.t): [Output-only] A hash of the resource. Defaults to
nil
. - friendlyName (String.t): [Optional] A descriptive name for the dataset. Defaults to
nil
. - id (String.t): [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. Defaults to
nil
. - kind (String.t): [Output-only] The resource type. Defaults to
bigquery#dataset
. - labels (map()): 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. Defaults to
nil
. - lastModifiedTime (String.t): [Output-only] The date when this dataset or any of its tables was last modified, in milliseconds since the epoch. Defaults to
nil
. - location (String.t): The geographic location where the dataset should reside. The default value is US. See details at https://cloud.google.com/bigquery/docs/locations. Defaults to
nil
. - selfLink (String.t): [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. Defaults to
nil
.
Attributes
- domain (String.t): [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". Defaults to
nil
. - groupByEmail (String.t): [Pick one] An email address of a Google Group to grant access to. Maps to IAM policy member "group:GROUP". Defaults to
nil
. - iamMember (String.t): [Pick one] Some other type of member that appears in the IAM Policy but isn't a user, group, domain, or special group. Defaults to
nil
. - role (String.t): [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". Defaults to
nil
. - specialGroup (String.t): [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. Defaults to
nil
. - userByEmail (String.t): [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". Defaults to
nil
. - view (GoogleApi.BigQuery.V2.Model.TableReference.t): [Pick one] A view from a different dataset to grant access to. Queries executed against that view will have read access to tables in this dataset. The role field is not required when this field is set. If that view is updated by any user, access to the view needs to be granted again via an update operation. Defaults to
nil
.
Attributes
- datasets (list(GoogleApi.BigQuery.V2.Model.DatasetListDatasets.t)): 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. Defaults to
nil
. - etag (String.t): A hash value of the results page. You can use this property to determine if the page has changed since the last request. Defaults to
nil
. - kind (String.t): The list type. This property always returns the value "bigquery#datasetList". Defaults to
bigquery#datasetList
. - nextPageToken (String.t): A token that can be used to request the next results page. This property is omitted on the final results page. Defaults to
nil
.
Attributes
- datasetReference (GoogleApi.BigQuery.V2.Model.DatasetReference.t): The dataset reference. Use this property to access specific parts of the dataset's ID, such as project ID or dataset ID. Defaults to
nil
. - friendlyName (String.t): A descriptive name for the dataset, if one exists. Defaults to
nil
. - id (String.t): The fully-qualified, unique, opaque ID of the dataset. Defaults to
nil
. - kind (String.t): The resource type. This property always returns the value "bigquery#dataset". Defaults to
bigquery#dataset
. - labels (map()): The labels associated with this dataset. You can use these to organize and group your datasets. Defaults to
nil
. - location (String.t): The geographic location where the data resides. Defaults to
nil
.
Attributes
- datasetId (String.t): [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. Defaults to
nil
. - projectId (String.t): [Optional] The ID of the project containing this dataset. Defaults to
nil
.
Attributes
- description (String.t): [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. Defaults to
nil
. - friendlyName (String.t): [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. Defaults to
nil
. - labels (map()): [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. Defaults to
nil
.
A single entry in the confusion matrix.
Attributes
- debugInfo (String.t): Debugging information. This property is internal to Google and should not be used. Defaults to
nil
. - location (String.t): Specifies where the error occurred, if present. Defaults to
nil
. - message (String.t): A human-readable description of the error. Defaults to
nil
. - reason (String.t): A short error code that summarizes the error. Defaults to
nil
.
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.
Attributes
- completedParallelInputs (String.t): Number of parallel input segments completed. Defaults to
nil
. - computeMsAvg (String.t): Milliseconds the average shard spent on CPU-bound tasks. Defaults to
nil
. - computeMsMax (String.t): Milliseconds the slowest shard spent on CPU-bound tasks. Defaults to
nil
. - computeRatioAvg (float()): Relative amount of time the average shard spent on CPU-bound tasks. Defaults to
nil
. - computeRatioMax (float()): Relative amount of time the slowest shard spent on CPU-bound tasks. Defaults to
nil
. - endMs (String.t): Stage end time represented as milliseconds since epoch. Defaults to
nil
. - id (String.t): Unique ID for stage within plan. Defaults to
nil
. - inputStages (list(String.t)): IDs for stages that are inputs to this stage. Defaults to
nil
. - name (String.t): Human-readable name for stage. Defaults to
nil
. - parallelInputs (String.t): Number of parallel input segments to be processed. Defaults to
nil
. - readMsAvg (String.t): Milliseconds the average shard spent reading input. Defaults to
nil
. - readMsMax (String.t): Milliseconds the slowest shard spent reading input. Defaults to
nil
. - readRatioAvg (float()): Relative amount of time the average shard spent reading input. Defaults to
nil
. - readRatioMax (float()): Relative amount of time the slowest shard spent reading input. Defaults to
nil
. - recordsRead (String.t): Number of records read into the stage. Defaults to
nil
. - recordsWritten (String.t): Number of records written by the stage. Defaults to
nil
. - shuffleOutputBytes (String.t): Total number of bytes written to shuffle. Defaults to
nil
. - shuffleOutputBytesSpilled (String.t): Total number of bytes written to shuffle and spilled to disk. Defaults to
nil
. - startMs (String.t): Stage start time represented as milliseconds since epoch. Defaults to
nil
. - status (String.t): Current status for the stage. Defaults to
nil
. - steps (list(GoogleApi.BigQuery.V2.Model.ExplainQueryStep.t)): List of operations within the stage in dependency order (approximately chronological). Defaults to
nil
. - waitMsAvg (String.t): Milliseconds the average shard spent waiting to be scheduled. Defaults to
nil
. - waitMsMax (String.t): Milliseconds the slowest shard spent waiting to be scheduled. Defaults to
nil
. - waitRatioAvg (float()): Relative amount of time the average shard spent waiting to be scheduled. Defaults to
nil
. - waitRatioMax (float()): Relative amount of time the slowest shard spent waiting to be scheduled. Defaults to
nil
. - writeMsAvg (String.t): Milliseconds the average shard spent on writing output. Defaults to
nil
. - writeMsMax (String.t): Milliseconds the slowest shard spent on writing output. Defaults to
nil
. - writeRatioAvg (float()): Relative amount of time the average shard spent on writing output. Defaults to
nil
. - writeRatioMax (float()): Relative amount of time the slowest shard spent on writing output. Defaults to
nil
.
Attributes
- autodetect (boolean()): Try to detect schema and format options automatically. Any option specified explicitly will be honored. Defaults to
nil
. - bigtableOptions (GoogleApi.BigQuery.V2.Model.BigtableOptions.t): [Optional] Additional options if sourceFormat is set to BIGTABLE. Defaults to
nil
. - compression (String.t): [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. Defaults to
nil
. - csvOptions (GoogleApi.BigQuery.V2.Model.CsvOptions.t): Additional properties to set if sourceFormat is set to CSV. Defaults to
nil
. - googleSheetsOptions (GoogleApi.BigQuery.V2.Model.GoogleSheetsOptions.t): [Optional] Additional options if sourceFormat is set to GOOGLE_SHEETS. Defaults to
nil
. - hivePartitioningMode (String.t): [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Defaults to
nil
. - 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. Defaults to
nil
. - maxBadRecords (integer()): [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. Defaults to
nil
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): [Optional] The schema for the data. Schema is required for CSV and JSON formats. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, and Avro formats. Defaults to
nil
. - sourceFormat (String.t): [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". Defaults to
nil
. - sourceUris (list(String.t)): [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. Defaults to
nil
.
Attributes
- cacheHit (boolean()): Whether the query result was fetched from the query cache. Defaults to
nil
. - errors (list(GoogleApi.BigQuery.V2.Model.ErrorProto.t)): [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. Defaults to
nil
. - etag (String.t): A hash of this response. Defaults to
nil
. - 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. Defaults to
nil
. - jobReference (GoogleApi.BigQuery.V2.Model.JobReference.t): Reference to the BigQuery Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). Defaults to
nil
. - kind (String.t): The resource type of the response. Defaults to
bigquery#getQueryResultsResponse
. - numDmlAffectedRows (String.t): [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. Defaults to
nil
. - pageToken (String.t): A token used for paging results. Defaults to
nil
. - rows (list(GoogleApi.BigQuery.V2.Model.TableRow.t)): 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. Defaults to
nil
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): The schema of the results. Present only when the query completes successfully. Defaults to
nil
. - totalBytesProcessed (String.t): The total number of bytes processed for this query. Defaults to
nil
. - totalRows (String.t): 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. Defaults to
nil
.
Attributes
- range (String.t): [Beta] [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 Defaults to
nil
. - skipLeadingRows (String.t): [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. Defaults to
nil
.
Information about a single iteration of the training run.
Attributes
- configuration (GoogleApi.BigQuery.V2.Model.JobConfiguration.t): [Required] Describes the job configuration. Defaults to
nil
. - etag (String.t): [Output-only] A hash of this resource. Defaults to
nil
. - id (String.t): [Output-only] Opaque ID field of the job Defaults to
nil
. - jobReference (GoogleApi.BigQuery.V2.Model.JobReference.t): [Optional] Reference describing the unique-per-user name of the job. Defaults to
nil
. - kind (String.t): [Output-only] The type of the resource. Defaults to
bigquery#job
. - selfLink (String.t): [Output-only] A URL that can be used to access this resource again. Defaults to
nil
. - statistics (GoogleApi.BigQuery.V2.Model.JobStatistics.t): [Output-only] Information about the job, including starting time and ending time of the job. Defaults to
nil
. - status (GoogleApi.BigQuery.V2.Model.JobStatus.t): [Output-only] The status of this job. Examine this value when polling an asynchronous job to see if the job is complete. Defaults to
nil
. - user_email (String.t): [Output-only] Email address of the user who ran the job. Defaults to
nil
.
Attributes
- copy (GoogleApi.BigQuery.V2.Model.JobConfigurationTableCopy.t): [Pick one] Copies a table. Defaults to
nil
. - 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. Defaults to
nil
. - extract (GoogleApi.BigQuery.V2.Model.JobConfigurationExtract.t): [Pick one] Configures an extract job. Defaults to
nil
. - jobTimeoutMs (String.t): [Optional] Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job. Defaults to
nil
. - jobType (String.t): [Output-only] The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN. Defaults to
nil
. - labels (map()): 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. Defaults to
nil
. - load (GoogleApi.BigQuery.V2.Model.JobConfigurationLoad.t): [Pick one] Configures a load job. Defaults to
nil
. - query (GoogleApi.BigQuery.V2.Model.JobConfigurationQuery.t): [Pick one] Configures a query job. Defaults to
nil
.
Attributes
- compression (String.t): [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. Defaults to
nil
. - destinationFormat (String.t): [Optional] The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO. The default value is CSV. Tables with nested or repeated fields cannot be exported as CSV. Defaults to
nil
. - destinationUri (String.t): [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. Defaults to
nil
. - destinationUris (list(String.t)): [Pick one] A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written. Defaults to
nil
. - fieldDelimiter (String.t): [Optional] Delimiter to use between fields in the exported data. Default is ',' Defaults to
nil
. - printHeader (boolean()): [Optional] Whether to print out a header row in the results. Default is true. Defaults to
true
. - sourceTable (GoogleApi.BigQuery.V2.Model.TableReference.t): [Required] A reference to the table being exported. Defaults to
nil
.
Attributes
- 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. Defaults to
nil
. - allowQuotedNewlines (boolean()): Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file. The default value is false. Defaults to
nil
. - autodetect (boolean()): [Optional] Indicates if we should automatically infer the options and schema for CSV and JSON sources. Defaults to
nil
. - clustering (GoogleApi.BigQuery.V2.Model.Clustering.t): [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. Defaults to
nil
. - createDisposition (String.t): [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. Defaults to
nil
. - destinationEncryptionConfiguration (GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t): Custom encryption configuration (e.g., Cloud KMS keys). Defaults to
nil
. - destinationTable (GoogleApi.BigQuery.V2.Model.TableReference.t): [Required] The destination table to load the data into. Defaults to
nil
. - destinationTableProperties (GoogleApi.BigQuery.V2.Model.DestinationTableProperties.t): [Beta] [Optional] Properties with which to create the destination table if it is new. Defaults to
nil
. - encoding (String.t): [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. Defaults to
nil
. - fieldDelimiter (String.t): [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 " " to specify a tab separator. The default value is a comma (','). Defaults to
nil
. - hivePartitioningMode (String.t): [Optional, Experimental] If hive partitioning is enabled, which mode to use. Two modes are supported: - AUTO: automatically infer partition key name(s) and type(s). - STRINGS: automatic infer partition key name(s). All types are strings. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error. Defaults to
nil
. - 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 Defaults to
nil
. - maxBadRecords (integer()): [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. Defaults to
nil
. - nullMarker (String.t): [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. Defaults to
nil
. - projectionFields (list(String.t)): 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. Defaults to
nil
. - quote (String.t): [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. Defaults to
"
. - rangePartitioning (GoogleApi.BigQuery.V2.Model.RangePartitioning.t): [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): [Optional] The schema for the destination table. The schema can be omitted if the destination table already exists, or if you're loading data from Google Cloud Datastore. Defaults to
nil
. - schemaInline (String.t): [Deprecated] The inline schema. For CSV schemas, specify as "Field1:Type1[,Field2:Type2]*". For example, "foo:STRING, bar:INTEGER, baz:FLOAT". Defaults to
nil
. - schemaInlineFormat (String.t): [Deprecated] The format of the schemaInline property. Defaults to
nil
. - schemaUpdateOptions (list(String.t)): 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. Defaults to
nil
. - skipLeadingRows (integer()): [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. Defaults to
nil
. - sourceFormat (String.t): [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. Defaults to
nil
. - sourceUris (list(String.t)): [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. Defaults to
nil
. - timePartitioning (GoogleApi.BigQuery.V2.Model.TimePartitioning.t): Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - 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). Defaults to
nil
. - writeDisposition (String.t): [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. Defaults to
nil
.
Attributes
- 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. Defaults to
false
. - clustering (GoogleApi.BigQuery.V2.Model.Clustering.t): [Beta] Clustering specification for the destination table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered. Defaults to
nil
. - createDisposition (String.t): [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. Defaults to
nil
. - defaultDataset (GoogleApi.BigQuery.V2.Model.DatasetReference.t): [Optional] Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names. Defaults to
nil
. - destinationEncryptionConfiguration (GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t): Custom encryption configuration (e.g., Cloud KMS keys). Defaults to
nil
. - destinationTable (GoogleApi.BigQuery.V2.Model.TableReference.t): [Optional] Describes the table where the query results should be stored. If not present, a new table will be created to store the results. This property must be set for large results that exceed the maximum response size. Defaults to
nil
. - 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. Defaults to
true
. - maximumBillingTier (integer()): [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. Defaults to
1
. - maximumBytesBilled (String.t): [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. Defaults to
nil
. - parameterMode (String.t): Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. Defaults to
nil
. - preserveNulls (boolean()): [Deprecated] This property is deprecated. Defaults to
nil
. - priority (String.t): [Optional] Specifies a priority for the query. Possible values include INTERACTIVE and BATCH. The default value is INTERACTIVE. Defaults to
nil
. - query (String.t): [Required] SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL. Defaults to
nil
. - queryParameters (list(GoogleApi.BigQuery.V2.Model.QueryParameter.t)): Query parameters for standard SQL queries. Defaults to
nil
. - rangePartitioning (GoogleApi.BigQuery.V2.Model.RangePartitioning.t): [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - schemaUpdateOptions (list(String.t)): 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. Defaults to
nil
. - tableDefinitions (%{optional(String.t) => GoogleApi.BigQuery.V2.Model.ExternalDataConfiguration.t}): [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. Defaults to
nil
. - timePartitioning (GoogleApi.BigQuery.V2.Model.TimePartitioning.t): Time-based partitioning specification for the destination table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - 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. Defaults to
true
. - 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. Defaults to
true
. - userDefinedFunctionResources (list(GoogleApi.BigQuery.V2.Model.UserDefinedFunctionResource.t)): Describes user-defined function resources used in the query. Defaults to
nil
. - writeDisposition (String.t): [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. Defaults to
nil
.
Attributes
- createDisposition (String.t): [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. Defaults to
nil
. - destinationEncryptionConfiguration (GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t): Custom encryption configuration (e.g., Cloud KMS keys). Defaults to
nil
. - destinationTable (GoogleApi.BigQuery.V2.Model.TableReference.t): [Required] The destination table Defaults to
nil
. - sourceTable (GoogleApi.BigQuery.V2.Model.TableReference.t): [Pick one] Source table to copy. Defaults to
nil
. - sourceTables (list(GoogleApi.BigQuery.V2.Model.TableReference.t)): [Pick one] Source tables to copy. Defaults to
nil
. - writeDisposition (String.t): [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. Defaults to
nil
.
Attributes
- etag (String.t): A hash of this page of results. Defaults to
nil
. - jobs (list(GoogleApi.BigQuery.V2.Model.JobListJobs.t)): List of jobs that were requested. Defaults to
nil
. - kind (String.t): The resource type of the response. Defaults to
bigquery#jobList
. - nextPageToken (String.t): A token to request the next page of results. Defaults to
nil
.
Attributes
- configuration (GoogleApi.BigQuery.V2.Model.JobConfiguration.t): [Full-projection-only] Specifies the job configuration. Defaults to
nil
. - errorResult (GoogleApi.BigQuery.V2.Model.ErrorProto.t): A result object that will be present only if the job has failed. Defaults to
nil
. - id (String.t): Unique opaque ID of the job. Defaults to
nil
. - jobReference (GoogleApi.BigQuery.V2.Model.JobReference.t): Job reference uniquely identifying the job. Defaults to
nil
. - kind (String.t): The resource type. Defaults to
bigquery#job
. - state (String.t): Running state of the job. When the state is DONE, errorResult can be checked to determine whether the job succeeded or failed. Defaults to
nil
. - statistics (GoogleApi.BigQuery.V2.Model.JobStatistics.t): [Output-only] Information about the job, including starting time and ending time of the job. Defaults to
nil
. - status (GoogleApi.BigQuery.V2.Model.JobStatus.t): [Full-projection-only] Describes the state of the job. Defaults to
nil
. - user_email (String.t): [Full-projection-only] Email address of the user who ran the job. Defaults to
nil
.
Attributes
- jobId (String.t): [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. Defaults to
nil
. - location (String.t): The geographic location of the job. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. Defaults to
nil
. - projectId (String.t): [Required] The ID of the project containing this job. Defaults to
nil
.
Attributes
- completionRatio (float()): [TrustedTester] [Output-only] Job progress (0.0 -> 1.0) for LOAD and EXTRACT jobs. Defaults to
nil
. - creationTime (String.t): [Output-only] Creation time of this job, in milliseconds since the epoch. This field will be present on all jobs. Defaults to
nil
. - endTime (String.t): [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. Defaults to
nil
. - extract (GoogleApi.BigQuery.V2.Model.JobStatistics4.t): [Output-only] Statistics for an extract job. Defaults to
nil
. - load (GoogleApi.BigQuery.V2.Model.JobStatistics3.t): [Output-only] Statistics for a load job. Defaults to
nil
. - numChildJobs (String.t): [Output-only] Number of child jobs executed. Defaults to
nil
. - parentJobId (String.t): [Output-only] If this is a child job, the id of the parent. Defaults to
nil
. - query (GoogleApi.BigQuery.V2.Model.JobStatistics2.t): [Output-only] Statistics for a query job. Defaults to
nil
. - quotaDeferments (list(String.t)): [Output-only] Quotas which delayed this job's start time. Defaults to
nil
. - reservationUsage (list(GoogleApi.BigQuery.V2.Model.JobStatisticsReservationUsage.t)): [Output-only] Job resource usage breakdown by reservation. Defaults to
nil
. - startTime (String.t): [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. Defaults to
nil
. - totalBytesProcessed (String.t): [Output-only] [Deprecated] Use the bytes processed in the query statistics instead. Defaults to
nil
. - totalSlotMs (String.t): [Output-only] Slot-milliseconds for the job. Defaults to
nil
.
Attributes
- billingTier (integer()): [Output-only] Billing tier for the job. Defaults to
nil
. - cacheHit (boolean()): [Output-only] Whether the query result was fetched from the query cache. Defaults to
nil
. - ddlOperationPerformed (String.t): 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. Defaults to
nil
. - ddlTargetRoutine (GoogleApi.BigQuery.V2.Model.RoutineReference.t): The DDL target routine. Present only for CREATE/DROP FUNCTION/PROCEDURE queries. Defaults to
nil
. - ddlTargetTable (GoogleApi.BigQuery.V2.Model.TableReference.t): The DDL target table. Present only for CREATE/DROP TABLE/VIEW queries. Defaults to
nil
. - estimatedBytesProcessed (String.t): [Output-only] The original estimate of bytes processed for the job. Defaults to
nil
. - modelTraining (GoogleApi.BigQuery.V2.Model.BigQueryModelTraining.t): [Output-only, Beta] Information about create model query job progress. Defaults to
nil
. - modelTrainingCurrentIteration (integer()): [Output-only, Beta] Deprecated; do not use. Defaults to
nil
. - modelTrainingExpectedTotalIteration (String.t): [Output-only, Beta] Deprecated; do not use. Defaults to
nil
. - numDmlAffectedRows (String.t): [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. Defaults to
nil
. - queryPlan (list(GoogleApi.BigQuery.V2.Model.ExplainQueryStage.t)): [Output-only] Describes execution plan for the query. Defaults to
nil
. - referencedTables (list(GoogleApi.BigQuery.V2.Model.TableReference.t)): [Output-only] Referenced tables for the job. Queries that reference more than 50 tables will not have a complete list. Defaults to
nil
. - reservationUsage (list(GoogleApi.BigQuery.V2.Model.JobStatistics2ReservationUsage.t)): [Output-only] Job resource usage breakdown by reservation. Defaults to
nil
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): [Output-only] The schema of the results. Present only for successful dry run of non-legacy SQL queries. Defaults to
nil
. - statementType (String.t): 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. "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. Defaults to
nil
. - timeline (list(GoogleApi.BigQuery.V2.Model.QueryTimelineSample.t)): [Output-only] [Beta] Describes a timeline of job execution. Defaults to
nil
. - totalBytesBilled (String.t): [Output-only] Total bytes billed for the job. Defaults to
nil
. - totalBytesProcessed (String.t): [Output-only] Total bytes processed for the job. Defaults to
nil
. - totalBytesProcessedAccuracy (String.t): [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. Defaults to
nil
. - totalPartitionsProcessed (String.t): [Output-only] Total number of partitions processed from all partitioned tables referenced in the job. Defaults to
nil
. - totalSlotMs (String.t): [Output-only] Slot-milliseconds for the job. Defaults to
nil
. - undeclaredQueryParameters (list(GoogleApi.BigQuery.V2.Model.QueryParameter.t)): Standard SQL only: list of undeclared query parameters detected during a dry run validation. Defaults to
nil
.
Attributes
- badRecords (String.t): [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. Defaults to
nil
. - inputFileBytes (String.t): [Output-only] Number of bytes of source data in a load job. Defaults to
nil
. - inputFiles (String.t): [Output-only] Number of source files in a load job. Defaults to
nil
. - outputBytes (String.t): [Output-only] Size of the loaded data in bytes. Note that while a load job is in the running state, this value may change. Defaults to
nil
. - outputRows (String.t): [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. Defaults to
nil
.
Attributes
- destinationUriFileCounts (list(String.t)): [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. Defaults to
nil
. - inputBytes (String.t): [Output-only] Number of user bytes extracted into the result. This is the byte count as computed by BigQuery for billing purposes. Defaults to
nil
.
Attributes
- errorResult (GoogleApi.BigQuery.V2.Model.ErrorProto.t): [Output-only] Final error result of the job. If present, indicates that the job has completed and was unsuccessful. Defaults to
nil
. - errors (list(GoogleApi.BigQuery.V2.Model.ErrorProto.t)): [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. Defaults to
nil
. - state (String.t): [Output-only] Running state of the job. Defaults to
nil
.
Attributes
- models (list(GoogleApi.BigQuery.V2.Model.Model.t)): Models in the requested dataset. Only the following fields are populated:
model_reference, model_type, creation_time, last_modified_time and
labels. Defaults to
nil
. - nextPageToken (String.t): A token to request the next page of results. Defaults to
nil
.
Attributes
- nextPageToken (String.t): A token to request the next page of results. Defaults to
nil
. - routines (list(GoogleApi.BigQuery.V2.Model.Routine.t)): Routines in the requested dataset. Only the following fields are populated:
etag, project_id, dataset_id, routine_id, routine_type, creation_time,
last_modified_time, language. Defaults to
nil
.
BigQuery-specific metadata about a location. This will be set on google.cloud.location.Location.metadata in Cloud Location API responses.
Attributes
- creationTime (String.t): Output only. The time when this model was created, in millisecs since the
epoch. Defaults to
nil
. - description (String.t): [Optional] A user-friendly description of this model. Defaults to
nil
. - etag (String.t): Output only. A hash of this resource. Defaults to
nil
. - expirationTime (String.t): [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. Defaults to
nil
. - featureColumns (list(GoogleApi.BigQuery.V2.Model.StandardSqlField.t)): Output only. Input feature columns that were used to train this model. Defaults to
nil
. - friendlyName (String.t): [Optional] A descriptive name for this model. Defaults to
nil
. - labelColumns (list(GoogleApi.BigQuery.V2.Model.StandardSqlField.t)): Output only. Label columns that were used to train this model.
The output of the model will have a "predicted_" prefix to these columns. Defaults to
nil
. - labels (map()): [Optional] 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. Defaults to
nil
. - lastModifiedTime (String.t): Output only. The time when this model was last modified, in millisecs
since the epoch. Defaults to
nil
. - location (String.t): Output only. The geographic location where the model resides. This value
is inherited from the dataset. Defaults to
nil
. - modelReference (GoogleApi.BigQuery.V2.Model.ModelReference.t): Required. Unique identifier for this model. Defaults to
nil
. - modelType (String.t): Output only. Type of the model resource. Defaults to
nil
. - trainingRuns (list(GoogleApi.BigQuery.V2.Model.TrainingRun.t)): Output only. Information for all training runs in increasing order of
start_time. Defaults to
nil
.
Attributes
- modelOptions (GoogleApi.BigQuery.V2.Model.ModelDefinitionModelOptions.t): [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. Defaults to
nil
. - trainingRuns (list(GoogleApi.BigQuery.V2.Model.BqmlTrainingRun.t)): [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. Defaults to
nil
.
[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.
Id path of a model.
Evaluation metrics for multi-class classification/classifier models.
Attributes
- etag (String.t): A hash of the page of results Defaults to
nil
. - kind (String.t): The type of list. Defaults to
bigquery#projectList
. - nextPageToken (String.t): A token to request the next page of results. Defaults to
nil
. - projects (list(GoogleApi.BigQuery.V2.Model.ProjectListProjects.t)): Projects to which you have at least READ access. Defaults to
nil
. - totalItems (integer()): The total number of projects in the list. Defaults to
nil
.
Attributes
- friendlyName (String.t): A descriptive name for this project. Defaults to
nil
. - id (String.t): An opaque ID of this project. Defaults to
nil
. - kind (String.t): The resource type. Defaults to
bigquery#project
. - numericId (String.t): The numeric ID of this project. Defaults to
nil
. - projectReference (GoogleApi.BigQuery.V2.Model.ProjectReference.t): A unique reference to this project. Defaults to
nil
.
Attributes
- name (String.t): [Optional] If unset, this is a positional parameter. Otherwise, should be unique within a query. Defaults to
nil
. - parameterType (GoogleApi.BigQuery.V2.Model.QueryParameterType.t): [Required] The type of this parameter. Defaults to
nil
. - parameterValue (GoogleApi.BigQuery.V2.Model.QueryParameterValue.t): [Required] The value of this parameter. Defaults to
nil
.
Attributes
- arrayType (GoogleApi.BigQuery.V2.Model.QueryParameterType.t): [Optional] The type of the array's elements, if this is an array. Defaults to
nil
. - structTypes (list(GoogleApi.BigQuery.V2.Model.QueryParameterTypeStructTypes.t)): [Optional] The types of the fields of this struct, in order, if this is a struct. Defaults to
nil
. - type (String.t): [Required] The top level type of this field. Defaults to
nil
.
Attributes
- arrayValues (list(GoogleApi.BigQuery.V2.Model.QueryParameterValue.t)): [Optional] The array values, if this is an array type. Defaults to
nil
. - structValues (%{optional(String.t) => GoogleApi.BigQuery.V2.Model.QueryParameterValue.t}): [Optional] The struct field values, in order of the struct type's declaration. Defaults to
nil
. - value (String.t): [Optional] The value of this value, if a simple scalar type. Defaults to
nil
.
Attributes
- defaultDataset (GoogleApi.BigQuery.V2.Model.DatasetReference.t): [Optional] Specifies the default datasetId and projectId to assume for any unqualified table names in the query. If not set, all table names in the query string must be qualified in the format 'datasetId.tableId'. Defaults to
nil
. - 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. Defaults to
nil
. - kind (String.t): The resource type of the request. Defaults to
bigquery#queryRequest
. - location (String.t): The geographic location where the job should run. See details at https://cloud.google.com/bigquery/docs/locations#specifying_your_location. Defaults to
nil
. - maxResults (integer()): [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. Defaults to
nil
. - parameterMode (String.t): Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query. Defaults to
nil
. - preserveNulls (boolean()): [Deprecated] This property is deprecated. Defaults to
nil
. - query (String.t): [Required] A query string, following the BigQuery query syntax, of the query to execute. Example: "SELECT count(f1) FROM [myProjectId:myDatasetId.myTableId]". Defaults to
nil
. - queryParameters (list(GoogleApi.BigQuery.V2.Model.QueryParameter.t)): Query parameters for Standard SQL queries. Defaults to
nil
. - timeoutMs (integer()): [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). Defaults to
nil
. - 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. Defaults to
true
. - 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. Defaults to
true
.
Attributes
- cacheHit (boolean()): Whether the query result was fetched from the query cache. Defaults to
nil
. - errors (list(GoogleApi.BigQuery.V2.Model.ErrorProto.t)): [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. Defaults to
nil
. - 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. Defaults to
nil
. - jobReference (GoogleApi.BigQuery.V2.Model.JobReference.t): Reference to the Job that was created to run the query. This field will be present even if the original request timed out, in which case GetQueryResults can be used to read the results once the query has completed. Since this API only returns the first page of results, subsequent pages can be fetched via the same mechanism (GetQueryResults). Defaults to
nil
. - kind (String.t): The resource type. Defaults to
bigquery#queryResponse
. - numDmlAffectedRows (String.t): [Output-only] The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE. Defaults to
nil
. - pageToken (String.t): A token used for paging results. Defaults to
nil
. - rows (list(GoogleApi.BigQuery.V2.Model.TableRow.t)): 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. Defaults to
nil
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): The schema of the results. Present only when the query completes successfully. Defaults to
nil
. - totalBytesProcessed (String.t): 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. Defaults to
nil
. - totalRows (String.t): 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. Defaults to
nil
.
Attributes
- activeUnits (String.t): 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. Defaults to
nil
. - completedUnits (String.t): Total parallel units of work completed by this query. Defaults to
nil
. - elapsedMs (String.t): Milliseconds elapsed since the start of query execution. Defaults to
nil
. - pendingUnits (String.t): Total parallel units of work remaining for the active stages. Defaults to
nil
. - totalSlotMs (String.t): Cumulative slot-ms consumed by the query. Defaults to
nil
.
Attributes
- field (String.t): [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. Defaults to
nil
. - range (GoogleApi.BigQuery.V2.Model.RangePartitioningRange.t): [TrustedTester] [Required] Defines the ranges for range partitioning. Defaults to
nil
.
[TrustedTester] [Required] Defines the ranges for range partitioning.
Evaluation metrics for regression models.
A user-defined function or a stored procedure.
Attributes
- datasetId (String.t): [Required] The ID of the dataset containing this routine. Defaults to
nil
. - projectId (String.t): [Required] The ID of the project containing this routine. Defaults to
nil
. - routineId (String.t): [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. Defaults to
nil
.
A single row in the confusion matrix.
The type of a variable, e.g., a function argument.
Examples:
INT64: {type_kind="INT64"}
ARRAY
A field or a column.
Attributes
- estimatedBytes (String.t): [Output-only] A lower-bound estimate of the number of bytes currently in the streaming buffer. Defaults to
nil
. - estimatedRows (String.t): [Output-only] A lower-bound estimate of the number of rows currently in the streaming buffer. Defaults to
nil
. - oldestEntryTime (String.t): [Output-only] Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available. Defaults to
nil
.
Attributes
- clustering (GoogleApi.BigQuery.V2.Model.Clustering.t): [Beta] Clustering specification for the table. Must be specified with partitioning, data in the table will be first partitioned and subsequently clustered. Defaults to
nil
. - creationTime (String.t): [Output-only] The time when this table was created, in milliseconds since the epoch. Defaults to
nil
. - description (String.t): [Optional] A user-friendly description of this table. Defaults to
nil
. - encryptionConfiguration (GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t): Custom encryption configuration (e.g., Cloud KMS keys). Defaults to
nil
. - etag (String.t): [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. Defaults to
nil
. - expirationTime (String.t): [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. Defaults to
nil
. - externalDataConfiguration (GoogleApi.BigQuery.V2.Model.ExternalDataConfiguration.t): [Optional] Describes the data format, location, and other properties of a table stored outside of BigQuery. By defining these properties, the data source can then be queried as if it were a standard BigQuery table. Defaults to
nil
. - friendlyName (String.t): [Optional] A descriptive name for this table. Defaults to
nil
. - id (String.t): [Output-only] An opaque ID uniquely identifying the table. Defaults to
nil
. - kind (String.t): [Output-only] The type of the resource. Defaults to
bigquery#table
. - labels (map()): 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. Defaults to
nil
. - lastModifiedTime (String.t): [Output-only] The time when this table was last modified, in milliseconds since the epoch. Defaults to
nil
. - location (String.t): [Output-only] The geographic location where the table resides. This value is inherited from the dataset. Defaults to
nil
. - materializedView (GoogleApi.BigQuery.V2.Model.MaterializedViewDefinition.t): [Optional] Materialized view definition. Defaults to
nil
. - model (GoogleApi.BigQuery.V2.Model.ModelDefinition.t): [Output-only, Beta] Present iff this table represents a ML model. Describes the training information for the model, and it is required to run 'PREDICT' queries. Defaults to
nil
. - numBytes (String.t): [Output-only] The size of this table in bytes, excluding any data in the streaming buffer. Defaults to
nil
. - numLongTermBytes (String.t): [Output-only] The number of bytes in the table that are considered "long-term storage". Defaults to
nil
. - numPhysicalBytes (String.t): [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. Defaults to
nil
. - numRows (String.t): [Output-only] The number of rows of data in this table, excluding any data in the streaming buffer. Defaults to
nil
. - rangePartitioning (GoogleApi.BigQuery.V2.Model.RangePartitioning.t): [TrustedTester] Range partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - requirePartitionFilter (boolean()): [Beta] [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Defaults to
false
. - schema (GoogleApi.BigQuery.V2.Model.TableSchema.t): [Optional] Describes the schema of this table. Defaults to
nil
. - selfLink (String.t): [Output-only] A URL that can be used to access this resource again. Defaults to
nil
. - streamingBuffer (GoogleApi.BigQuery.V2.Model.Streamingbuffer.t): [Output-only] Contains information regarding this table's streaming buffer, if one is present. This field will be absent if the table is not being streamed to or if there is no data in the streaming buffer. Defaults to
nil
. - tableReference (GoogleApi.BigQuery.V2.Model.TableReference.t): [Required] Reference describing the ID of this table. Defaults to
nil
. - timePartitioning (GoogleApi.BigQuery.V2.Model.TimePartitioning.t): Time-based partitioning specification for this table. Only one of timePartitioning and rangePartitioning should be specified. Defaults to
nil
. - type (String.t): [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. [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. Defaults to
nil
. - view (GoogleApi.BigQuery.V2.Model.ViewDefinition.t): [Optional] The view definition. Defaults to
nil
.
Attributes
- 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. Defaults to
nil
. - kind (String.t): The resource type of the response. Defaults to
bigquery#tableDataInsertAllRequest
. - rows (list(GoogleApi.BigQuery.V2.Model.TableDataInsertAllRequestRows.t)): The rows to insert. Defaults to
nil
. - 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. Defaults to
nil
. - templateSuffix (String.t): 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. Defaults to
nil
.
Attributes
- insertId (String.t): [Optional] A unique ID for each row. BigQuery uses this property to detect duplicate insertion requests on a best-effort basis. Defaults to
nil
. - json (GoogleApi.BigQuery.V2.Model.JsonObject.t): [Required] A JSON object that contains a row of data. The object's properties and values must match the destination table's schema. Defaults to
nil
.
Attributes
- etag (String.t): A hash of this page of results. Defaults to
nil
. - kind (String.t): The resource type of the response. Defaults to
bigquery#tableDataList
. - pageToken (String.t): 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. Defaults to
nil
. - rows (list(GoogleApi.BigQuery.V2.Model.TableRow.t)): Rows of results. Defaults to
nil
. - totalRows (String.t): The total number of rows in the complete table. Defaults to
nil
.
Attributes
- categories (GoogleApi.BigQuery.V2.Model.TableFieldSchemaCategories.t): [Optional] The categories attached to this field, used for field-level access control. Defaults to
nil
. - description (String.t): [Optional] The field description. The maximum length is 1,024 characters. Defaults to
nil
. - fields (list(GoogleApi.BigQuery.V2.Model.TableFieldSchema.t)): [Optional] Describes the nested schema fields if the type property is set to RECORD. Defaults to
nil
. - mode (String.t): [Optional] The field mode. Possible values include NULLABLE, REQUIRED and REPEATED. The default value is NULLABLE. Defaults to
nil
. - name (String.t): [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 128 characters. Defaults to
nil
. - type (String.t): [Required] The field data type. Possible values include STRING, BYTES, INTEGER, INT64 (same as INTEGER), FLOAT, FLOAT64 (same as FLOAT), BOOLEAN, BOOL (same as BOOLEAN), TIMESTAMP, DATE, TIME, DATETIME, RECORD (where RECORD indicates that the field contains a nested schema) or STRUCT (same as RECORD). Defaults to
nil
.
[Optional] The categories attached to this field, used for field-level access control.
Attributes
- etag (String.t): A hash of this page of results. Defaults to
nil
. - kind (String.t): The type of list. Defaults to
bigquery#tableList
. - nextPageToken (String.t): A token to request the next page of results. Defaults to
nil
. - tables (list(GoogleApi.BigQuery.V2.Model.TableListTables.t)): Tables in the requested dataset. Defaults to
nil
. - totalItems (integer()): The total number of tables in the dataset. Defaults to
nil
.
Attributes
- clustering (GoogleApi.BigQuery.V2.Model.Clustering.t): [Beta] Clustering specification for this table, if configured. Defaults to
nil
. - creationTime (String.t): The time when this table was created, in milliseconds since the epoch. Defaults to
nil
. - expirationTime (String.t): [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. Defaults to
nil
. - friendlyName (String.t): The user-friendly name for this table. Defaults to
nil
. - id (String.t): An opaque ID of the table Defaults to
nil
. - kind (String.t): The resource type. Defaults to
bigquery#table
. - labels (map()): The labels associated with this table. You can use these to organize and group your tables. Defaults to
nil
. - tableReference (GoogleApi.BigQuery.V2.Model.TableReference.t): A reference uniquely identifying the table. Defaults to
nil
. - timePartitioning (GoogleApi.BigQuery.V2.Model.TimePartitioning.t): The time-based partitioning specification for this table, if configured. Defaults to
nil
. - type (String.t): The type of table. Possible values are: TABLE, VIEW. Defaults to
nil
. - view (GoogleApi.BigQuery.V2.Model.TableListTablesView.t): Additional details for a view. Defaults to
nil
.
Additional details for a view.
Attributes
- datasetId (String.t): [Required] The ID of the dataset containing this table. Defaults to
nil
. - projectId (String.t): [Required] The ID of the project containing this table. Defaults to
nil
. - tableId (String.t): [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. Defaults to
nil
.
Attributes
- expirationMs (String.t): [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. Defaults to
nil
. - field (String.t): [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. Defaults to
nil
. - requirePartitionFilter (boolean()): Defaults to
nil
. - type (String.t): [Required] The only type supported is DAY, which will generate one partition per day. Defaults to
nil
.
Attributes
- dataSplitColumn (String.t): The column to split data with. This column won't be used as a feature.
- 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.
- 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 Defaults to
nil
.
- 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. Defaults to
nil
. - dataSplitMethod (String.t): The data split type for training and evaluation, e.g. RANDOM. Defaults to
nil
. - distanceType (String.t): [Beta] Distance type for clustering models. Defaults to
nil
. - 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. Defaults to
nil
. - initialLearnRate (float()): Specifies the initial learning rate for the line search learn rate
strategy. Defaults to
nil
. - inputLabelColumns (list(String.t)): Name of input label columns in training data. Defaults to
nil
. - l1Regularization (float()): L1 regularization coefficient. Defaults to
nil
. - l2Regularization (float()): L2 regularization coefficient. Defaults to
nil
. - labelClassWeights (map()): Weights associated with each label class, for rebalancing the
training data. Only applicable for classification models. Defaults to
nil
. - learnRate (float()): Learning rate in training. Used only for iterative training algorithms. Defaults to
nil
. - learnRateStrategy (String.t): The strategy to determine learn rate for the current iteration. Defaults to
nil
. - lossType (String.t): Type of loss function used during training run. Defaults to
nil
. - maxIterations (String.t): The maximum number of iterations in training. Used only for iterative
training algorithms. Defaults to
nil
. - minRelativeProgress (float()): When early_stop is true, stops training when accuracy improvement is
less than 'min_relative_progress'. Used only for iterative training
algorithms. Defaults to
nil
. - modelUri (String.t): [Beta] Google Cloud Storage URI from which the model was imported. Only
applicable for imported models. Defaults to
nil
. - numClusters (String.t): [Beta] Number of clusters for clustering models. Defaults to
nil
. - optimizationStrategy (String.t): Optimization strategy for training linear regression models. Defaults to
nil
. - warmStart (boolean()): Whether to train a model from the last checkpoint. Defaults to
nil
.
Information about a single training query run for the model.
Attributes
- inlineCode (String.t): [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. Defaults to
nil
. - resourceUri (String.t): [Pick one] A code resource to load from a Google Cloud Storage URI (gs://bucket/path). Defaults to
nil
.
Attributes
- query (String.t): [Required] A query that BigQuery executes when the view is referenced. Defaults to
nil
. - 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. Defaults to
nil
. - userDefinedFunctionResources (list(GoogleApi.BigQuery.V2.Model.UserDefinedFunctionResource.t)): Describes user-defined function resources used in the query. Defaults to
nil
.