Namespace Google.Apis.Bigquery.v2.Data

Classes

AggregateClassificationMetrics

Aggregate metrics for classification/classifier models. For multi-class models, the metrics are either macro-averaged or micro-averaged. When macro-averaged, the metrics are calculated for each label and then an unweighted average is taken of those values. When micro-averaged, the metric is calculated globally by counting the total number of correctly predicted rows.

AggregationThresholdPolicy

Represents privacy policy associated with "aggregation threshold" method.

Argument

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

ArimaCoefficients

Arima coefficients.

ArimaFittingMetrics

ARIMA model fitting metrics.

ArimaForecastingMetrics

Model evaluation metrics for ARIMA forecasting models.

ArimaModelInfo

Arima model information.

ArimaOrder

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

ArimaResult

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

ArimaSingleModelForecastingMetrics

Model evaluation metrics for a single ARIMA forecasting model.

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

AuditLogConfig

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

AvroOptions

Options for external data sources.

BiEngineReason

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

BiEngineStatistics

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

BigLakeConfiguration

Configuration for BigLake managed tables.

BigQueryModelTraining

BigtableColumn

Information related to a Bigtable column.

BigtableColumnFamily

Information related to a Bigtable column family.

BigtableOptions

Options specific to Google Cloud Bigtable data sources.

BinaryClassificationMetrics

Evaluation metrics for binary classification/classifier models.

BinaryConfusionMatrix

Confusion matrix for binary classification models.

Binding

Associates members, or principals, with a role.

BqmlIterationResult

BqmlTrainingRun

BqmlTrainingRun.TrainingOptionsData

Deprecated.

CategoricalValue

Representative value of a categorical feature.

CategoryCount

Represents the count of a single category within the cluster.

CloneDefinition

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

Cluster

Message containing the information about one cluster.

ClusterInfo

Information about a single cluster for clustering model.

Clustering

Configures table clustering.

ClusteringMetrics

Evaluation metrics for clustering models.

ConfusionMatrix

Confusion matrix for multi-class classification models.

ConnectionProperty

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 * service_account: indicates the service account to use to run a continuous query. If set, the query job uses the service account to access Google Cloud resources. Service account access is bounded by the IAM permissions that you have granted to the service account. Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.

CsvOptions

Information related to a CSV data source.

DataFormatOptions

Options for data format adjustments.

DataMaskingStatistics

Statistics for data-masking.

DataPolicyOption

Data policy option proto, it currently supports name only, will support precedence later.

DataSplitResult

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

Dataset

Represents a BigQuery dataset.

Dataset.AccessData

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; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.

Dataset.TagsData

Output only. Tags for the dataset. To provide tags as inputs, use the resourceTags field.

DatasetAccessEntry

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.

DatasetList

Response format for a page of results when listing datasets.

DatasetList.DatasetsData

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.

DatasetReference

Identifier for a dataset.

DestinationTableProperties

Properties for the destination table.

DifferentialPrivacyPolicy

Represents privacy policy associated with "differential privacy" method.

DimensionalityReductionMetrics

Model evaluation metrics for dimensionality reduction models.

DmlStatistics

Detailed statistics for DML statements

DoubleCandidates

Discrete candidates of a double hyperparameter.

DoubleHparamSearchSpace

Search space for a double hyperparameter.

DoubleRange

Range of a double hyperparameter.

EncryptionConfiguration

Configuration for Cloud KMS encryption settings.

Entry

A single entry in the confusion matrix.

ErrorProto

Error details.

EvaluationMetrics

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

ExplainQueryStage

A single stage of query execution.

ExplainQueryStep

An operation within a stage.

Explanation

Explanation for a single feature.

ExportDataStatistics

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

Expr

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

ExternalCatalogDatasetOptions

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.

ExternalCatalogTableOptions

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

ExternalDataConfiguration

ExternalDatasetReference

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

ExternalServiceCost

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.

FeatureValue

Representative value of a single feature within the cluster.

ForeignTypeInfo

Metadata about the foreign data type definition such as the system in which the type is defined.

ForeignViewDefinition

A view can be represented in multiple ways. Each representation has its own dialect. This message stores the metadata required for these representations.

GetIamPolicyRequest

Request message for GetIamPolicy method.

GetPolicyOptions

Encapsulates settings provided to GetIamPolicy.

GetQueryResultsResponse

Response object of GetQueryResults.

GetServiceAccountResponse

Response object of GetServiceAccount

GlobalExplanation

Global explanations containing the top most important features after training.

GoogleSheetsOptions

Options specific to Google Sheets data sources.

HighCardinalityJoin

High cardinality join detailed information.

HivePartitioningOptions

Options for configuring hive partitioning detect.

HparamSearchSpaces

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

HparamTuningTrial

