View Source API Reference google_api_big_query v0.79.0

Modules

API client metadata for GoogleApi.BigQuery.V2.

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

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.

Represents privacy policy associated with "aggregation threshold" method.

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

Model evaluation metrics for ARIMA forecasting models.

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

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

Model evaluation metrics for a single ARIMA forecasting model.

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.

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.

Options for external data sources.

Reason why BI Engine didn't accelerate the query (or sub-query).

Statistics for a BI Engine specific query. Populated as part of JobStatistics2

Configuration for BigLake managed tables.

Attributes

  • currentIteration (type: integer(), default: nil) - Deprecated.
  • expectedTotalIterations (type: String.t, default: nil) - Deprecated.

Information related to a Bigtable column.

Information related to a Bigtable column family.

Options specific to Google Cloud Bigtable data sources.

Evaluation metrics for binary classification/classifier models.

Confusion matrix for binary classification models.

Associates members, or principals, with a role.

Attributes

  • durationMs (type: String.t, default: nil) - Deprecated.
  • evalLoss (type: float(), default: nil) - Deprecated.
  • index (type: integer(), default: nil) - Deprecated.
  • learnRate (type: float(), default: nil) - Deprecated.
  • trainingLoss (type: float(), default: nil) - Deprecated.

Attributes

  • iterationResults (type: list(GoogleApi.BigQuery.V2.Model.BqmlIterationResult.t), default: nil) - Deprecated.
  • startTime (type: DateTime.t, default: nil) - Deprecated.
  • state (type: String.t, default: nil) - Deprecated.
  • trainingOptions (type: GoogleApi.BigQuery.V2.Model.BqmlTrainingRunTrainingOptions.t, default: nil) - Deprecated.

Representative value of a categorical feature.

Represents the count of a single category within the cluster.

Information about base table and clone time of a table clone.

Message containing the information about one cluster.

Information about a single cluster for clustering model.

Configures table clustering.

Evaluation metrics for clustering models.

Confusion matrix for multi-class classification models.

A connection-level property to customize query behavior. Under JDBC, these correspond directly to connection properties passed to the DriverManager. Under ODBC, these correspond to properties in the connection string. Currently supported connection properties: dataset_project_id: represents the default project for datasets that are used in the query. Setting the system variable @@dataset_project_id achieves the same behavior. For more information about system variables, see: https://cloud.google.com/bigquery/docs/reference/system-variables time_zone: represents the default timezone used to run the query. session_id: associates the query with a given session. query_label: associates the query with a given job label. If set, all subsequent queries in a script or session will have this label. For the format in which a you can specify a query label, see labels in the JobConfiguration resource type: https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#jobconfiguration Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.

Information related to a CSV data source.

Options for data format adjustments.

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