Training info of a trial in hyperparameter tuning models.

IndexUnusedReason

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

InputDataChange

Details about the input data change insight.

IntArray

An array of int.

IntArrayHparamSearchSpace

Search space for int array.

IntCandidates

Discrete candidates of an int hyperparameter.

IntHparamSearchSpace

Search space for an int hyperparameter.

IntRange

Range of an int hyperparameter.

IterationResult

Information about a single iteration of the training run.

Job

JobCancelResponse

Describes format of a jobs cancellation response.

JobConfiguration

JobConfigurationExtract

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

JobConfigurationLoad

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

JobConfigurationQuery

JobConfigurationQuery configures a BigQuery query job.

JobConfigurationTableCopy

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

JobCreationReason

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

JobList

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

JobList.JobsData

List of jobs that were requested.

JobReference

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

JobStatistics

Statistics for a single job execution.

JobStatistics.ReservationUsageData

Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.

JobStatistics2

Statistics for a query job.

JobStatistics2.ReservationUsageData

Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated.

JobStatistics3

Statistics for a load job.

JobStatistics4

Statistics for an extract job.

JobStatistics5

Statistics for a copy job.

JobStatus

JoinRestrictionPolicy

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.

JsonOptions

Json Options for load and make external tables.

LinkedDatasetMetadata

Metadata about the Linked Dataset.

LinkedDatasetSource

A dataset source type which refers to another BigQuery dataset.

ListModelsResponse

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

ListRoutinesResponse

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

ListRowAccessPoliciesResponse

Response message for the ListRowAccessPolicies method.

LoadQueryStatistics

Statistics for a LOAD query.

LocationMetadata

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

MaterializedView

A materialized view considered for a query job.

MaterializedViewDefinition

Definition and configuration of a materialized view.

MaterializedViewStatistics

Statistics of materialized views considered in a query job.

MaterializedViewStatus

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

MetadataCacheStatistics

Statistics for metadata caching in BigLake tables.

MlStatistics

Job statistics specific to a BigQuery ML training job.

Model

ModelDefinition

ModelDefinition.ModelOptionsData

Deprecated.

ModelExtractOptions

Options related to model extraction.

ModelReference

Id path of a model.

MultiClassClassificationMetrics

Evaluation metrics for multi-class classification/classifier models.

ParquetOptions

Parquet Options for load and make external tables.

PartitionSkew

Partition skew detailed information.

PartitionedColumn

The partitioning column information.

PartitioningDefinition

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

PerformanceInsights

Performance insights for the job.

Policy

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members, 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
&lt; 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 &lt;
timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3

For a description of IAM and its features, see the IAM documentation.

PrincipalComponentInfo

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

PrivacyPolicy

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

ProjectList

Response object of ListProjects

ProjectList.ProjectsData

Projects to which the user has at least READ access.

ProjectReference

A unique reference to a project.

QueryInfo

Query optimization information for a QUERY job.

QueryParameter

A parameter given to a query.

QueryParameterType

The type of a query parameter.

QueryParameterType.StructTypesData

Optional. The types of the fields of this struct, in order, if this is a struct.

QueryParameterValue

The value of a query parameter.

QueryRequest

Describes the format of the jobs.query request.

QueryResponse

QueryTimelineSample

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

RangePartitioning

RangePartitioning.RangeData

[Experimental] Defines the ranges for range partitioning.

RangeValue

Represents the value of a range.

RankingMetrics

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

RegressionMetrics

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

RemoteFunctionOptions

Options for a remote user-defined function.

RemoteModelInfo

Remote Model Info

RestrictionConfig

Routine

A user-defined function or a stored procedure.

RoutineReference

Id path of a routine.

Row

A single row in the confusion matrix.

RowAccessPolicy

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

RowAccessPolicyReference

Id path of a row access policy.

RowLevelSecurityStatistics

Statistics for row-level security.

ScriptOptions

Options related to script execution.

ScriptStackFrame

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.

ScriptStatistics

Job statistics specific to the child job of a script.

SearchStatistics

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

SerDeInfo

Serializer and deserializer information.

SessionInfo

[Preview] Information related to sessions.

SetIamPolicyRequest

Request message for SetIamPolicy method.

SkewSource

Details about source stages which produce skewed data.

SnapshotDefinition

Information about base table and snapshot time of the snapshot.

SparkLoggingInfo

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

SparkOptions

Options for a user-defined Spark routine.

SparkStatistics

Statistics for a BigSpark query. Populated as part of JobStatistics2

StagePerformanceChangeInsight

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

StagePerformanceStandaloneInsight

Standalone performance insights for a specific stage.

StandardSqlDataType

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"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} }

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

VectorSearchStatistics

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

ViewDefinition

Describes the definition of a logical view.