Attributes

  • access (type: list(GoogleApi.BigQuery.V2.Model.DatasetAccess.t), default: nil) - 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 (type: String.t, default: nil) - Output only. The time when this dataset was created, in milliseconds since the epoch.
  • datasetReference (type: GoogleApi.BigQuery.V2.Model.DatasetReference.t, default: nil) - Required. A reference that identifies the dataset.
  • defaultCollation (type: String.t, default: nil) - Optional. Defines the default collation specification of future tables created in the dataset. If a table is created in this dataset without table-level default collation, then the table inherits the dataset default collation, which is applied to the string fields that do not have explicit collation specified. A change to this field affects only tables created afterwards, and does not alter the existing tables. The following values are supported: 'und:ci': undetermined locale, case insensitive. '': empty string. Default to case-sensitive behavior.
  • defaultEncryptionConfiguration (type: GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t, default: nil) - The default encryption key for all tables in the dataset. Once this property is set, all newly-created partitioned tables in the dataset will have encryption key set to this value, unless table creation request (or query) overrides the key.
  • defaultPartitionExpirationMs (type: String.t, default: nil) - This default partition expiration, expressed in milliseconds. When new time-partitioned tables are created in a dataset where this property is set, the table will inherit this value, propagated as the TimePartitioning.expirationMs property on the new table. If you set TimePartitioning.expirationMs explicitly when creating a table, the defaultPartitionExpirationMs of the containing dataset is ignored. When creating a partitioned table, if defaultPartitionExpirationMs is set, the defaultTableExpirationMs value is ignored and the table will not be inherit a table expiration deadline.
  • defaultRoundingMode (type: String.t, default: nil) - Optional. Defines the default rounding mode specification of new tables created within this dataset. During table creation, if this field is specified, the table within this dataset will inherit the default rounding mode of the dataset. Setting the default rounding mode on a table overrides this option. Existing tables in the dataset are unaffected. If columns are defined during that table creation, they will immediately inherit the table's default rounding mode, unless otherwise specified.
  • defaultTableExpirationMs (type: String.t, default: nil) - Optional. The default lifetime of all tables in the dataset, in milliseconds. The minimum lifetime value is 3600000 milliseconds (one hour). To clear an existing default expiration with a PATCH request, set to 0. 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 (type: String.t, default: nil) - Optional. A user-friendly description of the dataset.
  • etag (type: String.t, default: nil) - Output only. A hash of the resource.
  • externalCatalogDatasetOptions (type: GoogleApi.BigQuery.V2.Model.ExternalCatalogDatasetOptions.t, default: nil) - Optional. Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset.
  • externalDatasetReference (type: GoogleApi.BigQuery.V2.Model.ExternalDatasetReference.t, default: nil) - Optional. Reference to a read-only external dataset defined in data catalogs outside of BigQuery. Filled out when the dataset type is EXTERNAL.
  • friendlyName (type: String.t, default: nil) - Optional. A descriptive name for the dataset.
  • id (type: String.t, default: nil) - 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 (type: boolean(), default: nil) - Optional. TRUE if the dataset and its table names are case-insensitive, otherwise FALSE. By default, this is FALSE, which means the dataset and its table names are case-sensitive. This field does not affect routine references.
  • kind (type: String.t, default: bigquery#dataset) - Output only. The resource type.
  • labels (type: map(), default: nil) - 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 (type: String.t, default: nil) - Output only. The date when this dataset was last modified, in milliseconds since the epoch.
  • linkedDatasetMetadata (type: GoogleApi.BigQuery.V2.Model.LinkedDatasetMetadata.t, default: nil) - Output only. Metadata about the LinkedDataset. Filled out when the dataset type is LINKED.
  • linkedDatasetSource (type: GoogleApi.BigQuery.V2.Model.LinkedDatasetSource.t, default: nil) - Optional. The source dataset reference when the dataset is of type LINKED. For all other dataset types it is not set. This field cannot be updated once it is set. Any attempt to update this field using Update and Patch API Operations will be ignored.
  • location (type: String.t, default: nil) - The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.
  • maxTimeTravelHours (type: String.t, default: nil) - Optional. Defines the time travel window in hours. The value can be from 48 to 168 hours (2 to 7 days). The default value is 168 hours if this is not set.
  • satisfiesPzi (type: boolean(), default: nil) - Output only. Reserved for future use.
  • satisfiesPzs (type: boolean(), default: nil) - Output only. Reserved for future use.
  • selfLink (type: String.t, default: nil) - 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.
  • storageBillingModel (type: String.t, default: nil) - Optional. Updates storage_billing_model for the dataset.
  • tags (type: list(GoogleApi.BigQuery.V2.Model.DatasetTags.t), default: nil) - Output only. Tags for the Dataset.
  • type (type: String.t, default: nil) - Output only. Same as type in ListFormatDataset. The type of the dataset, one of: DEFAULT - only accessible by owner and authorized accounts, PUBLIC - accessible by everyone, LINKED - linked dataset, EXTERNAL - dataset with definition in external metadata catalog. -- *BIGLAKE_METASTORE - dataset that references a database created in BigLakeMetastore service. --

An object that defines dataset access for an entity.

Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset.

Response format for a page of results when listing datasets.

A dataset resource with only a subset of fields, to be returned in a list of datasets.

Attributes

  • datasetId (type: String.t, default: nil) - 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 (type: String.t, default: nil) - Optional. The ID of the project containing this dataset.

Properties for the destination table.

Represents privacy policy associated with "differential privacy" method.

Model evaluation metrics for dimensionality reduction models.

Detailed statistics for DML statements

Discrete candidates of a double hyperparameter.

Search space for a double hyperparameter.

Range of a double hyperparameter.

Attributes

  • kmsKeyName (type: String.t, default: nil) - 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.

A single entry in the confusion matrix.

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.

A single stage of query execution.

An operation within a stage.

Explanation for a single feature.

Statistics for the EXPORT DATA statement as part of Query Job. EXTRACT JOB statistics are populated in JobStatistics4.

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.

Options defining open source compatible datasets living in the BigQuery catalog. Contains metadata of open source database, schema or namespace represented by the current dataset.

Metadata about open source compatible table. The fields contained in these options correspond to hive metastore's table level properties.

Attributes

  • autodetect (type: boolean(), default: nil) - Try to detect schema and format options automatically. Any option specified explicitly will be honored.
  • avroOptions (type: GoogleApi.BigQuery.V2.Model.AvroOptions.t, default: nil) - Optional. Additional properties to set if sourceFormat is set to AVRO.
  • bigtableOptions (type: GoogleApi.BigQuery.V2.Model.BigtableOptions.t, default: nil) - Optional. Additional options if sourceFormat is set to BIGTABLE.
  • compression (type: String.t, default: nil) - 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, Avro, ORC and Parquet formats. An empty string is an invalid value.
  • connectionId (type: String.t, default: nil) - Optional. The connection specifying the credentials to be used to read external storage, such as Azure Blob, Cloud Storage, or S3. The connection_id can have the form "<project_id>.<location_id>.<connection_id>" or "projects/<project_id>/locations/<location_id>/connections/<connection_id>".
  • csvOptions (type: GoogleApi.BigQuery.V2.Model.CsvOptions.t, default: nil) - Optional. Additional properties to set if sourceFormat is set to CSV.
  • decimalTargetTypes (type: list(String.t), default: nil) - 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.
  • fileSetSpecType (type: String.t, default: nil) - Optional. Specifies how source URIs are interpreted for constructing the file set to load. By default source URIs are expanded against the underlying storage. Other options include specifying manifest files. Only applicable to object storage systems.
  • googleSheetsOptions (type: GoogleApi.BigQuery.V2.Model.GoogleSheetsOptions.t, default: nil) - Optional. Additional options if sourceFormat is set to GOOGLE_SHEETS.
  • hivePartitioningOptions (type: GoogleApi.BigQuery.V2.Model.HivePartitioningOptions.t, default: nil) - Optional. When set, configures hive partitioning support. Not all storage formats support hive partitioning -- requesting hive partitioning on an unsupported format will lead to an error, as will providing an invalid specification.
  • ignoreUnknownValues (type: boolean(), default: nil) - 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. ORC: This setting is ignored. Parquet: This setting is ignored.
  • jsonExtension (type: String.t, default: nil) - Optional. Load option to be used together with source_format newline-delimited JSON to indicate that a variant of JSON is being loaded. To load newline-delimited GeoJSON, specify GEOJSON (and source_format must be set to NEWLINE_DELIMITED_JSON).
  • jsonOptions (type: GoogleApi.BigQuery.V2.Model.JsonOptions.t, default: nil) - Optional. Additional properties to set if sourceFormat is set to JSON.
  • maxBadRecords (type: integer(), default: nil) - 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. The default value is 0, which requires that all records are valid. This setting is ignored for Google Cloud Bigtable, Google Cloud Datastore backups, Avro, ORC and Parquet formats.
  • metadataCacheMode (type: String.t, default: nil) - Optional. Metadata Cache Mode for the table. Set this to enable caching of metadata from external data source.
  • objectMetadata (type: String.t, default: nil) - Optional. ObjectMetadata is used to create Object Tables. Object Tables contain a listing of objects (with their metadata) found at the source_uris. If ObjectMetadata is set, source_format should be omitted. Currently SIMPLE is the only supported Object Metadata type.
  • parquetOptions (type: GoogleApi.BigQuery.V2.Model.ParquetOptions.t, default: nil) - Optional. Additional properties to set if sourceFormat is set to PARQUET.
  • referenceFileSchemaUri (type: String.t, default: nil) - Optional. When creating an external table, the user can provide a reference file with the table schema. This is enabled for the following formats: AVRO, PARQUET, ORC.
  • schema (type: GoogleApi.BigQuery.V2.Model.TableSchema.t, default: nil) - Optional. The schema for the data. Schema is required for CSV and JSON formats if autodetect is not on. Schema is disallowed for Google Cloud Bigtable, Cloud Datastore backups, Avro, ORC and Parquet formats.
  • sourceFormat (type: String.t, default: nil) - [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". For Apache Iceberg tables, specify "ICEBERG". For ORC files, specify "ORC". For Parquet files, specify "PARQUET". [Beta] For Google Cloud Bigtable, specify "BIGTABLE".
  • sourceUris (type: list(String.t), default: nil) - [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.

Configures the access a dataset defined in an external metadata storage.

The external service cost is a portion of the total cost, these costs are not additive with total_bytes_billed. Moreover, this field only track external service costs that will show up as BigQuery costs (e.g. training BigQuery ML job with google cloud CAIP or Automl Tables services), not other costs which may be accrued by running the query (e.g. reading from Bigtable or Cloud Storage). The external service costs with different billing sku (e.g. CAIP job is charged based on VM usage) are converted to BigQuery billed_bytes and slot_ms with equivalent amount of US dollars. Services may not directly correlate to these metrics, but these are the equivalents for billing purposes. Output only.

Representative value of a single feature within the cluster.

Request message for GetIamPolicy method.

Encapsulates settings provided to GetIamPolicy.

Response object of GetQueryResults.

Response object of GetServiceAccount

Global explanations containing the top most important features after training.

Options specific to Google Sheets data sources.

High cardinality join detailed information.

Options for configuring hive partitioning detect.

Hyperparameter search spaces. These should be a subset of training_options.

Reason about why no search index was used in the search query (or sub-query).

Details about the input data change insight.

Discrete candidates of an int hyperparameter.

Search space for an int hyperparameter.

Range of an int hyperparameter.

Information about a single iteration of the training run.

Attributes

  • configuration (type: GoogleApi.BigQuery.V2.Model.JobConfiguration.t, default: nil) - Required. Describes the job configuration.
  • etag (type: String.t, default: nil) - Output only. A hash of this resource.
  • id (type: String.t, default: nil) - Output only. Opaque ID field of the job.
  • jobCreationReason (type: GoogleApi.BigQuery.V2.Model.JobCreationReason.t, default: nil) - Output only. If set, it provides the reason why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
  • jobReference (type: GoogleApi.BigQuery.V2.Model.JobReference.t, default: nil) - Optional. Reference describing the unique-per-user name of the job.
  • kind (type: String.t, default: bigquery#job) - Output only. The type of the resource.
  • principal_subject (type: String.t, default: nil) - Output only. [Full-projection-only] String representation of identity of requesting party. Populated for both first- and third-party identities. Only present for APIs that support third-party identities.
  • selfLink (type: String.t, default: nil) - Output only. A URL that can be used to access the resource again.
  • statistics (type: GoogleApi.BigQuery.V2.Model.JobStatistics.t, default: nil) - Output only. Information about the job, including starting time and ending time of the job.
  • status (type: GoogleApi.BigQuery.V2.Model.JobStatus.t, default: nil) - Output only. The status of this job. Examine this value when polling an asynchronous job to see if the job is complete.
  • user_email (type: String.t, default: nil) - Output only. Email address of the user who ran the job.

Describes format of a jobs cancellation response.

Attributes

  • copy (type: GoogleApi.BigQuery.V2.Model.JobConfigurationTableCopy.t, default: nil) - [Pick one] Copies a table.
  • dryRun (type: boolean(), default: nil) - 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 (type: GoogleApi.BigQuery.V2.Model.JobConfigurationExtract.t, default: nil) - [Pick one] Configures an extract job.
  • jobTimeoutMs (type: String.t, default: nil) - Optional. Job timeout in milliseconds. If this time limit is exceeded, BigQuery might attempt to stop the job.
  • jobType (type: String.t, default: nil) - Output only. The type of the job. Can be QUERY, LOAD, EXTRACT, COPY or UNKNOWN.
  • labels (type: map(), default: nil) - 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 (type: GoogleApi.BigQuery.V2.Model.JobConfigurationLoad.t, default: nil) - [Pick one] Configures a load job.
  • query (type: GoogleApi.BigQuery.V2.Model.JobConfigurationQuery.t, default: nil) - [Pick one] Configures a query job.

JobConfigurationExtract configures a job that exports data from a BigQuery table into Google Cloud Storage.

JobConfigurationLoad contains the configuration properties for loading data into a destination table.

JobConfigurationQuery configures a BigQuery query job.

JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see Copy a table.

Reason about why a Job was created from a jobs.query method when used with JOB_CREATION_OPTIONAL Job creation mode. For jobs.insert method calls it will always be REQUESTED. This feature is not yet available. Jobs will always be created.

JobList is the response format for a jobs.list call.

ListFormatJob is a partial projection of job information returned as part of a jobs.list response.

A job reference is a fully qualified identifier for referring to a job.

Statistics for a single job execution.

Statistics for a query job.

Job resource usage breakdown by reservation.

Statistics for a load job.

Statistics for an extract job.

Statistics for a copy job.

Job resource usage breakdown by reservation.

Attributes

  • errorResult (type: GoogleApi.BigQuery.V2.Model.ErrorProto.t, default: nil) - Output only. Final error result of the job. If present, indicates that the job has completed and was unsuccessful.
  • errors (type: list(GoogleApi.BigQuery.V2.Model.ErrorProto.t), default: nil) - 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 not completed or was unsuccessful.
  • state (type: String.t, default: nil) - Output only. Running state of the job. Valid states include 'PENDING', 'RUNNING', and 'DONE'.

Represents privacy policy associated with "join restrictions". Join restriction gives data providers the ability to enforce joins on the 'join_allowed_columns' when data is queried from a privacy protected view.

Represents a single JSON object.

Json Options for load and make external tables.

Metadata about the Linked Dataset.

A dataset source type which refers to another BigQuery dataset.

Response format for a single page when listing BigQuery ML models.

Describes the format of a single result page when listing routines.

Response message for the ListRowAccessPolicies method.

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

A materialized view considered for a query job.

Definition and configuration of a materialized view.

Statistics of materialized views considered in a query job.

Status of a materialized view. The last refresh timestamp status is omitted here, but is present in the MaterializedViewDefinition message.

Statistics for metadata caching in BigLake tables.

Job statistics specific to a BigQuery ML training job.

Attributes

  • bestTrialId (type: String.t, default: nil) - The best trial_id across all training runs.
  • creationTime (type: String.t, default: nil) - Output only. The time when this model was created, in millisecs since the epoch.
  • defaultTrialId (type: String.t, default: nil) - Output only. The default trial_id to use in TVFs when the trial_id is not passed in. For single-objective hyperparameter tuning models, this is the best trial ID. For multi-objective hyperparameter tuning models, this is the smallest trial ID among all Pareto optimal trials.
  • description (type: String.t, default: nil) - Optional. A user-friendly description of this model.
  • encryptionConfiguration (type: GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t, default: nil) - Custom encryption configuration (e.g., Cloud KMS keys). This shows the encryption configuration of the model data while stored in BigQuery storage. This field can be used with PatchModel to update encryption key for an already encrypted model.
  • etag (type: String.t, default: nil) - Output only. A hash of this resource.
  • expirationTime (type: String.t, default: nil) - 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 (type: list(GoogleApi.BigQuery.V2.Model.StandardSqlField.t), default: nil) - Output only. Input feature columns for the model inference. If the model is trained with TRANSFORM clause, these are the input of the TRANSFORM clause.
  • friendlyName (type: String.t, default: nil) - Optional. A descriptive name for this model.
  • hparamSearchSpaces (type: GoogleApi.BigQuery.V2.Model.HparamSearchSpaces.t, default: nil) - Output only. All hyperparameter search spaces in this model.
  • hparamTrials (type: list(GoogleApi.BigQuery.V2.Model.HparamTuningTrial.t), default: nil) - Output only. Trials of a hyperparameter tuning model sorted by trial_id.
  • labelColumns (type: list(GoogleApi.BigQuery.V2.Model.StandardSqlField.t), default: nil) - 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 (type: map(), default: nil) - 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 (type: String.t, default: nil) - Output only. The time when this model was last modified, in millisecs since the epoch.
  • location (type: String.t, default: nil) - Output only. The geographic location where the model resides. This value is inherited from the dataset.
  • modelReference (type: GoogleApi.BigQuery.V2.Model.ModelReference.t, default: nil) - Required. Unique identifier for this model.
  • modelType (type: String.t, default: nil) - Output only. Type of the model resource.
  • optimalTrialIds (type: list(String.t), default: nil) - Output only. For single-objective hyperparameter tuning models, it only contains the best trial. For multi-objective hyperparameter tuning models, it contains all Pareto optimal trials sorted by trial_id.
  • remoteModelInfo (type: GoogleApi.BigQuery.V2.Model.RemoteModelInfo.t, default: nil) - Output only. Remote model info
  • trainingRuns (type: list(GoogleApi.BigQuery.V2.Model.TrainingRun.t), default: nil) - Information for all training runs in increasing order of start_time.
  • transformColumns (type: list(GoogleApi.BigQuery.V2.Model.TransformColumn.t), default: nil) - Output only. This field will be populated if a TRANSFORM clause was used to train a model. TRANSFORM clause (if used) takes feature_columns as input and outputs transform_columns. transform_columns then are used to train the model.

Attributes

  • modelOptions (type: GoogleApi.BigQuery.V2.Model.ModelDefinitionModelOptions.t, default: nil) - Deprecated.
  • trainingRuns (type: list(GoogleApi.BigQuery.V2.Model.BqmlTrainingRun.t), default: nil) - Deprecated.

Options related to model extraction.

Evaluation metrics for multi-class classification/classifier models.

Parquet Options for load and make external tables.

Partition skew detailed information.

The partitioning column information.

The partitioning information, which includes managed table and external table partition information.

Performance insights for the job.

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, or principals, to a single role. Principals 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.

Principal component infos, used only for eigen decomposition based models, e.g., PCA. Ordered by explained_variance in the descending order.

Represents privacy policy that contains the privacy requirements specified by the data owner. Currently, this is only supported on views.

Response object of ListProjects

Information about a single project.

A unique reference to a project.

Query optimization information for a QUERY job.

A parameter given to a query.

The type of a query parameter.

The value of a query parameter.

Describes the format of the jobs.query request.

Attributes

  • cacheHit (type: boolean(), default: nil) - Whether the query result was fetched from the query cache.
  • dmlStats (type: GoogleApi.BigQuery.V2.Model.DmlStatistics.t, default: nil) - Output only. Detailed statistics for DML statements INSERT, UPDATE, DELETE, MERGE or TRUNCATE.
  • errors (type: list(GoogleApi.BigQuery.V2.Model.ErrorProto.t), default: nil) - 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. For more information about error messages, see Error messages.
  • jobComplete (type: boolean(), default: nil) - 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.
  • jobCreationReason (type: GoogleApi.BigQuery.V2.Model.JobCreationReason.t, default: nil) - Optional. Only relevant when a job_reference is present in the response. If job_reference is not present it will always be unset. When job_reference is present, this field should be interpreted as follows: If set, it will provide the reason of why a Job was created. If not set, it should be treated as the default: REQUESTED. This feature is not yet available. Jobs will always be created.
  • jobReference (type: GoogleApi.BigQuery.V2.Model.JobReference.t, default: nil) - 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).
  • kind (type: String.t, default: bigquery#queryResponse) - The resource type.
  • numDmlAffectedRows (type: String.t, default: nil) - Output only. The number of rows affected by a DML statement. Present only for DML statements INSERT, UPDATE or DELETE.
  • pageToken (type: String.t, default: nil) - A token used for paging results. A non-empty token indicates that additional results are available. To see additional results, query the jobs.getQueryResults method. For more information, see Paging through table data.
  • queryId (type: String.t, default: nil) - Query ID for the completed query. This ID will be auto-generated. This field is not yet available and it is currently not guaranteed to be populated.
  • rows (type: list(GoogleApi.BigQuery.V2.Model.TableRow.t), default: nil) - 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 (type: GoogleApi.BigQuery.V2.Model.TableSchema.t, default: nil) - The schema of the results. Present only when the query completes successfully.
  • sessionInfo (type: GoogleApi.BigQuery.V2.Model.SessionInfo.t, default: nil) - Output only. Information of the session if this job is part of one.
  • totalBytesProcessed (type: String.t, default: nil) - 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 (type: String.t, default: nil) - 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.

Summary of the state of query execution at a given time.

Attributes

  • field (type: String.t, default: nil) - Required. [Experimental] 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 (type: GoogleApi.BigQuery.V2.Model.RangePartitioningRange.t, default: nil) - [Experimental] Defines the ranges for range partitioning.

[Experimental] Defines the ranges for range partitioning.

Represents the value of a range.

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

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

Options for a remote user-defined function.

A user-defined function or a stored procedure.

A single row in the confusion matrix.

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.

Statistics for row-level security.

Options related to script execution.

Represents the location of the statement/expression being evaluated. Line and column numbers are defined as follows: - Line and column numbers start with one. That is, line 1 column 1 denotes the start of the script. - When inside a stored procedure, all line/column numbers are relative to the procedure body, not the script in which the procedure was defined. - Start/end positions exclude leading/trailing comments and whitespace. The end position always ends with a ";", when present. - Multi-byte Unicode characters are treated as just one column. - If the original script (or procedure definition) contains TAB characters, a tab "snaps" the indentation forward to the nearest multiple of 8 characters, plus 1. For example, a TAB on column 1, 2, 3, 4, 5, 6 , or 8 will advance the next character to column 9. A TAB on column 9, 10, 11, 12, 13, 14, 15, or 16 will advance the next character to column 17.

Job statistics specific to the child job of a script.

Statistics for a search query. Populated as part of JobStatistics2.

Serializer and deserializer information.

[Preview] Information related to sessions.

Request message for SetIamPolicy method.

Details about source stages which produce skewed data.

Information about base table and snapshot time of the snapshot.

Spark job logs can be filtered by these fields in Cloud Logging.

Options for a user-defined Spark routine.

Statistics for a BigSpark query. Populated as part of JobStatistics2

Performance insights compared to the previous executions for a specific stage.

Standalone performance insights for a specific stage.

The data type of a variable such as a function argument. Examples include: INT64: {"typeKind": "INT64"} ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } }

The representation of a SQL STRUCT type.

Contains information about how a table's data is stored and accessed by open source query engines.

Attributes

  • estimatedBytes (type: String.t, default: nil) - Output only. A lower-bound estimate of the number of bytes currently in the streaming buffer.
  • estimatedRows (type: String.t, default: nil) - Output only. A lower-bound estimate of the number of rows currently in the streaming buffer.
  • oldestEntryTime (type: String.t, default: nil) - Output only. Contains the timestamp of the oldest entry in the streaming buffer, in milliseconds since the epoch, if the streaming buffer is available.

Search space for string and enum.

System variables given to a query.

Attributes

  • tableConstraints (type: GoogleApi.BigQuery.V2.Model.TableConstraints.t, default: nil) - Optional. Tables Primary Key and Foreign Key information
  • selfLink (type: String.t, default: nil) - Output only. A URL that can be used to access this resource again.
  • labels (type: map(), default: nil) - 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.
  • externalCatalogTableOptions (type: GoogleApi.BigQuery.V2.Model.ExternalCatalogTableOptions.t, default: nil) - Optional. Options defining open source compatible table.
  • snapshotDefinition (type: GoogleApi.BigQuery.V2.Model.SnapshotDefinition.t, default: nil) - Output only. Contains information about the snapshot. This value is set via snapshot creation.
  • cloneDefinition (type: GoogleApi.BigQuery.V2.Model.CloneDefinition.t, default: nil) - Output only. Contains information about the clone. This value is set via the clone operation.
  • lastModifiedTime (type: String.t, default: nil) - Output only. The time when this table was last modified, in milliseconds since the epoch.
  • numLongTermLogicalBytes (type: String.t, default: nil) - Output only. Number of logical bytes that are more than 90 days old.
  • view (type: GoogleApi.BigQuery.V2.Model.ViewDefinition.t, default: nil) - Optional. The view definition.
  • kind (type: String.t, default: bigquery#table) - The type of resource ID.
  • defaultRoundingMode (type: String.t, default: nil) - Optional. Defines the default rounding mode specification of new decimal fields (NUMERIC OR BIGNUMERIC) in the table. During table creation or update, if a decimal field is added to this table without an explicit rounding mode specified, then the field inherits the table default rounding mode. Changing this field doesn't affect existing fields.
  • description (type: String.t, default: nil) - Optional. A user-friendly description of this table.
  • friendlyName (type: String.t, default: nil) - Optional. A descriptive name for this table.
  • tableReference (type: GoogleApi.BigQuery.V2.Model.TableReference.t, default: nil) - Required. Reference describing the ID of this table.
  • numTimeTravelPhysicalBytes (type: String.t, default: nil) - Output only. Number of physical bytes used by time travel storage (deleted or changed data). This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
  • replicas (type: list(GoogleApi.BigQuery.V2.Model.TableReference.t), default: nil) - Optional. Output only. Table references of all replicas currently active on the table.
  • clustering (type: GoogleApi.BigQuery.V2.Model.Clustering.t, default: nil) - Clustering specification for the table. Must be specified with time-based partitioning, data in the table will be first partitioned and subsequently clustered.
  • timePartitioning (type: GoogleApi.BigQuery.V2.Model.TimePartitioning.t, default: nil) - If specified, configures time-based partitioning for this table.
  • biglakeConfiguration (type: GoogleApi.BigQuery.V2.Model.BigLakeConfiguration.t, default: nil) - Optional. Specifies the configuration of a BigLake managed table.
  • numLongTermBytes (type: String.t, default: nil) - Output only. The number of logical bytes in the table that are considered "long-term storage".
  • numTotalPhysicalBytes (type: String.t, default: nil) - Output only. The physical size of this table in bytes. This also includes storage used for time travel. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
  • numPartitions (type: String.t, default: nil) - Output only. The number of partitions present in the table or materialized view. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
  • resourceTags (type: map(), default: nil) - [Optional] The tags associated with this table. Tag keys are globally unique. See additional information on tags. An object containing a list of "key": value pairs. The key is the namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is parent id. The value is the friendly short name of the tag value, e.g. "production".
  • creationTime (type: String.t, default: nil) - Output only. The time when this table was created, in milliseconds since the epoch.
  • tableReplicationInfo (type: GoogleApi.BigQuery.V2.Model.TableReplicationInfo.t, default: nil) - Optional. Table replication info for table created AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv
  • numLongTermPhysicalBytes (type: String.t, default: nil) - Output only. Number of physical bytes more than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
  • externalDataConfiguration (type: GoogleApi.BigQuery.V2.Model.ExternalDataConfiguration.t, default: nil) - 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.
  • requirePartitionFilter (type: boolean(), default: false) - Optional. If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
  • materializedViewStatus (type: GoogleApi.BigQuery.V2.Model.MaterializedViewStatus.t, default: nil) - Output only. The materialized view status.
  • schema (type: GoogleApi.BigQuery.V2.Model.TableSchema.t, default: nil) - Optional. Describes the schema of this table.
  • defaultCollation (type: String.t, default: nil) - Optional. Defines the default collation specification of new STRING fields in the table. During table creation or update, if a STRING field is added to this table without explicit collation specified, then the table inherits the table default collation. A change to this field affects only fields added afterwards, and does not alter the existing fields. The following values are supported: 'und:ci': undetermined locale, case insensitive. '': empty string. Default to case-sensitive behavior.
  • location (type: String.t, default: nil) - Output only. The geographic location where the table resides. This value is inherited from the dataset.
  • numBytes (type: String.t, default: nil) - Output only. The size of this table in logical bytes, excluding any data in the streaming buffer.
  • streamingBuffer (type: GoogleApi.BigQuery.V2.Model.Streamingbuffer.t, default: nil) - 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.
  • maxStaleness (type: String.t, default: nil) - Optional. The maximum staleness of data that could be returned when the table (or stale MV) is queried. Staleness encoded as a string encoding of sql IntervalValue type.
  • expirationTime (type: String.t, default: nil) - 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.
  • materializedView (type: GoogleApi.BigQuery.V2.Model.MaterializedViewDefinition.t, default: nil) - Optional. The materialized view definition.
  • type (type: String.t, default: nil) - 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. EXTERNAL: A table that references data stored in an external storage system, such as Google Cloud Storage. MATERIALIZED_VIEW: A precomputed view defined by a SQL query. * SNAPSHOT: An immutable BigQuery table that preserves the contents of a base table at a particular time. See additional information on table snapshots. The default value is TABLE.
  • numActivePhysicalBytes (type: String.t, default: nil) - Output only. Number of physical bytes less than 90 days old. This data is not kept in real time, and might be delayed by a few seconds to a few minutes.
  • partitionDefinition (type: GoogleApi.BigQuery.V2.Model.PartitioningDefinition.t, default: nil) - Output only. The partition information for all table formats, including managed partitioned tables, hive partitioned tables, and iceberg partitioned tables.
  • rangePartitioning (type: GoogleApi.BigQuery.V2.Model.RangePartitioning.t, default: nil) - If specified, configures range partitioning for this table.
  • numPhysicalBytes (type: String.t, default: nil) - Output only. The physical size of this table in bytes. This includes storage used for time travel.
  • numRows (type: String.t, default: nil) - Output only. The number of rows of data in this table, excluding any data in the streaming buffer.
  • etag (type: String.t, default: nil) - Output only. A hash of this resource.
  • numActiveLogicalBytes (type: String.t, default: nil) - Output only. Number of logical bytes that are less than 90 days old.
  • model (type: GoogleApi.BigQuery.V2.Model.ModelDefinition.t, default: nil) - Deprecated.
  • numTotalLogicalBytes (type: String.t, default: nil) - Output only. Total number of logical bytes in the table or materialized view.
  • id (type: String.t, default: nil) - Output only. An opaque ID uniquely identifying the table.
  • encryptionConfiguration (type: GoogleApi.BigQuery.V2.Model.EncryptionConfiguration.t, default: nil) - Custom encryption configuration (e.g., Cloud KMS keys).

Attributes

  • v (type: any(), default: nil) -

The TableConstraints defines the primary key and foreign key.

Represents a foreign key constraint on a table's columns.

The pair of the foreign key column and primary key column.

Attributes

  • datasetId (type: String.t, default: nil) -
  • projectId (type: String.t, default: nil) -
  • tableId (type: String.t, default: nil) -

Represents the primary key constraint on a table's columns.

Request for sending a single streaming insert.

Describes the format of a streaming insert response.

Error details about a single row's insertion.

Attributes

  • etag (type: String.t, default: nil) - A hash of this page of results.
  • kind (type: String.t, default: bigquery#tableDataList) - The resource type of the response.
  • pageToken (type: String.t, default: nil) - 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 (type: list(GoogleApi.BigQuery.V2.Model.TableRow.t), default: nil) - Rows of results.
  • totalRows (type: String.t, default: nil) - Total rows of the entire table. In order to show default value 0 we have to present it as string.

Optional. The policy tags attached to this field, used for field-level access control. If not set, defaults to empty policy_tags.

Represents the type of a field element.

Partial projection of the metadata for a given table in a list response.

Attributes

  • clustering (type: GoogleApi.BigQuery.V2.Model.Clustering.t, default: nil) - Clustering specification for this table, if configured.
  • creationTime (type: String.t, default: nil) - Output only. The time when this table was created, in milliseconds since the epoch.
  • expirationTime (type: String.t, default: nil) - 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 (type: String.t, default: nil) - The user-friendly name for this table.
  • id (type: String.t, default: nil) - An opaque ID of the table.
  • kind (type: String.t, default: nil) - The resource type.
  • labels (type: map(), default: nil) - The labels associated with this table. You can use these to organize and group your tables.
  • rangePartitioning (type: GoogleApi.BigQuery.V2.Model.RangePartitioning.t, default: nil) - The range partitioning for this table.
  • requirePartitionFilter (type: boolean(), default: false) - Optional. If set to true, queries including this table must specify a partition filter. This filter is used for partition elimination.
  • tableReference (type: GoogleApi.BigQuery.V2.Model.TableReference.t, default: nil) - A reference uniquely identifying table.
  • timePartitioning (type: GoogleApi.BigQuery.V2.Model.TimePartitioning.t, default: nil) - The time-based partitioning for this table.
  • type (type: String.t, default: nil) - The type of table.
  • view (type: GoogleApi.BigQuery.V2.Model.TableListTablesView.t, default: nil) - Information about a logical view.

Information about a logical view.

Table level detail on the usage of metadata caching. Only set for Metadata caching eligible tables referenced in the query.

Attributes

  • datasetId (type: String.t, default: nil) - Required. The ID of the dataset containing this table.
  • projectId (type: String.t, default: nil) - Required. The ID of the project containing this table.
  • tableId (type: String.t, default: nil) - Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see General Category. The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as sample_table$20190123.

Replication info of a table created using AS REPLICA DDL like: CREATE MATERIALIZED VIEW mv1 AS REPLICA OF src_mv

Attributes

  • f (type: list(GoogleApi.BigQuery.V2.Model.TableCell.t), default: nil) - Represents a single row in the result set, consisting of one or more fields.

Request message for TestIamPermissions method.

Response message for TestIamPermissions method.

Attributes

  • expirationMs (type: String.t, default: nil) - Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.
  • field (type: String.t, default: nil) - Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.
  • requirePartitionFilter (type: boolean(), default: false) - If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.
  • type (type: String.t, default: nil) - Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.

Options used in model training.

Information about a single training query run for the model.

[Alpha] Information of a multi-statement transaction.

Information about a single transform column.

Request format for undeleting a dataset.

This is used for defining User Defined Function (UDF) resources only when using legacy SQL. Users of GoogleSQL 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

Statistics for a vector search query. Populated as part of JobStatistics2.

Describes the definition of a logical view.