bigquery

package
v0.175.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 19, 2024 License: BSD-3-Clause Imports: 16 Imported by: 701

Documentation

Overview

Package bigquery provides access to the BigQuery API.

This package is DEPRECATED. Use package cloud.google.com/go/bigquery instead.

For product documentation, see: https://cloud.google.com/bigquery/

Library status

These client libraries are officially supported by Google. However, this library is considered complete and is in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

When possible, we recommend using our newer [Cloud Client Libraries for Go](https://pkg.go.dev/cloud.google.com/go) that are still actively being worked and iterated on.

Creating a client

Usage example:

import "google.golang.org/api/bigquery/v2"
...
ctx := context.Background()
bigqueryService, err := bigquery.NewService(ctx)

In this example, Google Application Default Credentials are used for authentication. For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.

Other authentication options

By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use google.golang.org/api/option.WithScopes:

bigqueryService, err := bigquery.NewService(ctx, option.WithScopes(bigquery.DevstorageReadWriteScope))

To use an API key for authentication (note: some APIs do not support API keys), use google.golang.org/api/option.WithAPIKey:

bigqueryService, err := bigquery.NewService(ctx, option.WithAPIKey("AIza..."))

To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow, use google.golang.org/api/option.WithTokenSource:

config := &oauth2.Config{...}
// ...
token, err := config.Exchange(ctx, ...)
bigqueryService, err := bigquery.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))

See google.golang.org/api/option.ClientOption for details on options.

Index

Constants

View Source
const (
	// View and manage your data in Google BigQuery and see the email
	// address for your Google Account
	BigqueryScope = "https://www.googleapis.com/auth/bigquery"

	// Insert data into Google BigQuery
	BigqueryInsertdataScope = "https://www.googleapis.com/auth/bigquery.insertdata"

	// See, edit, configure, and delete your Google Cloud data and see the
	// email address for your Google Account.
	CloudPlatformScope = "https://www.googleapis.com/auth/cloud-platform"

	// View your data across Google Cloud services and see the email address
	// of your Google Account
	CloudPlatformReadOnlyScope = "https://www.googleapis.com/auth/cloud-platform.read-only"

	// Manage your data and permissions in Cloud Storage and see the email
	// address for your Google Account
	DevstorageFullControlScope = "https://www.googleapis.com/auth/devstorage.full_control"

	// View your data in Google Cloud Storage
	DevstorageReadOnlyScope = "https://www.googleapis.com/auth/devstorage.read_only"

	// Manage your data in Cloud Storage and see the email address of your
	// Google Account
	DevstorageReadWriteScope = "https://www.googleapis.com/auth/devstorage.read_write"
)

OAuth2 scopes used by this API.

Variables

This section is empty.

Functions

This section is empty.

Types

type AggregateClassificationMetrics added in v0.3.1

type AggregateClassificationMetrics struct {
	// Accuracy: Accuracy is the fraction of predictions given the correct
	// label. For multiclass this is a micro-averaged metric.
	Accuracy float64 `json:"accuracy,omitempty"`

	// F1Score: The F1 score is an average of recall and precision. For
	// multiclass this is a macro-averaged metric.
	F1Score float64 `json:"f1Score,omitempty"`

	// LogLoss: Logarithmic Loss. For multiclass this is a macro-averaged
	// metric.
	LogLoss float64 `json:"logLoss,omitempty"`

	// Precision: Precision is the fraction of actual positive predictions
	// that had positive actual labels. For multiclass this is a
	// macro-averaged metric treating each class as a binary classifier.
	Precision float64 `json:"precision,omitempty"`

	// Recall: Recall is the fraction of actual positive labels that were
	// given a positive prediction. For multiclass this is a macro-averaged
	// metric.
	Recall float64 `json:"recall,omitempty"`

	// RocAuc: Area Under a ROC Curve. For multiclass this is a
	// macro-averaged metric.
	RocAuc float64 `json:"rocAuc,omitempty"`

	// Threshold: Threshold at which the metrics are computed. For binary
	// classification models this is the positive class threshold. For
	// multi-class classfication models this is the confidence threshold.
	Threshold float64 `json:"threshold,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Accuracy") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accuracy") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*AggregateClassificationMetrics) MarshalJSON added in v0.3.1

func (s *AggregateClassificationMetrics) MarshalJSON() ([]byte, error)

func (*AggregateClassificationMetrics) UnmarshalJSON added in v0.3.1

func (s *AggregateClassificationMetrics) UnmarshalJSON(data []byte) error

type AggregationThresholdPolicy added in v0.148.0

type AggregationThresholdPolicy struct {
	// PrivacyUnitColumns: Optional. The privacy unit column(s) associated
	// with this policy. For now, only one column per data source object
	// (table, view) is allowed as a privacy unit column. Representing as a
	// repeated field in metadata for extensibility to multiple columns in
	// future. Duplicates and Repeated struct fields are not allowed. For
	// nested fields, use dot notation ("outer.inner")
	PrivacyUnitColumns []string `json:"privacyUnitColumns,omitempty"`

	// Threshold: Optional. The threshold for the "aggregation threshold"
	// policy.
	Threshold int64 `json:"threshold,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "PrivacyUnitColumns")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "PrivacyUnitColumns") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AggregationThresholdPolicy: Represents privacy policy associated with "aggregation threshold" method.

func (*AggregationThresholdPolicy) MarshalJSON added in v0.148.0

func (s *AggregationThresholdPolicy) MarshalJSON() ([]byte, error)

type Argument added in v0.7.0

type Argument struct {
	// ArgumentKind: Optional. Defaults to FIXED_TYPE.
	//
	// Possible values:
	//   "ARGUMENT_KIND_UNSPECIFIED" - Default value.
	//   "FIXED_TYPE" - The argument is a variable with fully specified
	// type, which can be a struct or an array, but not a table.
	//   "ANY_TYPE" - The argument is any type, including struct or array,
	// but not a table. To be added: FIXED_TABLE, ANY_TABLE
	ArgumentKind string `json:"argumentKind,omitempty"`

	// DataType: Required unless argument_kind = ANY_TYPE.
	DataType *StandardSqlDataType `json:"dataType,omitempty"`

	// IsAggregate: Optional. Whether the argument is an aggregate function
	// parameter. Must be Unset for routine types other than
	// AGGREGATE_FUNCTION. For AGGREGATE_FUNCTION, if set to false, it is
	// equivalent to adding "NOT AGGREGATE" clause in DDL; Otherwise, it is
	// equivalent to omitting "NOT AGGREGATE" clause in DDL.
	IsAggregate bool `json:"isAggregate,omitempty"`

	// Mode: Optional. Specifies whether the argument is input or output.
	// Can be set for procedures only.
	//
	// Possible values:
	//   "MODE_UNSPECIFIED" - Default value.
	//   "IN" - The argument is input-only.
	//   "OUT" - The argument is output-only.
	//   "INOUT" - The argument is both an input and an output.
	Mode string `json:"mode,omitempty"`

	// Name: Optional. The name of this argument. Can be absent for function
	// return argument.
	Name string `json:"name,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ArgumentKind") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArgumentKind") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*Argument) MarshalJSON added in v0.7.0

func (s *Argument) MarshalJSON() ([]byte, error)

type ArimaCoefficients added in v0.11.0

type ArimaCoefficients struct {
	// AutoRegressiveCoefficients: Auto-regressive coefficients, an array of
	// double.
	AutoRegressiveCoefficients []float64 `json:"autoRegressiveCoefficients,omitempty"`

	// InterceptCoefficient: Intercept coefficient, just a double not an
	// array.
	InterceptCoefficient float64 `json:"interceptCoefficient,omitempty"`

	// MovingAverageCoefficients: Moving-average coefficients, an array of
	// double.
	MovingAverageCoefficients []float64 `json:"movingAverageCoefficients,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AutoRegressiveCoefficients") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "AutoRegressiveCoefficients") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

ArimaCoefficients: Arima coefficients.

func (*ArimaCoefficients) MarshalJSON added in v0.11.0

func (s *ArimaCoefficients) MarshalJSON() ([]byte, error)

func (*ArimaCoefficients) UnmarshalJSON added in v0.11.0

func (s *ArimaCoefficients) UnmarshalJSON(data []byte) error

type ArimaFittingMetrics added in v0.11.0

type ArimaFittingMetrics struct {
	// Aic: AIC.
	Aic float64 `json:"aic,omitempty"`

	// LogLikelihood: Log-likelihood.
	LogLikelihood float64 `json:"logLikelihood,omitempty"`

	// Variance: Variance.
	Variance float64 `json:"variance,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Aic") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Aic") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ArimaFittingMetrics: ARIMA model fitting metrics.

func (*ArimaFittingMetrics) MarshalJSON added in v0.11.0

func (s *ArimaFittingMetrics) MarshalJSON() ([]byte, error)

func (*ArimaFittingMetrics) UnmarshalJSON added in v0.11.0

func (s *ArimaFittingMetrics) UnmarshalJSON(data []byte) error

type ArimaForecastingMetrics added in v0.30.0

type ArimaForecastingMetrics struct {
	// ArimaFittingMetrics: Arima model fitting metrics.
	ArimaFittingMetrics []*ArimaFittingMetrics `json:"arimaFittingMetrics,omitempty"`

	// ArimaSingleModelForecastingMetrics: Repeated as there can be many
	// metric sets (one for each model) in auto-arima and the large-scale
	// case.
	ArimaSingleModelForecastingMetrics []*ArimaSingleModelForecastingMetrics `json:"arimaSingleModelForecastingMetrics,omitempty"`

	// HasDrift: Whether Arima model fitted with drift or not. It is always
	// false when d is not 1.
	HasDrift []bool `json:"hasDrift,omitempty"`

	// NonSeasonalOrder: Non-seasonal order.
	NonSeasonalOrder []*ArimaOrder `json:"nonSeasonalOrder,omitempty"`

	// SeasonalPeriods: Seasonal periods. Repeated because multiple periods
	// are supported for one time series.
	//
	// Possible values:
	//   "SEASONAL_PERIOD_TYPE_UNSPECIFIED" - Unspecified seasonal period.
	//   "NO_SEASONALITY" - No seasonality
	//   "DAILY" - Daily period, 24 hours.
	//   "WEEKLY" - Weekly period, 7 days.
	//   "MONTHLY" - Monthly period, 30 days or irregular.
	//   "QUARTERLY" - Quarterly period, 90 days or irregular.
	//   "YEARLY" - Yearly period, 365 days or irregular.
	SeasonalPeriods []string `json:"seasonalPeriods,omitempty"`

	// TimeSeriesId: Id to differentiate different time series for the
	// large-scale case.
	TimeSeriesId []string `json:"timeSeriesId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ArimaFittingMetrics")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaFittingMetrics") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ArimaForecastingMetrics: Model evaluation metrics for ARIMA forecasting models.

func (*ArimaForecastingMetrics) MarshalJSON added in v0.30.0

func (s *ArimaForecastingMetrics) MarshalJSON() ([]byte, error)

type ArimaModelInfo added in v0.11.0

type ArimaModelInfo struct {
	// ArimaCoefficients: Arima coefficients.
	ArimaCoefficients *ArimaCoefficients `json:"arimaCoefficients,omitempty"`

	// ArimaFittingMetrics: Arima fitting metrics.
	ArimaFittingMetrics *ArimaFittingMetrics `json:"arimaFittingMetrics,omitempty"`

	// HasDrift: Whether Arima model fitted with drift or not. It is always
	// false when d is not 1.
	HasDrift bool `json:"hasDrift,omitempty"`

	// HasHolidayEffect: If true, holiday_effect is a part of time series
	// decomposition result.
	HasHolidayEffect bool `json:"hasHolidayEffect,omitempty"`

	// HasSpikesAndDips: If true, spikes_and_dips is a part of time series
	// decomposition result.
	HasSpikesAndDips bool `json:"hasSpikesAndDips,omitempty"`

	// HasStepChanges: If true, step_changes is a part of time series
	// decomposition result.
	HasStepChanges bool `json:"hasStepChanges,omitempty"`

	// NonSeasonalOrder: Non-seasonal order.
	NonSeasonalOrder *ArimaOrder `json:"nonSeasonalOrder,omitempty"`

	// SeasonalPeriods: Seasonal periods. Repeated because multiple periods
	// are supported for one time series.
	//
	// Possible values:
	//   "SEASONAL_PERIOD_TYPE_UNSPECIFIED" - Unspecified seasonal period.
	//   "NO_SEASONALITY" - No seasonality
	//   "DAILY" - Daily period, 24 hours.
	//   "WEEKLY" - Weekly period, 7 days.
	//   "MONTHLY" - Monthly period, 30 days or irregular.
	//   "QUARTERLY" - Quarterly period, 90 days or irregular.
	//   "YEARLY" - Yearly period, 365 days or irregular.
	SeasonalPeriods []string `json:"seasonalPeriods,omitempty"`

	// TimeSeriesId: The time_series_id value for this time series. It will
	// be one of the unique values from the time_series_id_column specified
	// during ARIMA model training. Only present when time_series_id_column
	// training option was used.
	TimeSeriesId string `json:"timeSeriesId,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "ArimaCoefficients")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaCoefficients") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ArimaModelInfo: Arima model information.

func (*ArimaModelInfo) MarshalJSON added in v0.11.0

func (s *ArimaModelInfo) MarshalJSON() ([]byte, error)

type ArimaOrder added in v0.11.0

type ArimaOrder struct {
	// D: Order of the differencing part.
	D int64 `json:"d,omitempty,string"`

	// P: Order of the autoregressive part.
	P int64 `json:"p,omitempty,string"`

	// Q: Order of the moving-average part.
	Q int64 `json:"q,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "D") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "D") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ArimaOrder) MarshalJSON added in v0.11.0

func (s *ArimaOrder) MarshalJSON() ([]byte, error)

type ArimaResult added in v0.11.0

type ArimaResult struct {
	// ArimaModelInfo: This message is repeated because there are multiple
	// arima models fitted in auto-arima. For non-auto-arima model, its size
	// is one.
	ArimaModelInfo []*ArimaModelInfo `json:"arimaModelInfo,omitempty"`

	// SeasonalPeriods: Seasonal periods. Repeated because multiple periods
	// are supported for one time series.
	//
	// Possible values:
	//   "SEASONAL_PERIOD_TYPE_UNSPECIFIED" - Unspecified seasonal period.
	//   "NO_SEASONALITY" - No seasonality
	//   "DAILY" - Daily period, 24 hours.
	//   "WEEKLY" - Weekly period, 7 days.
	//   "MONTHLY" - Monthly period, 30 days or irregular.
	//   "QUARTERLY" - Quarterly period, 90 days or irregular.
	//   "YEARLY" - Yearly period, 365 days or irregular.
	SeasonalPeriods []string `json:"seasonalPeriods,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ArimaModelInfo") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaModelInfo") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*ArimaResult) MarshalJSON added in v0.11.0

func (s *ArimaResult) MarshalJSON() ([]byte, error)

type ArimaSingleModelForecastingMetrics added in v0.30.0

type ArimaSingleModelForecastingMetrics struct {
	// ArimaFittingMetrics: Arima fitting metrics.
	ArimaFittingMetrics *ArimaFittingMetrics `json:"arimaFittingMetrics,omitempty"`

	// HasDrift: Is arima model fitted with drift or not. It is always false
	// when d is not 1.
	HasDrift bool `json:"hasDrift,omitempty"`

	// HasHolidayEffect: If true, holiday_effect is a part of time series
	// decomposition result.
	HasHolidayEffect bool `json:"hasHolidayEffect,omitempty"`

	// HasSpikesAndDips: If true, spikes_and_dips is a part of time series
	// decomposition result.
	HasSpikesAndDips bool `json:"hasSpikesAndDips,omitempty"`

	// HasStepChanges: If true, step_changes is a part of time series
	// decomposition result.
	HasStepChanges bool `json:"hasStepChanges,omitempty"`

	// NonSeasonalOrder: Non-seasonal order.
	NonSeasonalOrder *ArimaOrder `json:"nonSeasonalOrder,omitempty"`

	// SeasonalPeriods: Seasonal periods. Repeated because multiple periods
	// are supported for one time series.
	//
	// Possible values:
	//   "SEASONAL_PERIOD_TYPE_UNSPECIFIED" - Unspecified seasonal period.
	//   "NO_SEASONALITY" - No seasonality
	//   "DAILY" - Daily period, 24 hours.
	//   "WEEKLY" - Weekly period, 7 days.
	//   "MONTHLY" - Monthly period, 30 days or irregular.
	//   "QUARTERLY" - Quarterly period, 90 days or irregular.
	//   "YEARLY" - Yearly period, 365 days or irregular.
	SeasonalPeriods []string `json:"seasonalPeriods,omitempty"`

	// TimeSeriesId: The time_series_id value for this time series. It will
	// be one of the unique values from the time_series_id_column specified
	// during ARIMA model training. Only present when time_series_id_column
	// training option was used.
	TimeSeriesId string `json:"timeSeriesId,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "ArimaFittingMetrics")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaFittingMetrics") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ArimaSingleModelForecastingMetrics: Model evaluation metrics for a single ARIMA forecasting model.

func (*ArimaSingleModelForecastingMetrics) MarshalJSON added in v0.30.0

func (s *ArimaSingleModelForecastingMetrics) MarshalJSON() ([]byte, error)

type AuditConfig added in v0.25.0

type AuditConfig struct {
	// AuditLogConfigs: The configuration for logging of each type of
	// permission.
	AuditLogConfigs []*AuditLogConfig `json:"auditLogConfigs,omitempty"`

	// Service: Specifies a service that will be enabled for audit logging.
	// For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
	// `allServices` is a special value that covers all services.
	Service string `json:"service,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AuditLogConfigs") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AuditLogConfigs") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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.

func (*AuditConfig) MarshalJSON added in v0.25.0

func (s *AuditConfig) MarshalJSON() ([]byte, error)

type AuditLogConfig added in v0.25.0

type AuditLogConfig struct {
	// ExemptedMembers: Specifies the identities that do not cause logging
	// for this type of permission. Follows the same format of
	// Binding.members.
	ExemptedMembers []string `json:"exemptedMembers,omitempty"`

	// LogType: The log type that this config enables.
	//
	// Possible values:
	//   "LOG_TYPE_UNSPECIFIED" - Default case. Should never be this.
	//   "ADMIN_READ" - Admin reads. Example: CloudIAM getIamPolicy
	//   "DATA_WRITE" - Data writes. Example: CloudSQL Users create
	//   "DATA_READ" - Data reads. Example: CloudSQL Users list
	LogType string `json:"logType,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ExemptedMembers") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ExemptedMembers") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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.

func (*AuditLogConfig) MarshalJSON added in v0.25.0

func (s *AuditLogConfig) MarshalJSON() ([]byte, error)

type AvroOptions added in v0.57.0

type AvroOptions struct {
	// UseAvroLogicalTypes: Optional. If sourceFormat is set to "AVRO",
	// indicates whether to interpret logical types as the corresponding
	// BigQuery data type (for example, TIMESTAMP), instead of using the raw
	// type (for example, INTEGER).
	UseAvroLogicalTypes bool `json:"useAvroLogicalTypes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UseAvroLogicalTypes")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UseAvroLogicalTypes") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

AvroOptions: Options for external data sources.

func (*AvroOptions) MarshalJSON added in v0.57.0

func (s *AvroOptions) MarshalJSON() ([]byte, error)

type BiEngineReason added in v0.50.0

type BiEngineReason struct {
	// Code: Output only. High-level BI Engine reason for partial or
	// disabled acceleration
	//
	// Possible values:
	//   "CODE_UNSPECIFIED" - BiEngineReason not specified.
	//   "NO_RESERVATION" - No reservation available for BI Engine
	// acceleration.
	//   "INSUFFICIENT_RESERVATION" - Not enough memory available for BI
	// Engine acceleration.
	//   "UNSUPPORTED_SQL_TEXT" - This particular SQL text is not supported
	// for acceleration by BI Engine.
	//   "INPUT_TOO_LARGE" - Input too large for acceleration by BI Engine.
	//   "OTHER_REASON" - Catch-all code for all other cases for partial or
	// disabled acceleration.
	//   "TABLE_EXCLUDED" - One or more tables were not eligible for BI
	// Engine acceleration.
	Code string `json:"code,omitempty"`

	// Message: Output only. Free form human-readable reason for partial or
	// disabled acceleration.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*BiEngineReason) MarshalJSON added in v0.50.0

func (s *BiEngineReason) MarshalJSON() ([]byte, error)

type BiEngineStatistics added in v0.50.0

type BiEngineStatistics struct {
	// AccelerationMode: Output only. Specifies which mode of BI Engine
	// acceleration was performed (if any).
	//
	// Possible values:
	//   "BI_ENGINE_ACCELERATION_MODE_UNSPECIFIED" - BiEngineMode type not
	// specified.
	//   "BI_ENGINE_DISABLED" - BI Engine acceleration was attempted but
	// disabled. bi_engine_reasons specifies a more detailed reason.
	//   "PARTIAL_INPUT" - Some inputs were accelerated using BI Engine. See
	// bi_engine_reasons for why parts of the query were not accelerated.
	//   "FULL_INPUT" - All of the query inputs were accelerated using BI
	// Engine.
	//   "FULL_QUERY" - All of the query was accelerated using BI Engine.
	AccelerationMode string `json:"accelerationMode,omitempty"`

	// BiEngineMode: Output only. Specifies which mode of BI Engine
	// acceleration was performed (if any).
	//
	// Possible values:
	//   "ACCELERATION_MODE_UNSPECIFIED" - BiEngineMode type not specified.
	//   "DISABLED" - BI Engine disabled the acceleration. bi_engine_reasons
	// specifies a more detailed reason.
	//   "PARTIAL" - Part of the query was accelerated using BI Engine. See
	// bi_engine_reasons for why parts of the query were not accelerated.
	//   "FULL" - All of the query was accelerated using BI Engine.
	BiEngineMode string `json:"biEngineMode,omitempty"`

	// BiEngineReasons: In case of DISABLED or PARTIAL bi_engine_mode, these
	// contain the explanatory reasons as to why BI Engine could not
	// accelerate. In case the full query was accelerated, this field is not
	// populated.
	BiEngineReasons []*BiEngineReason `json:"biEngineReasons,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AccelerationMode") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AccelerationMode") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*BiEngineStatistics) MarshalJSON added in v0.50.0

func (s *BiEngineStatistics) MarshalJSON() ([]byte, error)

type BigLakeConfiguration added in v0.138.0

type BigLakeConfiguration struct {
	// ConnectionId: Required. The connection specifying the credentials to
	// be used to read and write to external storage, such as Cloud Storage.
	// The connection_id can have the form
	// "<project\_id>.<location\_id>.<connection\_id>" or
	// "projects/<project\_id>/locations/<location\_id>/connections/<connecti
	// on\_id>".
	ConnectionId string `json:"connectionId,omitempty"`

	// FileFormat: Required. The file format the table data is stored in.
	//
	// Possible values:
	//   "FILE_FORMAT_UNSPECIFIED" - Default Value.
	//   "PARQUET" - Apache Parquet format.
	FileFormat string `json:"fileFormat,omitempty"`

	// StorageUri: Required. The fully qualified location prefix of the
	// external folder where table data is stored. The '*' wildcard
	// character is not allowed. The URI should be in the format
	// "gs://bucket/path_to_table/"
	StorageUri string `json:"storageUri,omitempty"`

	// TableFormat: Required. The table format the metadata only snapshots
	// are stored in.
	//
	// Possible values:
	//   "TABLE_FORMAT_UNSPECIFIED" - Default Value.
	//   "ICEBERG" - Apache Iceberg format.
	TableFormat string `json:"tableFormat,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConnectionId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConnectionId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BigLakeConfiguration: Configuration for BigLake managed tables.

func (*BigLakeConfiguration) MarshalJSON added in v0.138.0

func (s *BigLakeConfiguration) MarshalJSON() ([]byte, error)

type BigQueryModelTraining

type BigQueryModelTraining struct {
	// CurrentIteration: Deprecated.
	CurrentIteration int64 `json:"currentIteration,omitempty"`

	// ExpectedTotalIterations: Deprecated.
	ExpectedTotalIterations int64 `json:"expectedTotalIterations,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "CurrentIteration") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CurrentIteration") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*BigQueryModelTraining) MarshalJSON

func (s *BigQueryModelTraining) MarshalJSON() ([]byte, error)

type BigtableColumn

type BigtableColumn struct {
	// Encoding: 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.
	Encoding string `json:"encoding,omitempty"`

	// FieldName: Optional. If the qualifier is not a valid BigQuery field
	// identifier i.e. does not match a-zA-Z*, a valid identifier must be
	// provided as the column field name and is used as field name in
	// queries.
	FieldName string `json:"fieldName,omitempty"`

	// OnlyReadLatest: 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.
	OnlyReadLatest bool `json:"onlyReadLatest,omitempty"`

	// QualifierEncoded: [Required] Qualifier of the column. Columns in the
	// parent column family that has this exact qualifier are exposed as .
	// field. If the qualifier is valid UTF-8 string, it can be specified in
	// the qualifier_string field. Otherwise, a base-64 encoded value must
	// be set to qualifier_encoded. The column field name is the same as the
	// column qualifier. However, if the qualifier is not a valid BigQuery
	// field identifier i.e. does not match a-zA-Z*, a valid identifier must
	// be provided as field_name.
	QualifierEncoded string `json:"qualifierEncoded,omitempty"`

	// QualifierString: Qualifier string.
	QualifierString string `json:"qualifierString,omitempty"`

	// Type: 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 * JSON 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.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Encoding") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Encoding") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BigtableColumn: Information related to a Bigtable column.

func (*BigtableColumn) MarshalJSON

func (s *BigtableColumn) MarshalJSON() ([]byte, error)

type BigtableColumnFamily

type BigtableColumnFamily struct {
	// Columns: 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.
	Columns []*BigtableColumn `json:"columns,omitempty"`

	// Encoding: 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.
	Encoding string `json:"encoding,omitempty"`

	// FamilyId: Identifier of the column family.
	FamilyId string `json:"familyId,omitempty"`

	// OnlyReadLatest: 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.
	OnlyReadLatest bool `json:"onlyReadLatest,omitempty"`

	// Type: 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 * JSON Default type is BYTES. This
	// can be overridden for a specific column by listing that column in
	// 'columns' and specifying a type for it.
	Type string `json:"type,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Columns") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Columns") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BigtableColumnFamily: Information related to a Bigtable column family.

func (*BigtableColumnFamily) MarshalJSON

func (s *BigtableColumnFamily) MarshalJSON() ([]byte, error)

type BigtableOptions

type BigtableOptions struct {
	// ColumnFamilies: 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.
	ColumnFamilies []*BigtableColumnFamily `json:"columnFamilies,omitempty"`

	// IgnoreUnspecifiedColumnFamilies: 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.
	IgnoreUnspecifiedColumnFamilies bool `json:"ignoreUnspecifiedColumnFamilies,omitempty"`

	// OutputColumnFamiliesAsJson: Optional. If field is true, then each
	// column family will be read as a single JSON column. Otherwise they
	// are read as a repeated cell structure containing timestamp/value
	// tuples. The default value is false.
	OutputColumnFamiliesAsJson bool `json:"outputColumnFamiliesAsJson,omitempty"`

	// ReadRowkeyAsString: 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.
	ReadRowkeyAsString bool `json:"readRowkeyAsString,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ColumnFamilies") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ColumnFamilies") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

BigtableOptions: Options specific to Google Cloud Bigtable data sources.

func (*BigtableOptions) MarshalJSON

func (s *BigtableOptions) MarshalJSON() ([]byte, error)

type BinaryClassificationMetrics added in v0.3.1

type BinaryClassificationMetrics struct {
	// AggregateClassificationMetrics: Aggregate classification metrics.
	AggregateClassificationMetrics *AggregateClassificationMetrics `json:"aggregateClassificationMetrics,omitempty"`

	// BinaryConfusionMatrixList: Binary confusion matrix at multiple
	// thresholds.
	BinaryConfusionMatrixList []*BinaryConfusionMatrix `json:"binaryConfusionMatrixList,omitempty"`

	// NegativeLabel: Label representing the negative class.
	NegativeLabel string `json:"negativeLabel,omitempty"`

	// PositiveLabel: Label representing the positive class.
	PositiveLabel string `json:"positiveLabel,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "AggregateClassificationMetrics") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "AggregateClassificationMetrics") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

BinaryClassificationMetrics: Evaluation metrics for binary classification/classifier models.

func (*BinaryClassificationMetrics) MarshalJSON added in v0.3.1

func (s *BinaryClassificationMetrics) MarshalJSON() ([]byte, error)

type BinaryConfusionMatrix added in v0.3.1

type BinaryConfusionMatrix struct {
	// Accuracy: The fraction of predictions given the correct label.
	Accuracy float64 `json:"accuracy,omitempty"`

	// F1Score: The equally weighted average of recall and precision.
	F1Score float64 `json:"f1Score,omitempty"`

	// FalseNegatives: Number of false samples predicted as false.
	FalseNegatives int64 `json:"falseNegatives,omitempty,string"`

	// FalsePositives: Number of false samples predicted as true.
	FalsePositives int64 `json:"falsePositives,omitempty,string"`

	// PositiveClassThreshold: Threshold value used when computing each of
	// the following metric.
	PositiveClassThreshold float64 `json:"positiveClassThreshold,omitempty"`

	// Precision: The fraction of actual positive predictions that had
	// positive actual labels.
	Precision float64 `json:"precision,omitempty"`

	// Recall: The fraction of actual positive labels that were given a
	// positive prediction.
	Recall float64 `json:"recall,omitempty"`

	// TrueNegatives: Number of true samples predicted as false.
	TrueNegatives int64 `json:"trueNegatives,omitempty,string"`

	// TruePositives: Number of true samples predicted as true.
	TruePositives int64 `json:"truePositives,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Accuracy") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Accuracy") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BinaryConfusionMatrix: Confusion matrix for binary classification models.

func (*BinaryConfusionMatrix) MarshalJSON added in v0.3.1

func (s *BinaryConfusionMatrix) MarshalJSON() ([]byte, error)

func (*BinaryConfusionMatrix) UnmarshalJSON added in v0.3.1

func (s *BinaryConfusionMatrix) UnmarshalJSON(data []byte) error

type Binding added in v0.25.0

type Binding struct {
	// Condition: The condition that is associated with this binding. If the
	// condition evaluates to `true`, then this binding applies to the
	// current request. If the condition evaluates to `false`, then this
	// binding does not apply to the current request. However, a different
	// role binding might grant the same role to one or more of the
	// principals in this binding. To learn which resources support
	// conditions in their IAM policies, see the IAM documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	Condition *Expr `json:"condition,omitempty"`

	// Members: Specifies the principals requesting access for a Google
	// Cloud resource. `members` can have the following values: *
	// `allUsers`: A special identifier that represents anyone who is on the
	// internet; with or without a Google account. *
	// `allAuthenticatedUsers`: A special identifier that represents anyone
	// who is authenticated with a Google account or a service account. Does
	// not include identities that come from external identity providers
	// (IdPs) through identity federation. * `user:{emailid}`: An email
	// address that represents a specific Google account. For example,
	// `alice@example.com` . * `serviceAccount:{emailid}`: An email address
	// that represents a Google service account. For example,
	// `my-other-app@appspot.gserviceaccount.com`. *
	// `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`:
	//  An identifier for a Kubernetes service account
	// (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts).
	// For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`.
	// * `group:{emailid}`: An email address that represents a Google group.
	// For example, `admins@example.com`. * `domain:{domain}`: The G Suite
	// domain (primary) that represents all the users of that domain. For
	// example, `google.com` or `example.com`. *
	// `principal://iam.googleapis.com/locations/global/workforcePools/{pool_
	// id}/subject/{subject_attribute_value}`: A single identity in a
	// workforce identity pool. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/group/{group_id}`: All workforce identities in a group. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/attribute.{attribute_name}/{attribute_value}`: All workforce
	// identities with a specific attribute value. *
	// `principalSet://iam.googleapis.com/locations/global/workforcePools/{po
	// ol_id}/*`: All identities in a workforce identity pool. *
	// `principal://iam.googleapis.com/projects/{project_number}/locations/gl
	// obal/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}
	// `: A single identity in a workload identity pool. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations
	// /global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload
	// identity pool group. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations
	// /global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{at
	// tribute_value}`: All identities in a workload identity pool with a
	// certain attribute. *
	// `principalSet://iam.googleapis.com/projects/{project_number}/locations
	// /global/workloadIdentityPools/{pool_id}/*`: All identities in a
	// workload identity pool. * `deleted:user:{emailid}?uid={uniqueid}`: An
	// email address (plus unique identifier) representing a user that has
	// been recently deleted. For example,
	// `alice@example.com?uid=123456789012345678901`. If the user is
	// recovered, this value reverts to `user:{emailid}` and the recovered
	// user retains the role in the binding. *
	// `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address
	// (plus unique identifier) representing a service account that has been
	// recently deleted. For example,
	// `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
	// If the service account is undeleted, this value reverts to
	// `serviceAccount:{emailid}` and the undeleted service account retains
	// the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`:
	// An email address (plus unique identifier) representing a Google group
	// that has been recently deleted. For example,
	// `admins@example.com?uid=123456789012345678901`. If the group is
	// recovered, this value reverts to `group:{emailid}` and the recovered
	// group retains the role in the binding. *
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePool
	// s/{pool_id}/subject/{subject_attribute_value}`: Deleted single
	// identity in a workforce identity pool. For example,
	// `deleted:principal://iam.googleapis.com/locations/global/workforcePool
	// s/my-pool-id/subject/my-subject-attribute-value`.
	Members []string `json:"members,omitempty"`

	// Role: Role that is assigned to the list of `members`, or principals.
	// For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an
	// overview of the IAM roles and permissions, see the IAM documentation
	// (https://cloud.google.com/iam/docs/roles-overview). For a list of the
	// available pre-defined roles, see here
	// (https://cloud.google.com/iam/docs/understanding-roles).
	Role string `json:"role,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Condition") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Condition") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Binding: Associates `members`, or principals, with a `role`.

func (*Binding) MarshalJSON added in v0.25.0

func (s *Binding) MarshalJSON() ([]byte, error)

type BqmlIterationResult added in v0.3.0

type BqmlIterationResult struct {
	// DurationMs: Deprecated.
	DurationMs int64 `json:"durationMs,omitempty,string"`

	// EvalLoss: Deprecated.
	EvalLoss float64 `json:"evalLoss,omitempty"`

	// Index: Deprecated.
	Index int64 `json:"index,omitempty"`

	// LearnRate: Deprecated.
	LearnRate float64 `json:"learnRate,omitempty"`

	// TrainingLoss: Deprecated.
	TrainingLoss float64 `json:"trainingLoss,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DurationMs") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DurationMs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*BqmlIterationResult) MarshalJSON added in v0.3.0

func (s *BqmlIterationResult) MarshalJSON() ([]byte, error)

func (*BqmlIterationResult) UnmarshalJSON added in v0.3.0

func (s *BqmlIterationResult) UnmarshalJSON(data []byte) error

type BqmlTrainingRun added in v0.3.0

type BqmlTrainingRun struct {
	// IterationResults: Deprecated.
	IterationResults []*BqmlIterationResult `json:"iterationResults,omitempty"`

	// StartTime: Deprecated.
	StartTime string `json:"startTime,omitempty"`

	// State: Deprecated.
	State string `json:"state,omitempty"`

	// TrainingOptions: Deprecated.
	TrainingOptions *BqmlTrainingRunTrainingOptions `json:"trainingOptions,omitempty"`

	// ForceSendFields is a list of field names (e.g. "IterationResults") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "IterationResults") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

func (*BqmlTrainingRun) MarshalJSON added in v0.3.0

func (s *BqmlTrainingRun) MarshalJSON() ([]byte, error)

type BqmlTrainingRunTrainingOptions added in v0.3.0

type BqmlTrainingRunTrainingOptions struct {
	EarlyStop bool `json:"earlyStop,omitempty"`

	L1Reg float64 `json:"l1Reg,omitempty"`

	L2Reg float64 `json:"l2Reg,omitempty"`

	LearnRate float64 `json:"learnRate,omitempty"`

	LearnRateStrategy string `json:"learnRateStrategy,omitempty"`

	LineSearchInitLearnRate float64 `json:"lineSearchInitLearnRate,omitempty"`

	MaxIteration int64 `json:"maxIteration,omitempty,string"`

	MinRelProgress float64 `json:"minRelProgress,omitempty"`

	WarmStart bool `json:"warmStart,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EarlyStop") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EarlyStop") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

BqmlTrainingRunTrainingOptions: Deprecated.

func (*BqmlTrainingRunTrainingOptions) MarshalJSON added in v0.3.0

func (s *BqmlTrainingRunTrainingOptions) MarshalJSON() ([]byte, error)

func (*BqmlTrainingRunTrainingOptions) UnmarshalJSON added in v0.3.0

func (s *BqmlTrainingRunTrainingOptions) UnmarshalJSON(data []byte) error

type CategoricalValue added in v0.9.0

type CategoricalValue struct {
	// CategoryCounts: Counts of all categories for the categorical feature.
	// If there are more than ten categories, we return top ten (by count)
	// and return one more CategoryCount with category "_OTHER_" and count
	// as aggregate counts of remaining categories.
	CategoryCounts []*CategoryCount `json:"categoryCounts,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CategoryCounts") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CategoryCounts") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CategoricalValue: Representative value of a categorical feature.

func (*CategoricalValue) MarshalJSON added in v0.9.0

func (s *CategoricalValue) MarshalJSON() ([]byte, error)

type CategoryCount added in v0.9.0

type CategoryCount struct {
	// Category: The name of category.
	Category string `json:"category,omitempty"`

	// Count: The count of training samples matching the category within the
	// cluster.
	Count int64 `json:"count,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Category") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Category") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

CategoryCount: Represents the count of a single category within the cluster.

func (*CategoryCount) MarshalJSON added in v0.9.0

func (s *CategoryCount) MarshalJSON() ([]byte, error)

type CloneDefinition added in v0.72.0

type CloneDefinition struct {
	// BaseTableReference: Required. Reference describing the ID of the
	// table that was cloned.
	BaseTableReference *TableReference `json:"baseTableReference,omitempty"`

	// CloneTime: Required. The time at which the base table was cloned.
	// This value is reported in the JSON response using RFC3339 format.
	CloneTime string `json:"cloneTime,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BaseTableReference")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BaseTableReference") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*CloneDefinition) MarshalJSON added in v0.72.0

func (s *CloneDefinition) MarshalJSON() ([]byte, error)

type Cluster added in v0.9.0

type Cluster struct {
	// CentroidId: Centroid id.
	CentroidId int64 `json:"centroidId,omitempty,string"`

	// Count: Count of training data rows that were assigned to this
	// cluster.
	Count int64 `json:"count,omitempty,string"`

	// FeatureValues: Values of highly variant features for this cluster.
	FeatureValues []*FeatureValue `json:"featureValues,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CentroidId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CentroidId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Cluster: Message containing the information about one cluster.

func (*Cluster) MarshalJSON added in v0.9.0

func (s *Cluster) MarshalJSON() ([]byte, error)

type ClusterInfo added in v0.3.1

type ClusterInfo struct {
	// CentroidId: Centroid id.
	CentroidId int64 `json:"centroidId,omitempty,string"`

	// ClusterRadius: Cluster radius, the average distance from centroid to
	// each point assigned to the cluster.
	ClusterRadius float64 `json:"clusterRadius,omitempty"`

	// ClusterSize: Cluster size, the total number of points assigned to the
	// cluster.
	ClusterSize int64 `json:"clusterSize,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "CentroidId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CentroidId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ClusterInfo: Information about a single cluster for clustering model.

func (*ClusterInfo) MarshalJSON added in v0.3.1

func (s *ClusterInfo) MarshalJSON() ([]byte, error)

func (*ClusterInfo) UnmarshalJSON added in v0.3.1

func (s *ClusterInfo) UnmarshalJSON(data []byte) error

type Clustering

type Clustering struct {
	// Fields: One or more fields on which data should be clustered. Only
	// top-level, non-repeated, simple-type fields are supported. The
	// ordering of the clustering fields should be prioritized from most to
	// least important for filtering purposes. Additional information on
	// limitations can be found here:
	// https://cloud.google.com/bigquery/docs/creating-clustered-tables#limitations
	Fields []string `json:"fields,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Fields") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Clustering: Configures table clustering.

func (*Clustering) MarshalJSON

func (s *Clustering) MarshalJSON() ([]byte, error)

type ClusteringMetrics added in v0.3.1

type ClusteringMetrics struct {
	// Clusters: Information for all clusters.
	Clusters []*Cluster `json:"clusters,omitempty"`

	// DaviesBouldinIndex: Davies-Bouldin index.
	DaviesBouldinIndex float64 `json:"daviesBouldinIndex,omitempty"`

	// MeanSquaredDistance: Mean of squared distances between each sample to
	// its cluster centroid.
	MeanSquaredDistance float64 `json:"meanSquaredDistance,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Clusters") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Clusters") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ClusteringMetrics: Evaluation metrics for clustering models.

func (*ClusteringMetrics) MarshalJSON added in v0.3.1

func (s *ClusteringMetrics) MarshalJSON() ([]byte, error)

func (*ClusteringMetrics) UnmarshalJSON added in v0.3.1

func (s *ClusteringMetrics) UnmarshalJSON(data []byte) error

type ConfusionMatrix added in v0.3.1

type ConfusionMatrix struct {
	// ConfidenceThreshold: Confidence threshold used when computing the
	// entries of the confusion matrix.
	ConfidenceThreshold float64 `json:"confidenceThreshold,omitempty"`

	// Rows: One row per actual label.
	Rows []*Row `json:"rows,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConfidenceThreshold")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConfidenceThreshold") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ConfusionMatrix: Confusion matrix for multi-class classification models.

func (*ConfusionMatrix) MarshalJSON added in v0.3.1

func (s *ConfusionMatrix) MarshalJSON() ([]byte, error)

func (*ConfusionMatrix) UnmarshalJSON added in v0.3.1

func (s *ConfusionMatrix) UnmarshalJSON(data []byte) error

type ConnectionProperty added in v0.23.0

type ConnectionProperty struct {
	// Key: The key of the property to set.
	Key string `json:"key,omitempty"`

	// Value: The value of the property to set.
	Value string `json:"value,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Key") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Key") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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 Additional properties are allowed, but ignored. Specifying multiple connection properties with the same key returns an error.

func (*ConnectionProperty) MarshalJSON added in v0.23.0

func (s *ConnectionProperty) MarshalJSON() ([]byte, error)

type CsvOptions

type CsvOptions struct {
	// AllowJaggedRows: 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.
	AllowJaggedRows bool `json:"allowJaggedRows,omitempty"`

	// AllowQuotedNewlines: Optional. Indicates if BigQuery should allow
	// quoted data sections that contain newline characters in a CSV file.
	// The default value is false.
	AllowQuotedNewlines bool `json:"allowQuotedNewlines,omitempty"`

	// Encoding: Optional. The character encoding of the data. The supported
	// values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and
	// UTF-32LE. 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.
	Encoding string `json:"encoding,omitempty"`

	// FieldDelimiter: Optional. The separator character for fields in a CSV
	// file. The separator is interpreted as a single byte. For files
	// encoded in ISO-8859-1, any single character can be used as a
	// separator. For files encoded in UTF-8, characters represented in
	// decimal range 1-127 (U+0001-U+007F) can be used without any
	// modification. UTF-8 characters encoded with multiple bytes (i.e.
	// U+0080 and above) will have only the first byte used for separating
	// fields. The remaining bytes will be treated as a part of the field.
	// BigQuery also supports the escape sequence "\t" (U+0009) to specify a
	// tab separator. The default value is comma (",", U+002C).
	FieldDelimiter string `json:"fieldDelimiter,omitempty"`

	// NullMarker: [Optional] A custom string that will represent a NULL
	// value in CSV import data.
	NullMarker string `json:"nullMarker,omitempty"`

	// PreserveAsciiControlCharacters: Optional. Indicates if the embedded
	// ASCII control characters (the first 32 characters in the ASCII-table,
	// from '\x00' to '\x1F') are preserved.
	PreserveAsciiControlCharacters bool `json:"preserveAsciiControlCharacters,omitempty"`

	// Quote: 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. To include
	// the specific quote character within a quoted value, precede it with
	// an additional matching quote character. For example, if you want to
	// escape the default character ' " ', use ' "" '.
	//
	// Default: "
	Quote *string `json:"quote,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "AllowJaggedRows") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowJaggedRows") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

CsvOptions: Information related to a CSV data source.

func (*CsvOptions) MarshalJSON

func (s *CsvOptions) MarshalJSON() ([]byte, error)

type DataFormatOptions added in v0.160.0

type DataFormatOptions struct {
	// UseInt64Timestamp: Optional. Output timestamp as usec int64. Default
	// is false.
	UseInt64Timestamp bool `json:"useInt64Timestamp,omitempty"`

	// ForceSendFields is a list of field names (e.g. "UseInt64Timestamp")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "UseInt64Timestamp") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DataFormatOptions: Options for data format adjustments.

func (*DataFormatOptions) MarshalJSON added in v0.160.0

func (s *DataFormatOptions) MarshalJSON() ([]byte, error)

type DataMaskingStatistics added in v0.98.0

type DataMaskingStatistics struct {
	// DataMaskingApplied: Whether any accessed data was protected by the
	// data masking.
	DataMaskingApplied bool `json:"dataMaskingApplied,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DataMaskingApplied")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DataMaskingApplied") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DataMaskingStatistics: Statistics for data-masking.

func (*DataMaskingStatistics) MarshalJSON added in v0.98.0

func (s *DataMaskingStatistics) MarshalJSON() ([]byte, error)

type DataSplitResult added in v0.14.0

type DataSplitResult struct {
	// EvaluationTable: Table reference of the evaluation data after split.
	EvaluationTable *TableReference `json:"evaluationTable,omitempty"`

	// TestTable: Table reference of the test data after split.
	TestTable *TableReference `json:"testTable,omitempty"`

	// TrainingTable: Table reference of the training data after split.
	TrainingTable *TableReference `json:"trainingTable,omitempty"`

	// ForceSendFields is a list of field names (e.g. "EvaluationTable") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EvaluationTable") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*DataSplitResult) MarshalJSON added in v0.14.0

func (s *DataSplitResult) MarshalJSON() ([]byte, error)

type Dataset

type Dataset struct {
	// Access: 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;
	Access []*DatasetAccess `json:"access,omitempty"`

	// CreationTime: Output only. The time when this dataset was created, in
	// milliseconds since the epoch.
	CreationTime int64 `json:"creationTime,omitempty,string"`

	// DatasetReference: Required. A reference that identifies the dataset.
	DatasetReference *DatasetReference `json:"datasetReference,omitempty"`

	// DefaultCollation: 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.
	DefaultCollation string `json:"defaultCollation,omitempty"`

	// DefaultEncryptionConfiguration: 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.
	DefaultEncryptionConfiguration *EncryptionConfiguration `json:"defaultEncryptionConfiguration,omitempty"`

	// DefaultPartitionExpirationMs: 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.
	DefaultPartitionExpirationMs int64 `json:"defaultPartitionExpirationMs,omitempty,string"`

	// DefaultRoundingMode: 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.
	//
	// Possible values:
	//   "ROUNDING_MODE_UNSPECIFIED" - Unspecified will default to using
	// ROUND_HALF_AWAY_FROM_ZERO.
	//   "ROUND_HALF_AWAY_FROM_ZERO" - ROUND_HALF_AWAY_FROM_ZERO rounds half
	// values away from zero when applying precision and scale upon writing
	// of NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 =>
	// 1 1.5, 1.6, 1.7, 1.8, 1.9 => 2
	//   "ROUND_HALF_EVEN" - ROUND_HALF_EVEN rounds half values to the
	// nearest even value when applying precision and scale upon writing of
	// NUMERIC and BIGNUMERIC values. For Scale: 0 1.1, 1.2, 1.3, 1.4 => 1
	// 1.5 => 2 1.6, 1.7, 1.8, 1.9 => 2 2.5 => 2
	DefaultRoundingMode string `json:"defaultRoundingMode,omitempty"`

	// DefaultTableExpirationMs: 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.
	DefaultTableExpirationMs int64 `json:"defaultTableExpirationMs,omitempty,string"`

	// Description: Optional. A user-friendly description of the dataset.
	Description string `json:"description,omitempty"`

	// Etag: Output only. A hash of the resource.
	Etag string `json:"etag,omitempty"`

	// ExternalCatalogDatasetOptions: 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.
	ExternalCatalogDatasetOptions *ExternalCatalogDatasetOptions `json:"externalCatalogDatasetOptions,omitempty"`

	// ExternalDatasetReference: Optional. Reference to a read-only external
	// dataset defined in data catalogs outside of BigQuery. Filled out when
	// the dataset type is EXTERNAL.
	ExternalDatasetReference *ExternalDatasetReference `json:"externalDatasetReference,omitempty"`

	// FriendlyName: Optional. A descriptive name for the dataset.
	FriendlyName string `json:"friendlyName,omitempty"`

	// Id: 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.
	Id string `json:"id,omitempty"`

	// IsCaseInsensitive: 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.
	IsCaseInsensitive bool `json:"isCaseInsensitive,omitempty"`

	// Kind: Output only. The resource type.
	Kind string `json:"kind,omitempty"`

	// Labels: 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.
	Labels map[string]string `json:"labels,omitempty"`

	// LastModifiedTime: Output only. The date when this dataset was last
	// modified, in milliseconds since the epoch.
	LastModifiedTime int64 `json:"lastModifiedTime,omitempty,string"`

	// LinkedDatasetMetadata: Output only. Metadata about the LinkedDataset.
	// Filled out when the dataset type is LINKED.
	LinkedDatasetMetadata *LinkedDatasetMetadata `json:"linkedDatasetMetadata,omitempty"`

	// LinkedDatasetSource: 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.
	LinkedDatasetSource *LinkedDatasetSource `json:"linkedDatasetSource,omitempty"`

	// Location: The geographic location where the dataset should reside.
	// See https://cloud.google.com/bigquery/docs/locations for supported
	// locations.
	Location string `json:"location,omitempty"`

	// MaxTimeTravelHours: 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.
	MaxTimeTravelHours int64 `json:"maxTimeTravelHours,omitempty,string"`

	// SatisfiesPzi: Output only. Reserved for future use.
	SatisfiesPzi bool `json:"satisfiesPzi,omitempty"`

	// SatisfiesPzs: Output only. Reserved for future use.
	SatisfiesPzs bool `json:"satisfiesPzs,omitempty"`

	// SelfLink: 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.
	SelfLink string `json:"selfLink,omitempty"`

	// StorageBillingModel: Optional. Updates storage_billing_model for the
	// dataset.
	//
	// Possible values:
	//   "STORAGE_BILLING_MODEL_UNSPECIFIED" - Value not set.
	//   "LOGICAL" - Billing for logical bytes.
	//   "PHYSICAL" - Billing for physical bytes.
	StorageBillingModel string `json:"storageBillingModel,omitempty"`

	// Tags: Output only. Tags for the Dataset.
	Tags []*DatasetTags `json:"tags,omitempty"`

	// Type: 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. --
	Type string `json:"type,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Access") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Access") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Dataset) MarshalJSON

func (s *Dataset) MarshalJSON() ([]byte, error)

type DatasetAccess

type DatasetAccess struct {
	// Dataset: [Pick one] A grant authorizing all resources of a particular
	// type in a particular dataset access to this dataset. Only views are
	// supported for now. The role field is not required when this field is
	// set. If that dataset is deleted and re-created, its access needs to
	// be granted again via an update operation.
	Dataset *DatasetAccessEntry `json:"dataset,omitempty"`

	// Domain: [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".
	Domain string `json:"domain,omitempty"`

	// GroupByEmail: [Pick one] An email address of a Google Group to grant
	// access to. Maps to IAM policy member "group:GROUP".
	GroupByEmail string `json:"groupByEmail,omitempty"`

	// IamMember: [Pick one] Some other type of member that appears in the
	// IAM Policy but isn't a user, group, domain, or special group.
	IamMember string `json:"iamMember,omitempty"`

	// Role: 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".
	Role string `json:"role,omitempty"`

	// Routine: [Pick one] A routine from a different dataset to grant
	// access to. Queries executed against that routine will have read
	// access to views/tables/routines in this dataset. Only UDF is
	// supported for now. The role field is not required when this field is
	// set. If that routine is updated by any user, access to the routine
	// needs to be granted again via an update operation.
	Routine *RoutineReference `json:"routine,omitempty"`

	// SpecialGroup: [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.
	SpecialGroup string `json:"specialGroup,omitempty"`

	// UserByEmail: [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".
	UserByEmail string `json:"userByEmail,omitempty"`

	// View: [Pick one] A view from a different dataset to grant access to.
	// Queries executed against that view will have read access to
	// views/tables/routines 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.
	View *TableReference `json:"view,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Dataset") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dataset") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DatasetAccess: An object that defines dataset access for an entity.

func (*DatasetAccess) MarshalJSON

func (s *DatasetAccess) MarshalJSON() ([]byte, error)

type DatasetAccessEntry added in v0.41.0

type DatasetAccessEntry struct {
	// Dataset: The dataset this entry applies to
	Dataset *DatasetReference `json:"dataset,omitempty"`

	// TargetTypes: Which resources in the dataset this entry applies to.
	// Currently, only views are supported, but additional target types may
	// be added in the future.
	//
	// Possible values:
	//   "TARGET_TYPE_UNSPECIFIED" - Do not use. You must set a target type
	// explicitly.
	//   "VIEWS" - This entry applies to views in the dataset.
	//   "ROUTINES" - This entry applies to routines in the dataset.
	TargetTypes []string `json:"targetTypes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Dataset") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Dataset") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*DatasetAccessEntry) MarshalJSON added in v0.41.0

func (s *DatasetAccessEntry) MarshalJSON() ([]byte, error)

type DatasetList

type DatasetList struct {
	// Datasets: 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.
	Datasets []*DatasetListDatasets `json:"datasets,omitempty"`

	// Etag: Output only. A hash value of the results page. You can use this
	// property to determine if the page has changed since the last request.
	Etag string `json:"etag,omitempty"`

	// Kind: Output only. The resource type. This property always returns
	// the value "bigquery#datasetList"
	Kind string `json:"kind,omitempty"`

	// NextPageToken: A token that can be used to request the next results
	// page. This property is omitted on the final results page.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Unreachable: A list of skipped locations that were unreachable. For
	// more information about BigQuery locations, see:
	// https://cloud.google.com/bigquery/docs/locations. Example:
	// "europe-west5"
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Datasets") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Datasets") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DatasetList: Response format for a page of results when listing datasets.

func (*DatasetList) MarshalJSON

func (s *DatasetList) MarshalJSON() ([]byte, error)

type DatasetListDatasets

type DatasetListDatasets struct {
	// DatasetReference: The dataset reference. Use this property to access
	// specific parts of the dataset's ID, such as project ID or dataset ID.
	DatasetReference *DatasetReference `json:"datasetReference,omitempty"`

	// FriendlyName: An alternate name for the dataset. The friendly name is
	// purely decorative in nature.
	FriendlyName string `json:"friendlyName,omitempty"`

	// Id: The fully-qualified, unique, opaque ID of the dataset.
	Id string `json:"id,omitempty"`

	// Kind: The resource type. This property always returns the value
	// "bigquery#dataset"
	Kind string `json:"kind,omitempty"`

	// Labels: The labels associated with this dataset. You can use these to
	// organize and group your datasets.
	Labels map[string]string `json:"labels,omitempty"`

	// Location: The geographic location where the dataset resides.
	Location string `json:"location,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DatasetReference") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatasetReference") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*DatasetListDatasets) MarshalJSON

func (s *DatasetListDatasets) MarshalJSON() ([]byte, error)

type DatasetReference

type DatasetReference struct {
	// DatasetId: 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.
	DatasetId string `json:"datasetId,omitempty"`

	// ProjectId: Optional. The ID of the project containing this dataset.
	ProjectId string `json:"projectId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DatasetId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DatasetId") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*DatasetReference) MarshalJSON

func (s *DatasetReference) MarshalJSON() ([]byte, error)

type DatasetTags added in v0.67.0

type DatasetTags struct {
	// TagKey: Required. The namespaced friendly name of the tag key, e.g.
	// "12345/environment" where 12345 is org id.
	TagKey string `json:"tagKey,omitempty"`

	// TagValue: Required. The friendly short name of the tag value, e.g.
	// "production".
	TagValue string `json:"tagValue,omitempty"`

	// ForceSendFields is a list of field names (e.g. "TagKey") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "TagKey") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DatasetTags: A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions

func (*DatasetTags) MarshalJSON added in v0.67.0

func (s *DatasetTags) MarshalJSON() ([]byte, error)

type DatasetsDeleteCall

type DatasetsDeleteCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsDeleteCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsDeleteCall) DeleteContents

func (c *DatasetsDeleteCall) DeleteContents(deleteContents bool) *DatasetsDeleteCall

DeleteContents sets the optional parameter "deleteContents": If True, delete all the tables in the dataset. If False and the dataset contains tables, the request will fail. Default is False

func (*DatasetsDeleteCall) Do

Do executes the "bigquery.datasets.delete" call.

func (*DatasetsDeleteCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsDeleteCall) Header

func (c *DatasetsDeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DatasetsGetCall

type DatasetsGetCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsGetCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsGetCall) DatasetView added in v0.145.0

func (c *DatasetsGetCall) DatasetView(datasetView string) *DatasetsGetCall

DatasetView sets the optional parameter "datasetView": Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.

Possible values:

"DATASET_VIEW_UNSPECIFIED" - The default value. Default to the FULL

view.

"METADATA" - Includes metadata information for the dataset, such as

location, etag, lastModifiedTime, etc.

"ACL" - Includes ACL information for the dataset, which defines

dataset access for one or more entities.

"FULL" - Includes both dataset metadata and ACL information.

func (*DatasetsGetCall) Do

func (c *DatasetsGetCall) Do(opts ...googleapi.CallOption) (*Dataset, error)

Do executes the "bigquery.datasets.get" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsGetCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsGetCall) Header

func (c *DatasetsGetCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DatasetsGetCall) IfNoneMatch

func (c *DatasetsGetCall) IfNoneMatch(entityTag string) *DatasetsGetCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

type DatasetsInsertCall

type DatasetsInsertCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsInsertCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsInsertCall) Do

Do executes the "bigquery.datasets.insert" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsInsertCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsInsertCall) Header

func (c *DatasetsInsertCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DatasetsListCall

type DatasetsListCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsListCall) All

func (c *DatasetsListCall) All(all bool) *DatasetsListCall

All sets the optional parameter "all": Whether to list all datasets, including hidden ones

func (*DatasetsListCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsListCall) Do

Do executes the "bigquery.datasets.list" call. Exactly one of *DatasetList or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *DatasetList.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsListCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsListCall) Filter

func (c *DatasetsListCall) Filter(filter string) *DatasetsListCall

Filter sets the optional parameter "filter": An expression for filtering the results of the request by label. The syntax is \"labels.<name>[:<value>]\". Multiple filters can be ANDed together by connecting with a space. Example: \"labels.department:receiving labels.active\". See Filtering datasets using labels (/bigquery/docs/labeling-datasets#filtering_datasets_using_labels) for details.

func (*DatasetsListCall) Header

func (c *DatasetsListCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

func (*DatasetsListCall) IfNoneMatch

func (c *DatasetsListCall) IfNoneMatch(entityTag string) *DatasetsListCall

IfNoneMatch sets the optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request. Use googleapi.IsNotModified to check whether the response error from Do is the result of In-None-Match.

func (*DatasetsListCall) MaxResults

func (c *DatasetsListCall) MaxResults(maxResults int64) *DatasetsListCall

MaxResults sets the optional parameter "maxResults": The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.

func (*DatasetsListCall) PageToken

func (c *DatasetsListCall) PageToken(pageToken string) *DatasetsListCall

PageToken sets the optional parameter "pageToken": Page token, returned by a previous call, to request the next page of results

func (*DatasetsListCall) Pages

func (c *DatasetsListCall) Pages(ctx context.Context, f func(*DatasetList) error) error

Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.

type DatasetsPatchCall

type DatasetsPatchCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsPatchCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsPatchCall) Do

func (c *DatasetsPatchCall) Do(opts ...googleapi.CallOption) (*Dataset, error)

Do executes the "bigquery.datasets.patch" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsPatchCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsPatchCall) Header

func (c *DatasetsPatchCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DatasetsService

type DatasetsService struct {
	// contains filtered or unexported fields
}

func NewDatasetsService

func NewDatasetsService(s *Service) *DatasetsService

func (*DatasetsService) Delete

func (r *DatasetsService) Delete(projectId string, datasetId string) *DatasetsDeleteCall

Delete: Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name.

- datasetId: Dataset ID of dataset being deleted. - projectId: Project ID of the dataset being deleted.

func (*DatasetsService) Get

func (r *DatasetsService) Get(projectId string, datasetId string) *DatasetsGetCall

Get: Returns the dataset specified by datasetID.

- datasetId: Dataset ID of the requested dataset. - projectId: Project ID of the requested dataset.

func (*DatasetsService) Insert

func (r *DatasetsService) Insert(projectId string, dataset *Dataset) *DatasetsInsertCall

Insert: Creates a new empty dataset.

- projectId: Project ID of the new dataset.

func (*DatasetsService) List

func (r *DatasetsService) List(projectId string) *DatasetsListCall

List: Lists all datasets in the specified project to which the user has been granted the READER dataset role.

- projectId: Project ID of the datasets to be listed.

func (*DatasetsService) Patch

func (r *DatasetsService) Patch(projectId string, datasetId string, dataset *Dataset) *DatasetsPatchCall

Patch: Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics.

- datasetId: Dataset ID of the dataset being updated. - projectId: Project ID of the dataset being updated.

func (*DatasetsService) Undelete added in v0.160.0

func (r *DatasetsService) Undelete(projectId string, datasetId string, undeletedatasetrequest *UndeleteDatasetRequest) *DatasetsUndeleteCall

Undelete: Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted.

- datasetId: Dataset ID of dataset being deleted. - projectId: Project ID of the dataset to be undeleted.

func (*DatasetsService) Update

func (r *DatasetsService) Update(projectId string, datasetId string, dataset *Dataset) *DatasetsUpdateCall

Update: Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource.

- datasetId: Dataset ID of the dataset being updated. - projectId: Project ID of the dataset being updated.

type DatasetsUndeleteCall added in v0.160.0

type DatasetsUndeleteCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsUndeleteCall) Context added in v0.160.0

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsUndeleteCall) Do added in v0.160.0

Do executes the "bigquery.datasets.undelete" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsUndeleteCall) Fields added in v0.160.0

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsUndeleteCall) Header added in v0.160.0

func (c *DatasetsUndeleteCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DatasetsUpdateCall

type DatasetsUpdateCall struct {
	// contains filtered or unexported fields
}

func (*DatasetsUpdateCall) Context

Context sets the context to be used in this call's Do method. Any pending HTTP request will be aborted if the provided context is canceled.

func (*DatasetsUpdateCall) Do

Do executes the "bigquery.datasets.update" call. Exactly one of *Dataset or error will be non-nil. Any non-2xx status code is an error. Response headers are in either *Dataset.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.

func (*DatasetsUpdateCall) Fields

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

func (*DatasetsUpdateCall) Header

func (c *DatasetsUpdateCall) Header() http.Header

Header returns an http.Header that can be modified by the caller to add HTTP headers to the request.

type DestinationTableProperties

type DestinationTableProperties struct {
	// Description: 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.
	Description string `json:"description,omitempty"`

	// ExpirationTime: Internal use only.
	ExpirationTime string `json:"expirationTime,omitempty"`

	// FriendlyName: Optional. Friendly name for the destination table. If
	// the table already exists, it should be same as the existing friendly
	// name.
	FriendlyName string `json:"friendlyName,omitempty"`

	// Labels: 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.
	Labels map[string]string `json:"labels,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DestinationTableProperties: Properties for the destination table.

func (*DestinationTableProperties) MarshalJSON

func (s *DestinationTableProperties) MarshalJSON() ([]byte, error)

type DifferentialPrivacyPolicy added in v0.173.0

type DifferentialPrivacyPolicy struct {
	// DeltaBudget: Optional. The total delta budget for all queries against
	// the privacy-protected view. Each subscriber query against this view
	// charges the amount of delta that is pre-defined by the contributor
	// through the privacy policy delta_per_query field. If there is
	// sufficient budget, then the subscriber query attempts to complete. It
	// might still fail due to other reasons, in which case the charge is
	// refunded. If there is insufficient budget the query is rejected.
	// There might be multiple charge attempts if a single query references
	// multiple views. In this case there must be sufficient budget for all
	// charges or the query is rejected and charges are refunded in best
	// effort. The budget does not have a refresh policy and can only be
	// updated via ALTER VIEW or circumvented by creating a new view that
	// can be queried with a fresh budget.
	DeltaBudget float64 `json:"deltaBudget,omitempty"`

	// DeltaPerQuery: Optional. The delta value that is used per query.
	// Delta represents the probability that any row will fail to be epsilon
	// differentially private. Indicates the risk associated with exposing
	// aggregate rows in the result of a query.
	DeltaPerQuery float64 `json:"deltaPerQuery,omitempty"`

	// EpsilonBudget: Optional. The total epsilon budget for all queries
	// against the privacy-protected view. Each subscriber query against
	// this view charges the amount of epsilon they request in their query.
	// If there is sufficient budget, then the subscriber query attempts to
	// complete. It might still fail due to other reasons, in which case the
	// charge is refunded. If there is insufficient budget the query is
	// rejected. There might be multiple charge attempts if a single query
	// references multiple views. In this case there must be sufficient
	// budget for all charges or the query is rejected and charges are
	// refunded in best effort. The budget does not have a refresh policy
	// and can only be updated via ALTER VIEW or circumvented by creating a
	// new view that can be queried with a fresh budget.
	EpsilonBudget float64 `json:"epsilonBudget,omitempty"`

	// MaxEpsilonPerQuery: Optional. The maximum epsilon value that a query
	// can consume. If the subscriber specifies epsilon as a parameter in a
	// SELECT query, it must be less than or equal to this value. The
	// epsilon parameter controls the amount of noise that is added to the
	// groups — a higher epsilon means less noise.
	MaxEpsilonPerQuery float64 `json:"maxEpsilonPerQuery,omitempty"`

	// MaxGroupsContributed: Optional. The maximum groups contributed value
	// that is used per query. Represents the maximum number of groups to
	// which each protected entity can contribute. Changing this value does
	// not improve or worsen privacy. The best value for accuracy and
	// utility depends on the query and data.
	MaxGroupsContributed int64 `json:"maxGroupsContributed,omitempty,string"`

	// PrivacyUnitColumn: Optional. The privacy unit column associated with
	// this policy. Differential privacy policies can only have one privacy
	// unit column per data source object (table, view).
	PrivacyUnitColumn string `json:"privacyUnitColumn,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DeltaBudget") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeltaBudget") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DifferentialPrivacyPolicy: Represents privacy policy associated with "differential privacy" method.

func (*DifferentialPrivacyPolicy) MarshalJSON added in v0.173.0

func (s *DifferentialPrivacyPolicy) MarshalJSON() ([]byte, error)

func (*DifferentialPrivacyPolicy) UnmarshalJSON added in v0.173.0

func (s *DifferentialPrivacyPolicy) UnmarshalJSON(data []byte) error

type DimensionalityReductionMetrics added in v0.37.0

type DimensionalityReductionMetrics struct {
	// TotalExplainedVarianceRatio: Total percentage of variance explained
	// by the selected principal components.
	TotalExplainedVarianceRatio float64 `json:"totalExplainedVarianceRatio,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "TotalExplainedVarianceRatio") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "TotalExplainedVarianceRatio") to include in API requests with the
	// JSON null value. By default, fields with empty values are omitted
	// from API requests. However, any field with an empty value appearing
	// in NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

DimensionalityReductionMetrics: Model evaluation metrics for dimensionality reduction models.

func (*DimensionalityReductionMetrics) MarshalJSON added in v0.37.0

func (s *DimensionalityReductionMetrics) MarshalJSON() ([]byte, error)

func (*DimensionalityReductionMetrics) UnmarshalJSON added in v0.37.0

func (s *DimensionalityReductionMetrics) UnmarshalJSON(data []byte) error

type DmlStatistics added in v0.50.0

type DmlStatistics struct {
	// DeletedRowCount: Output only. Number of deleted Rows. populated by
	// DML DELETE, MERGE and TRUNCATE statements.
	DeletedRowCount int64 `json:"deletedRowCount,omitempty,string"`

	// InsertedRowCount: Output only. Number of inserted Rows. Populated by
	// DML INSERT and MERGE statements
	InsertedRowCount int64 `json:"insertedRowCount,omitempty,string"`

	// UpdatedRowCount: Output only. Number of updated Rows. Populated by
	// DML UPDATE and MERGE statements.
	UpdatedRowCount int64 `json:"updatedRowCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "DeletedRowCount") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DeletedRowCount") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

DmlStatistics: Detailed statistics for DML statements

func (*DmlStatistics) MarshalJSON added in v0.50.0

func (s *DmlStatistics) MarshalJSON() ([]byte, error)

type DoubleCandidates added in v0.72.0

type DoubleCandidates struct {
	// Candidates: Candidates for the double parameter in increasing order.
	Candidates []float64 `json:"candidates,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Candidates") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Candidates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DoubleCandidates: Discrete candidates of a double hyperparameter.

func (*DoubleCandidates) MarshalJSON added in v0.72.0

func (s *DoubleCandidates) MarshalJSON() ([]byte, error)

func (*DoubleCandidates) UnmarshalJSON added in v0.122.0

func (s *DoubleCandidates) UnmarshalJSON(data []byte) error

type DoubleHparamSearchSpace added in v0.72.0

type DoubleHparamSearchSpace struct {
	// Candidates: Candidates of the double hyperparameter.
	Candidates *DoubleCandidates `json:"candidates,omitempty"`

	// Range: Range of the double hyperparameter.
	Range *DoubleRange `json:"range,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Candidates") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Candidates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DoubleHparamSearchSpace: Search space for a double hyperparameter.

func (*DoubleHparamSearchSpace) MarshalJSON added in v0.72.0

func (s *DoubleHparamSearchSpace) MarshalJSON() ([]byte, error)

type DoubleRange added in v0.72.0

type DoubleRange struct {
	// Max: Max value of the double parameter.
	Max float64 `json:"max,omitempty"`

	// Min: Min value of the double parameter.
	Min float64 `json:"min,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Max") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Max") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

DoubleRange: Range of a double hyperparameter.

func (*DoubleRange) MarshalJSON added in v0.72.0

func (s *DoubleRange) MarshalJSON() ([]byte, error)

func (*DoubleRange) UnmarshalJSON added in v0.72.0

func (s *DoubleRange) UnmarshalJSON(data []byte) error

type EncryptionConfiguration

type EncryptionConfiguration struct {
	// KmsKeyName: 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.
	KmsKeyName string `json:"kmsKeyName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "KmsKeyName") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "KmsKeyName") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*EncryptionConfiguration) MarshalJSON

func (s *EncryptionConfiguration) MarshalJSON() ([]byte, error)

type Entry added in v0.3.1

type Entry struct {
	// ItemCount: Number of items being predicted as this label.
	ItemCount int64 `json:"itemCount,omitempty,string"`

	// PredictedLabel: The predicted label. For confidence_threshold > 0, we
	// will also add an entry indicating the number of items under the
	// confidence threshold.
	PredictedLabel string `json:"predictedLabel,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ItemCount") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ItemCount") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Entry: A single entry in the confusion matrix.

func (*Entry) MarshalJSON added in v0.3.1

func (s *Entry) MarshalJSON() ([]byte, error)

type ErrorProto

type ErrorProto struct {
	// DebugInfo: Debugging information. This property is internal to Google
	// and should not be used.
	DebugInfo string `json:"debugInfo,omitempty"`

	// Location: Specifies where the error occurred, if present.
	Location string `json:"location,omitempty"`

	// Message: A human-readable description of the error.
	Message string `json:"message,omitempty"`

	// Reason: A short error code that summarizes the error.
	Reason string `json:"reason,omitempty"`

	// ForceSendFields is a list of field names (e.g. "DebugInfo") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "DebugInfo") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ErrorProto: Error details.

func (*ErrorProto) MarshalJSON

func (s *ErrorProto) MarshalJSON() ([]byte, error)

type EvaluationMetrics added in v0.3.1

type EvaluationMetrics struct {
	// ArimaForecastingMetrics: Populated for ARIMA models.
	ArimaForecastingMetrics *ArimaForecastingMetrics `json:"arimaForecastingMetrics,omitempty"`

	// BinaryClassificationMetrics: Populated for binary
	// classification/classifier models.
	BinaryClassificationMetrics *BinaryClassificationMetrics `json:"binaryClassificationMetrics,omitempty"`

	// ClusteringMetrics: Populated for clustering models.
	ClusteringMetrics *ClusteringMetrics `json:"clusteringMetrics,omitempty"`

	// DimensionalityReductionMetrics: Evaluation metrics when the model is
	// a dimensionality reduction model, which currently includes PCA.
	DimensionalityReductionMetrics *DimensionalityReductionMetrics `json:"dimensionalityReductionMetrics,omitempty"`

	// MultiClassClassificationMetrics: Populated for multi-class
	// classification/classifier models.
	MultiClassClassificationMetrics *MultiClassClassificationMetrics `json:"multiClassClassificationMetrics,omitempty"`

	// RankingMetrics: Populated for implicit feedback type matrix
	// factorization models.
	RankingMetrics *RankingMetrics `json:"rankingMetrics,omitempty"`

	// RegressionMetrics: Populated for regression models and explicit
	// feedback type matrix factorization models.
	RegressionMetrics *RegressionMetrics `json:"regressionMetrics,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "ArimaForecastingMetrics") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaForecastingMetrics")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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.

func (*EvaluationMetrics) MarshalJSON added in v0.3.1

func (s *EvaluationMetrics) MarshalJSON() ([]byte, error)

type ExplainQueryStage

type ExplainQueryStage struct {
	// CompletedParallelInputs: Number of parallel input segments completed.
	CompletedParallelInputs int64 `json:"completedParallelInputs,omitempty,string"`

	// ComputeMode: Output only. Compute mode for this stage.
	//
	// Possible values:
	//   "COMPUTE_MODE_UNSPECIFIED" - ComputeMode type not specified.
	//   "BIGQUERY" - This stage was processed using BigQuery slots.
	//   "BI_ENGINE" - This stage was processed using BI Engine compute.
	ComputeMode string `json:"computeMode,omitempty"`

	// ComputeMsAvg: Milliseconds the average shard spent on CPU-bound
	// tasks.
	ComputeMsAvg int64 `json:"computeMsAvg,omitempty,string"`

	// ComputeMsMax: Milliseconds the slowest shard spent on CPU-bound
	// tasks.
	ComputeMsMax int64 `json:"computeMsMax,omitempty,string"`

	// ComputeRatioAvg: Relative amount of time the average shard spent on
	// CPU-bound tasks.
	ComputeRatioAvg float64 `json:"computeRatioAvg,omitempty"`

	// ComputeRatioMax: Relative amount of time the slowest shard spent on
	// CPU-bound tasks.
	ComputeRatioMax float64 `json:"computeRatioMax,omitempty"`

	// EndMs: Stage end time represented as milliseconds since the epoch.
	EndMs int64 `json:"endMs,omitempty,string"`

	// Id: Unique ID for the stage within the plan.
	Id int64 `json:"id,omitempty,string"`

	// InputStages: IDs for stages that are inputs to this stage.
	InputStages googleapi.Int64s `json:"inputStages,omitempty"`

	// Name: Human-readable name for the stage.
	Name string `json:"name,omitempty"`

	// ParallelInputs: Number of parallel input segments to be processed
	ParallelInputs int64 `json:"parallelInputs,omitempty,string"`

	// ReadMsAvg: Milliseconds the average shard spent reading input.
	ReadMsAvg int64 `json:"readMsAvg,omitempty,string"`

	// ReadMsMax: Milliseconds the slowest shard spent reading input.
	ReadMsMax int64 `json:"readMsMax,omitempty,string"`

	// ReadRatioAvg: Relative amount of time the average shard spent reading
	// input.
	ReadRatioAvg float64 `json:"readRatioAvg,omitempty"`

	// ReadRatioMax: Relative amount of time the slowest shard spent reading
	// input.
	ReadRatioMax float64 `json:"readRatioMax,omitempty"`

	// RecordsRead: Number of records read into the stage.
	RecordsRead int64 `json:"recordsRead,omitempty,string"`

	// RecordsWritten: Number of records written by the stage.
	RecordsWritten int64 `json:"recordsWritten,omitempty,string"`

	// ShuffleOutputBytes: Total number of bytes written to shuffle.
	ShuffleOutputBytes int64 `json:"shuffleOutputBytes,omitempty,string"`

	// ShuffleOutputBytesSpilled: Total number of bytes written to shuffle
	// and spilled to disk.
	ShuffleOutputBytesSpilled int64 `json:"shuffleOutputBytesSpilled,omitempty,string"`

	// SlotMs: Slot-milliseconds used by the stage.
	SlotMs int64 `json:"slotMs,omitempty,string"`

	// StartMs: Stage start time represented as milliseconds since the
	// epoch.
	StartMs int64 `json:"startMs,omitempty,string"`

	// Status: Current status for this stage.
	Status string `json:"status,omitempty"`

	// Steps: List of operations within the stage in dependency order
	// (approximately chronological).
	Steps []*ExplainQueryStep `json:"steps,omitempty"`

	// WaitMsAvg: Milliseconds the average shard spent waiting to be
	// scheduled.
	WaitMsAvg int64 `json:"waitMsAvg,omitempty,string"`

	// WaitMsMax: Milliseconds the slowest shard spent waiting to be
	// scheduled.
	WaitMsMax int64 `json:"waitMsMax,omitempty,string"`

	// WaitRatioAvg: Relative amount of time the average shard spent waiting
	// to be scheduled.
	WaitRatioAvg float64 `json:"waitRatioAvg,omitempty"`

	// WaitRatioMax: Relative amount of time the slowest shard spent waiting
	// to be scheduled.
	WaitRatioMax float64 `json:"waitRatioMax,omitempty"`

	// WriteMsAvg: Milliseconds the average shard spent on writing output.
	WriteMsAvg int64 `json:"writeMsAvg,omitempty,string"`

	// WriteMsMax: Milliseconds the slowest shard spent on writing output.
	WriteMsMax int64 `json:"writeMsMax,omitempty,string"`

	// WriteRatioAvg: Relative amount of time the average shard spent on
	// writing output.
	WriteRatioAvg float64 `json:"writeRatioAvg,omitempty"`

	// WriteRatioMax: Relative amount of time the slowest shard spent on
	// writing output.
	WriteRatioMax float64 `json:"writeRatioMax,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "CompletedParallelInputs") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CompletedParallelInputs")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

ExplainQueryStage: A single stage of query execution.

func (*ExplainQueryStage) MarshalJSON

func (s *ExplainQueryStage) MarshalJSON() ([]byte, error)

func (*ExplainQueryStage) UnmarshalJSON

func (s *ExplainQueryStage) UnmarshalJSON(data []byte) error

type ExplainQueryStep

type ExplainQueryStep struct {
	// Kind: Machine-readable operation type.
	Kind string `json:"kind,omitempty"`

	// Substeps: Human-readable description of the step(s).
	Substeps []string `json:"substeps,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Kind") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Kind") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

ExplainQueryStep: An operation within a stage.

func (*ExplainQueryStep) MarshalJSON

func (s *ExplainQueryStep) MarshalJSON() ([]byte, error)

type Explanation added in v0.34.0

type Explanation struct {
	// Attribution: Attribution of feature.
	Attribution float64 `json:"attribution,omitempty"`

	// FeatureName: The full feature name. For non-numerical features, will
	// be formatted like `.`. Overall size of feature name will always be
	// truncated to first 120 characters.
	FeatureName string `json:"featureName,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Attribution") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Attribution") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

Explanation: Explanation for a single feature.

func (*Explanation) MarshalJSON added in v0.34.0

func (s *Explanation) MarshalJSON() ([]byte, error)

func (*Explanation) UnmarshalJSON added in v0.34.0

func (s *Explanation) UnmarshalJSON(data []byte) error

type ExportDataStatistics added in v0.160.0

type ExportDataStatistics struct {
	// FileCount: Number of destination files generated in case of EXPORT
	// DATA statement only.
	FileCount int64 `json:"fileCount,omitempty,string"`

	// RowCount: [Alpha] Number of destination rows generated in case of
	// EXPORT DATA statement only.
	RowCount int64 `json:"rowCount,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "FileCount") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "FileCount") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ExportDataStatistics) MarshalJSON added in v0.160.0

func (s *ExportDataStatistics) MarshalJSON() ([]byte, error)

type Expr added in v0.25.0

type Expr struct {
	// Description: Optional. Description of the expression. This is a
	// longer text which describes the expression, e.g. when hovered over it
	// in a UI.
	Description string `json:"description,omitempty"`

	// Expression: Textual representation of an expression in Common
	// Expression Language syntax.
	Expression string `json:"expression,omitempty"`

	// Location: Optional. String indicating the location of the expression
	// for error reporting, e.g. a file name and a position in the file.
	Location string `json:"location,omitempty"`

	// Title: Optional. Title for the expression, i.e. a short string
	// describing its purpose. This can be used e.g. in UIs which allow to
	// enter the expression.
	Title string `json:"title,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Description") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Description") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*Expr) MarshalJSON added in v0.25.0

func (s *Expr) MarshalJSON() ([]byte, error)

type ExternalCatalogDatasetOptions added in v0.173.0

type ExternalCatalogDatasetOptions struct {
	// DefaultStorageLocationUri: Optional. The storage location URI for all
	// tables in the dataset. Equivalent to hive metastore's database
	// locationUri. Maximum length of 1024 characters.
	DefaultStorageLocationUri string `json:"defaultStorageLocationUri,omitempty"`

	// Parameters: Optional. A map of key value pairs defining the
	// parameters and properties of the open source schema. Maximum size of
	// 2Mib.
	Parameters map[string]string `json:"parameters,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "DefaultStorageLocationUri") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "DefaultStorageLocationUri") to include in API requests with the JSON
	// null value. By default, fields with empty values are omitted from API
	// requests. However, any field with an empty value appearing in
	// NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*ExternalCatalogDatasetOptions) MarshalJSON added in v0.173.0

func (s *ExternalCatalogDatasetOptions) MarshalJSON() ([]byte, error)

type ExternalCatalogTableOptions added in v0.173.0

type ExternalCatalogTableOptions struct {
	// ConnectionId: Optional. The connection specifying the credentials to
	// be used to read external storage, such as Azure Blob, Cloud Storage,
	// or S3. The connection is needed to read the open source table from
	// BigQuery Engine. The connection_id can have the form `..` or
	// `projects//locations//connections/`.
	ConnectionId string `json:"connectionId,omitempty"`

	// Parameters: Optional. A map of key value pairs defining the
	// parameters and properties of the open source table. Corresponds with
	// hive meta store table parameters. Maximum size of 4Mib.
	Parameters map[string]string `json:"parameters,omitempty"`

	// StorageDescriptor: Optional. A storage descriptor containing
	// information about the physical storage of this table.
	StorageDescriptor *StorageDescriptor `json:"storageDescriptor,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ConnectionId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ConnectionId") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ExternalCatalogTableOptions) MarshalJSON added in v0.173.0

func (s *ExternalCatalogTableOptions) MarshalJSON() ([]byte, error)

type ExternalDataConfiguration

type ExternalDataConfiguration struct {
	// Autodetect: Try to detect schema and format options automatically.
	// Any option specified explicitly will be honored.
	Autodetect bool `json:"autodetect,omitempty"`

	// AvroOptions: Optional. Additional properties to set if sourceFormat
	// is set to AVRO.
	AvroOptions *AvroOptions `json:"avroOptions,omitempty"`

	// BigtableOptions: Optional. Additional options if sourceFormat is set
	// to BIGTABLE.
	BigtableOptions *BigtableOptions `json:"bigtableOptions,omitempty"`

	// Compression: 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.
	Compression string `json:"compression,omitempty"`

	// ConnectionId: 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/<connecti
	// on\_id>".
	ConnectionId string `json:"connectionId,omitempty"`

	// CsvOptions: Optional. Additional properties to set if sourceFormat is
	// set to CSV.
	CsvOptions *CsvOptions `json:"csvOptions,omitempty"`

	// DecimalTargetTypes: 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.
	//
	// Possible values:
	//   "DECIMAL_TARGET_TYPE_UNSPECIFIED" - Invalid type.
	//   "NUMERIC" - Decimal values could be converted to NUMERIC type.
	//   "BIGNUMERIC" - Decimal values could be converted to BIGNUMERIC
	// type.
	//   "STRING" - Decimal values could be converted to STRING type.
	DecimalTargetTypes []string `json:"decimalTargetTypes,omitempty"`

	// FileSetSpecType: 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.
	//
	// Possible values:
	//   "FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH" - This option expands source
	// URIs by listing files from the object store. It is the default
	// behavior if FileSetSpecType is not set.
	//   "FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST" - This option
	// indicates that the provided URIs are newline-delimited manifest
	// files, with one URI per line. Wildcard URIs are not supported.
	FileSetSpecType string `json:"fileSetSpecType,omitempty"`

	// GoogleSheetsOptions: Optional. Additional options if sourceFormat is
	// set to GOOGLE_SHEETS.
	GoogleSheetsOptions *GoogleSheetsOptions `json:"googleSheetsOptions,omitempty"`

	// HivePartitioningOptions: 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.
	HivePartitioningOptions *HivePartitioningOptions `json:"hivePartitioningOptions,omitempty"`

	// IgnoreUnknownValues: 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.
	IgnoreUnknownValues bool `json:"ignoreUnknownValues,omitempty"`

	// JsonExtension: 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).
	//
	// Possible values:
	//   "JSON_EXTENSION_UNSPECIFIED" - The default if provided value is not
	// one included in the enum, or the value is not specified. The source
	// formate is parsed without any modification.
	//   "GEOJSON" - Use GeoJSON variant of JSON. See
	// https://tools.ietf.org/html/rfc7946.
	JsonExtension string `json:"jsonExtension,omitempty"`

	// JsonOptions: Optional. Additional properties to set if sourceFormat
	// is set to JSON.
	JsonOptions *JsonOptions `json:"jsonOptions,omitempty"`

	// MaxBadRecords: 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.
	MaxBadRecords int64 `json:"maxBadRecords,omitempty"`

	// MetadataCacheMode: Optional. Metadata Cache Mode for the table. Set
	// this to enable caching of metadata from external data source.
	//
	// Possible values:
	//   "METADATA_CACHE_MODE_UNSPECIFIED" - Unspecified metadata cache
	// mode.
	//   "AUTOMATIC" - Set this mode to trigger automatic background refresh
	// of metadata cache from the external source. Queries will use the
	// latest available cache version within the table's maxStaleness
	// interval.
	//   "MANUAL" - Set this mode to enable triggering manual refresh of the
	// metadata cache from external source. Queries will use the latest
	// manually triggered cache version within the table's maxStaleness
	// interval.
	MetadataCacheMode string `json:"metadataCacheMode,omitempty"`

	// ObjectMetadata: 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.
	//
	// Possible values:
	//   "OBJECT_METADATA_UNSPECIFIED" - Unspecified by default.
	//   "DIRECTORY" - A synonym for `SIMPLE`.
	//   "SIMPLE" - Directory listing of objects.
	ObjectMetadata string `json:"objectMetadata,omitempty"`

	// ParquetOptions: Optional. Additional properties to set if
	// sourceFormat is set to PARQUET.
	ParquetOptions *ParquetOptions `json:"parquetOptions,omitempty"`

	// ReferenceFileSchemaUri: 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.
	ReferenceFileSchemaUri string `json:"referenceFileSchemaUri,omitempty"`

	// Schema: 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.
	Schema *TableSchema `json:"schema,omitempty"`

	// SourceFormat: [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".
	SourceFormat string `json:"sourceFormat,omitempty"`

	// SourceUris: [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.
	SourceUris []string `json:"sourceUris,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Autodetect") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Autodetect") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*ExternalDataConfiguration) MarshalJSON

func (s *ExternalDataConfiguration) MarshalJSON() ([]byte, error)

type ExternalDatasetReference added in v0.139.0

type ExternalDatasetReference struct {
	// Connection: Required. The connection id that is used to access the
	// external_source. Format:
	// projects/{project_id}/locations/{location_id}/connections/{connection_
	// id}
	Connection string `json:"connection,omitempty"`

	// ExternalSource: Required. External source that backs this dataset.
	ExternalSource string `json:"externalSource,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Connection") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Connection") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*ExternalDatasetReference) MarshalJSON added in v0.139.0

func (s *ExternalDatasetReference) MarshalJSON() ([]byte, error)

type ExternalServiceCost added in v0.160.0

type ExternalServiceCost struct {
	// BytesBilled: External service cost in terms of bigquery bytes billed.
	BytesBilled int64 `json:"bytesBilled,omitempty,string"`

	// BytesProcessed: External service cost in terms of bigquery bytes
	// processed.
	BytesProcessed int64 `json:"bytesProcessed,omitempty,string"`

	// ExternalService: External service name.
	ExternalService string `json:"externalService,omitempty"`

	// ReservedSlotCount: Non-preemptable reserved slots used for external
	// job. For example, reserved slots for Cloua AI Platform job are the VM
	// usages converted to BigQuery slot with equivalent mount of price.
	ReservedSlotCount int64 `json:"reservedSlotCount,omitempty,string"`

	// SlotMs: External service cost in terms of bigquery slot milliseconds.
	SlotMs int64 `json:"slotMs,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "BytesBilled") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BytesBilled") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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.

func (*ExternalServiceCost) MarshalJSON added in v0.160.0

func (s *ExternalServiceCost) MarshalJSON() ([]byte, error)

type FeatureValue added in v0.9.0

type FeatureValue struct {
	// CategoricalValue: The categorical feature value.
	CategoricalValue *CategoricalValue `json:"categoricalValue,omitempty"`

	// FeatureColumn: The feature column name.
	FeatureColumn string `json:"featureColumn,omitempty"`

	// NumericalValue: The numerical feature value. This is the centroid
	// value for this feature.
	NumericalValue float64 `json:"numericalValue,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CategoricalValue") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CategoricalValue") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

FeatureValue: Representative value of a single feature within the cluster.

func (*FeatureValue) MarshalJSON added in v0.9.0

func (s *FeatureValue) MarshalJSON() ([]byte, error)

func (*FeatureValue) UnmarshalJSON added in v0.9.0

func (s *FeatureValue) UnmarshalJSON(data []byte) error

type GetIamPolicyRequest added in v0.25.0

type GetIamPolicyRequest struct {
	// Options: OPTIONAL: A `GetPolicyOptions` object for specifying options
	// to `GetIamPolicy`.
	Options *GetPolicyOptions `json:"options,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Options") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Options") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetIamPolicyRequest: Request message for `GetIamPolicy` method.

func (*GetIamPolicyRequest) MarshalJSON added in v0.25.0

func (s *GetIamPolicyRequest) MarshalJSON() ([]byte, error)

type GetPolicyOptions added in v0.25.0

type GetPolicyOptions struct {
	// RequestedPolicyVersion: Optional. The maximum policy version that
	// will be used to format the policy. Valid values are 0, 1, and 3.
	// Requests specifying an invalid value will be rejected. Requests for
	// policies with any conditional role bindings must specify version 3.
	// Policies with no conditional role bindings may specify any valid
	// value or leave the field unset. The policy in the response might use
	// the policy version that you specified, or it might use a lower policy
	// version. For example, if you specify version 3, but the policy has no
	// conditional role bindings, the response uses version 1. To learn
	// which resources support conditions in their IAM policies, see the IAM
	// documentation
	// (https://cloud.google.com/iam/help/conditions/resource-policies).
	RequestedPolicyVersion int64 `json:"requestedPolicyVersion,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "RequestedPolicyVersion") to unconditionally include in API requests.
	// By default, fields with empty or default values are omitted from API
	// requests. However, any non-pointer, non-interface field appearing in
	// ForceSendFields will be sent to the server regardless of whether the
	// field is empty or not. This may be used to include empty fields in
	// Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "RequestedPolicyVersion")
	// to include in API requests with the JSON null value. By default,
	// fields with empty values are omitted from API requests. However, any
	// field with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

GetPolicyOptions: Encapsulates settings provided to GetIamPolicy.

func (*GetPolicyOptions) MarshalJSON added in v0.25.0

func (s *GetPolicyOptions) MarshalJSON() ([]byte, error)

type GetQueryResultsResponse

type GetQueryResultsResponse struct {
	// CacheHit: Whether the query result was fetched from the query cache.
	CacheHit bool `json:"cacheHit,omitempty"`

	// Errors: 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
	// (https://cloud.google.com/bigquery/docs/error-messages).
	Errors []*ErrorProto `json:"errors,omitempty"`

	// Etag: A hash of this response.
	Etag string `json:"etag,omitempty"`

	// JobComplete: 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.
	JobComplete bool `json:"jobComplete,omitempty"`

	// JobReference: 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).
	JobReference *JobReference `json:"jobReference,omitempty"`

	// Kind: The resource type of the response.
	Kind string `json:"kind,omitempty"`

	// NumDmlAffectedRows: Output only. The number of rows affected by a DML
	// statement. Present only for DML statements INSERT, UPDATE or DELETE.
	NumDmlAffectedRows int64 `json:"numDmlAffectedRows,omitempty,string"`

	// PageToken: A token used for paging results. When this token is
	// non-empty, it indicates additional results are available.
	PageToken string `json:"pageToken,omitempty"`

	// Rows: 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. The REST-based
	// representation of this data leverages a series of JSON f,v objects
	// for indicating fields and values.
	Rows []*TableRow `json:"rows,omitempty"`

	// Schema: The schema of the results. Present only when the query
	// completes successfully.
	Schema *TableSchema `json:"schema,omitempty"`

	// TotalBytesProcessed: The total number of bytes processed for this
	// query.
	TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`

	// TotalRows: 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.
	TotalRows uint64 `json:"totalRows,omitempty,string"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "CacheHit") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CacheHit") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetQueryResultsResponse: Response object of GetQueryResults.

func (*GetQueryResultsResponse) MarshalJSON

func (s *GetQueryResultsResponse) MarshalJSON() ([]byte, error)

type GetServiceAccountResponse

type GetServiceAccountResponse struct {
	// Email: The service account email address.
	Email string `json:"email,omitempty"`

	// Kind: The resource type of the response.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Email") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Email") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GetServiceAccountResponse: Response object of GetServiceAccount

func (*GetServiceAccountResponse) MarshalJSON

func (s *GetServiceAccountResponse) MarshalJSON() ([]byte, error)

type GlobalExplanation added in v0.34.0

type GlobalExplanation struct {
	// ClassLabel: Class label for this set of global explanations. Will be
	// empty/null for binary logistic and linear regression models. Sorted
	// alphabetically in descending order.
	ClassLabel string `json:"classLabel,omitempty"`

	// Explanations: A list of the top global explanations. Sorted by
	// absolute value of attribution in descending order.
	Explanations []*Explanation `json:"explanations,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ClassLabel") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ClassLabel") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GlobalExplanation: Global explanations containing the top most important features after training.

func (*GlobalExplanation) MarshalJSON added in v0.34.0

func (s *GlobalExplanation) MarshalJSON() ([]byte, error)

type GoogleSheetsOptions

type GoogleSheetsOptions struct {
	// Range: 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
	Range string `json:"range,omitempty"`

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

	// ForceSendFields is a list of field names (e.g. "Range") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Range") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

GoogleSheetsOptions: Options specific to Google Sheets data sources.

func (*GoogleSheetsOptions) MarshalJSON

func (s *GoogleSheetsOptions) MarshalJSON() ([]byte, error)

type HighCardinalityJoin added in v0.160.0

type HighCardinalityJoin struct {
	// LeftRows: Output only. Count of left input rows.
	LeftRows int64 `json:"leftRows,omitempty,string"`

	// OutputRows: Output only. Count of the output rows.
	OutputRows int64 `json:"outputRows,omitempty,string"`

	// RightRows: Output only. Count of right input rows.
	RightRows int64 `json:"rightRows,omitempty,string"`

	// StepIndex: Output only. The index of the join operator in the
	// ExplainQueryStep lists.
	StepIndex int64 `json:"stepIndex,omitempty"`

	// ForceSendFields is a list of field names (e.g. "LeftRows") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "LeftRows") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HighCardinalityJoin: High cardinality join detailed information.

func (*HighCardinalityJoin) MarshalJSON added in v0.160.0

func (s *HighCardinalityJoin) MarshalJSON() ([]byte, error)

type HivePartitioningOptions added in v0.7.0

type HivePartitioningOptions struct {
	// Fields: Output only. For permanent external tables, this field is
	// populated with the hive partition keys in the order they were
	// inferred. The types of the partition keys can be deduced by checking
	// the table schema (which will include the partition keys). Not every
	// API will populate this field in the output. For example, Tables.Get
	// will populate it, but Tables.List will not contain this field.
	Fields []string `json:"fields,omitempty"`

	// Mode: Optional. When set, what mode of hive partitioning to use when
	// reading data. The following modes are supported: * AUTO:
	// automatically infer partition key name(s) and type(s). * STRINGS:
	// automatically infer partition key name(s). All types are strings. *
	// CUSTOM: partition key schema is encoded in the source URI prefix. Not
	// all storage formats support hive partitioning. Requesting hive
	// partitioning on an unsupported format will lead to an error.
	// Currently supported formats are: JSON, CSV, ORC, Avro and Parquet.
	Mode string `json:"mode,omitempty"`

	// RequirePartitionFilter: Optional. If set to true, queries over this
	// table require a partition filter that can be used for partition
	// elimination to be specified. Note that this field should only be true
	// when creating a permanent external table or querying a temporary
	// external table. Hive-partitioned loads with require_partition_filter
	// explicitly set to true will fail.
	RequirePartitionFilter bool `json:"requirePartitionFilter,omitempty"`

	// SourceUriPrefix: Optional. When hive partition detection is
	// requested, a common prefix for all source uris must be required. The
	// prefix must end immediately before the partition key encoding begins.
	// For example, consider files following this data layout:
	// gs://bucket/path_to_table/dt=2019-06-01/country=USA/id=7/file.avro
	// gs://bucket/path_to_table/dt=2019-05-31/country=CA/id=3/file.avro
	// When hive partitioning is requested with either AUTO or STRINGS
	// detection, the common prefix can be either of
	// gs://bucket/path_to_table or gs://bucket/path_to_table/. CUSTOM
	// detection requires encoding the partitioning schema immediately after
	// the common prefix. For CUSTOM, any of *
	// gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:INTEGER} *
	// gs://bucket/path_to_table/{dt:STRING}/{country:STRING}/{id:INTEGER} *
	// gs://bucket/path_to_table/{dt:DATE}/{country:STRING}/{id:STRING}
	// would all be valid source URI prefixes.
	SourceUriPrefix string `json:"sourceUriPrefix,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Fields") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Fields") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HivePartitioningOptions: Options for configuring hive partitioning detect.

func (*HivePartitioningOptions) MarshalJSON added in v0.7.0

func (s *HivePartitioningOptions) MarshalJSON() ([]byte, error)

type HparamSearchSpaces added in v0.72.0

type HparamSearchSpaces struct {
	// ActivationFn: Activation functions of neural network models.
	ActivationFn *StringHparamSearchSpace `json:"activationFn,omitempty"`

	// BatchSize: Mini batch sample size.
	BatchSize *IntHparamSearchSpace `json:"batchSize,omitempty"`

	// BoosterType: Booster type for boosted tree models.
	BoosterType *StringHparamSearchSpace `json:"boosterType,omitempty"`

	// ColsampleBylevel: Subsample ratio of columns for each level for
	// boosted tree models.
	ColsampleBylevel *DoubleHparamSearchSpace `json:"colsampleBylevel,omitempty"`

	// ColsampleBynode: Subsample ratio of columns for each node(split) for
	// boosted tree models.
	ColsampleBynode *DoubleHparamSearchSpace `json:"colsampleBynode,omitempty"`

	// ColsampleBytree: Subsample ratio of columns when constructing each
	// tree for boosted tree models.
	ColsampleBytree *DoubleHparamSearchSpace `json:"colsampleBytree,omitempty"`

	// DartNormalizeType: Dart normalization type for boosted tree models.
	DartNormalizeType *StringHparamSearchSpace `json:"dartNormalizeType,omitempty"`

	// Dropout: Dropout probability for dnn model training and boosted tree
	// models using dart booster.
	Dropout *DoubleHparamSearchSpace `json:"dropout,omitempty"`

	// HiddenUnits: Hidden units for neural network models.
	HiddenUnits *IntArrayHparamSearchSpace `json:"hiddenUnits,omitempty"`

	// L1Reg: L1 regularization coefficient.
	L1Reg *DoubleHparamSearchSpace `json:"l1Reg,omitempty"`

	// L2Reg: L2 regularization coefficient.
	L2Reg *DoubleHparamSearchSpace `json:"l2Reg,omitempty"`

	// LearnRate: Learning rate of training jobs.
	LearnRate *DoubleHparamSearchSpace `json:"learnRate,omitempty"`

	// MaxTreeDepth: Maximum depth of a tree for boosted tree models.
	MaxTreeDepth *IntHparamSearchSpace `json:"maxTreeDepth,omitempty"`

	// MinSplitLoss: Minimum split loss for boosted tree models.
	MinSplitLoss *DoubleHparamSearchSpace `json:"minSplitLoss,omitempty"`

	// MinTreeChildWeight: Minimum sum of instance weight needed in a child
	// for boosted tree models.
	MinTreeChildWeight *IntHparamSearchSpace `json:"minTreeChildWeight,omitempty"`

	// NumClusters: Number of clusters for k-means.
	NumClusters *IntHparamSearchSpace `json:"numClusters,omitempty"`

	// NumFactors: Number of latent factors to train on.
	NumFactors *IntHparamSearchSpace `json:"numFactors,omitempty"`

	// NumParallelTree: Number of parallel trees for boosted tree models.
	NumParallelTree *IntHparamSearchSpace `json:"numParallelTree,omitempty"`

	// Optimizer: Optimizer of TF models.
	Optimizer *StringHparamSearchSpace `json:"optimizer,omitempty"`

	// Subsample: Subsample the training data to grow tree to prevent
	// overfitting for boosted tree models.
	Subsample *DoubleHparamSearchSpace `json:"subsample,omitempty"`

	// TreeMethod: Tree construction algorithm for boosted tree models.
	TreeMethod *StringHparamSearchSpace `json:"treeMethod,omitempty"`

	// WalsAlpha: Hyperparameter for matrix factoration when implicit
	// feedback type is specified.
	WalsAlpha *DoubleHparamSearchSpace `json:"walsAlpha,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ActivationFn") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ActivationFn") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*HparamSearchSpaces) MarshalJSON added in v0.72.0

func (s *HparamSearchSpaces) MarshalJSON() ([]byte, error)

type HparamTuningTrial added in v0.72.0

type HparamTuningTrial struct {
	// EndTimeMs: Ending time of the trial.
	EndTimeMs int64 `json:"endTimeMs,omitempty,string"`

	// ErrorMessage: Error message for FAILED and INFEASIBLE trial.
	ErrorMessage string `json:"errorMessage,omitempty"`

	// EvalLoss: Loss computed on the eval data at the end of trial.
	EvalLoss float64 `json:"evalLoss,omitempty"`

	// EvaluationMetrics: Evaluation metrics of this trial calculated on the
	// test data. Empty in Job API.
	EvaluationMetrics *EvaluationMetrics `json:"evaluationMetrics,omitempty"`

	// HparamTuningEvaluationMetrics: Hyperparameter tuning evaluation
	// metrics of this trial calculated on the eval data. Unlike
	// evaluation_metrics, only the fields corresponding to the
	// hparam_tuning_objectives are set.
	HparamTuningEvaluationMetrics *EvaluationMetrics `json:"hparamTuningEvaluationMetrics,omitempty"`

	// Hparams: The hyperprameters selected for this trial.
	Hparams *TrainingOptions `json:"hparams,omitempty"`

	// StartTimeMs: Starting time of the trial.
	StartTimeMs int64 `json:"startTimeMs,omitempty,string"`

	// Status: The status of the trial.
	//
	// Possible values:
	//   "TRIAL_STATUS_UNSPECIFIED" - Default value.
	//   "NOT_STARTED" - Scheduled but not started.
	//   "RUNNING" - Running state.
	//   "SUCCEEDED" - The trial succeeded.
	//   "FAILED" - The trial failed.
	//   "INFEASIBLE" - The trial is infeasible due to the invalid params.
	//   "STOPPED_EARLY" - Trial stopped early because it's not promising.
	Status string `json:"status,omitempty"`

	// TrainingLoss: Loss computed on the training data at the end of trial.
	TrainingLoss float64 `json:"trainingLoss,omitempty"`

	// TrialId: 1-based index of the trial.
	TrialId int64 `json:"trialId,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "EndTimeMs") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "EndTimeMs") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

HparamTuningTrial: Training info of a trial in hyperparameter tuning (/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-hp-tuning- overview) models.

func (*HparamTuningTrial) MarshalJSON added in v0.72.0

func (s *HparamTuningTrial) MarshalJSON() ([]byte, error)

func (*HparamTuningTrial) UnmarshalJSON added in v0.72.0

func (s *HparamTuningTrial) UnmarshalJSON(data []byte) error

type IndexUnusedReason added in v0.84.0

type IndexUnusedReason struct {
	// BaseTable: Specifies the base table involved in the reason that no
	// search index was used.
	BaseTable *TableReference `json:"baseTable,omitempty"`

	// Code: Specifies the high-level reason for the scenario when no search
	// index was used.
	//
	// Possible values:
	//   "CODE_UNSPECIFIED" - Code not specified.
	//   "INDEX_CONFIG_NOT_AVAILABLE" - Indicates the search index
	// configuration has not been created.
	//   "PENDING_INDEX_CREATION" - Indicates the search index creation has
	// not been completed.
	//   "BASE_TABLE_TRUNCATED" - Indicates the base table has been
	// truncated (rows have been removed from table with TRUNCATE TABLE
	// statement) since the last time the search index was refreshed.
	//   "INDEX_CONFIG_MODIFIED" - Indicates the search index configuration
	// has been changed since the last time the search index was refreshed.
	//   "TIME_TRAVEL_QUERY" - Indicates the search query accesses data at a
	// timestamp before the last time the search index was refreshed.
	//   "NO_PRUNING_POWER" - Indicates the usage of search index will not
	// contribute to any pruning improvement for the search function, e.g.
	// when the search predicate is in a disjunction with other non-search
	// predicates.
	//   "UNINDEXED_SEARCH_FIELDS" - Indicates the search index does not
	// cover all fields in the search function.
	//   "UNSUPPORTED_SEARCH_PATTERN" - Indicates the search index does not
	// support the given search query pattern.
	//   "OPTIMIZED_WITH_MATERIALIZED_VIEW" - Indicates the query has been
	// optimized by using a materialized view.
	//   "SECURED_BY_DATA_MASKING" - Indicates the query has been secured by
	// data masking, and thus search indexes are not applicable.
	//   "MISMATCHED_TEXT_ANALYZER" - Indicates that the search index and
	// the search function call do not have the same text analyzer.
	//   "BASE_TABLE_TOO_SMALL" - Indicates the base table is too small
	// (below a certain threshold). The index does not provide noticeable
	// search performance gains when the base table is too small.
	//   "BASE_TABLE_TOO_LARGE" - Indicates that the total size of indexed
	// base tables in your organization exceeds your region's limit and the
	// index is not used in the query. To index larger base tables, you can
	// use your own reservation for index-management jobs.
	//   "ESTIMATED_PERFORMANCE_GAIN_TOO_LOW" - Indicates that the estimated
	// performance gain from using the search index is too low for the given
	// search query.
	//   "NOT_SUPPORTED_IN_STANDARD_EDITION" - Indicates that search indexes
	// can not be used for search query with STANDARD edition.
	//   "INDEX_SUPPRESSED_BY_FUNCTION_OPTION" - Indicates that an option in
	// the search function that cannot make use of the index has been
	// selected.
	//   "QUERY_CACHE_HIT" - Indicates that the query was cached, and thus
	// the search index was not used.
	//   "INTERNAL_ERROR" - Indicates an internal error that causes the
	// search index to be unused.
	//   "OTHER_REASON" - Indicates that the reason search indexes cannot be
	// used in the query is not covered by any of the other
	// IndexUnusedReason options.
	Code string `json:"code,omitempty"`

	// IndexName: Specifies the name of the unused search index, if
	// available.
	IndexName string `json:"indexName,omitempty"`

	// Message: Free form human-readable reason for the scenario when no
	// search index was used.
	Message string `json:"message,omitempty"`

	// ForceSendFields is a list of field names (e.g. "BaseTable") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "BaseTable") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*IndexUnusedReason) MarshalJSON added in v0.84.0

func (s *IndexUnusedReason) MarshalJSON() ([]byte, error)

type InputDataChange added in v0.160.0

type InputDataChange struct {
	// RecordsReadDiffPercentage: Output only. Records read difference
	// percentage compared to a previous run.
	RecordsReadDiffPercentage float64 `json:"recordsReadDiffPercentage,omitempty"`

	// ForceSendFields is a list of field names (e.g.
	// "RecordsReadDiffPercentage") to unconditionally include in API
	// requests. By default, fields with empty or default values are omitted
	// from API requests. However, any non-pointer, non-interface field
	// appearing in ForceSendFields will be sent to the server regardless of
	// whether the field is empty or not. This may be used to include empty
	// fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g.
	// "RecordsReadDiffPercentage") to include in API requests with the JSON
	// null value. By default, fields with empty values are omitted from API
	// requests. However, any field with an empty value appearing in
	// NullFields will be sent to the server as null. It is an error if a
	// field in this list has a non-empty value. This may be used to include
	// null fields in Patch requests.
	NullFields []string `json:"-"`
}

InputDataChange: Details about the input data change insight.

func (*InputDataChange) MarshalJSON added in v0.160.0

func (s *InputDataChange) MarshalJSON() ([]byte, error)

func (*InputDataChange) UnmarshalJSON added in v0.160.0

func (s *InputDataChange) UnmarshalJSON(data []byte) error

type IntArray added in v0.72.0

type IntArray struct {
	// Elements: Elements in the int array.
	Elements googleapi.Int64s `json:"elements,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Elements") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Elements") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IntArray: An array of int.

func (*IntArray) MarshalJSON added in v0.72.0

func (s *IntArray) MarshalJSON() ([]byte, error)

type IntArrayHparamSearchSpace added in v0.72.0

type IntArrayHparamSearchSpace struct {
	// Candidates: Candidates for the int array parameter.
	Candidates []*IntArray `json:"candidates,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Candidates") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Candidates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IntArrayHparamSearchSpace: Search space for int array.

func (*IntArrayHparamSearchSpace) MarshalJSON added in v0.72.0

func (s *IntArrayHparamSearchSpace) MarshalJSON() ([]byte, error)

type IntCandidates added in v0.72.0

type IntCandidates struct {
	// Candidates: Candidates for the int parameter in increasing order.
	Candidates googleapi.Int64s `json:"candidates,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Candidates") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Candidates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IntCandidates: Discrete candidates of an int hyperparameter.

func (*IntCandidates) MarshalJSON added in v0.72.0

func (s *IntCandidates) MarshalJSON() ([]byte, error)

type IntHparamSearchSpace added in v0.72.0

type IntHparamSearchSpace struct {
	// Candidates: Candidates of the int hyperparameter.
	Candidates *IntCandidates `json:"candidates,omitempty"`

	// Range: Range of the int hyperparameter.
	Range *IntRange `json:"range,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Candidates") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Candidates") to include in
	// API requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IntHparamSearchSpace: Search space for an int hyperparameter.

func (*IntHparamSearchSpace) MarshalJSON added in v0.72.0

func (s *IntHparamSearchSpace) MarshalJSON() ([]byte, error)

type IntRange added in v0.72.0

type IntRange struct {
	// Max: Max value of the int parameter.
	Max int64 `json:"max,omitempty,string"`

	// Min: Min value of the int parameter.
	Min int64 `json:"min,omitempty,string"`

	// ForceSendFields is a list of field names (e.g. "Max") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Max") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IntRange: Range of an int hyperparameter.

func (*IntRange) MarshalJSON added in v0.72.0

func (s *IntRange) MarshalJSON() ([]byte, error)

type IterationResult

type IterationResult struct {
	// ArimaResult: Arima result.
	ArimaResult *ArimaResult `json:"arimaResult,omitempty"`

	// ClusterInfos: Information about top clusters for clustering models.
	ClusterInfos []*ClusterInfo `json:"clusterInfos,omitempty"`

	// DurationMs: Time taken to run the iteration in milliseconds.
	DurationMs int64 `json:"durationMs,omitempty,string"`

	// EvalLoss: Loss computed on the eval data at the end of iteration.
	EvalLoss float64 `json:"evalLoss,omitempty"`

	// Index: Index of the iteration, 0 based.
	Index int64 `json:"index,omitempty"`

	// LearnRate: Learn rate used for this iteration.
	LearnRate float64 `json:"learnRate,omitempty"`

	// PrincipalComponentInfos: The information of the principal components.
	PrincipalComponentInfos []*PrincipalComponentInfo `json:"principalComponentInfos,omitempty"`

	// TrainingLoss: Loss computed on the training data at the end of
	// iteration.
	TrainingLoss float64 `json:"trainingLoss,omitempty"`

	// ForceSendFields is a list of field names (e.g. "ArimaResult") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "ArimaResult") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

IterationResult: Information about a single iteration of the training run.

func (*IterationResult) MarshalJSON

func (s *IterationResult) MarshalJSON() ([]byte, error)

func (*IterationResult) UnmarshalJSON

func (s *IterationResult) UnmarshalJSON(data []byte) error

type Job

type Job struct {
	// Configuration: Required. Describes the job configuration.
	Configuration *JobConfiguration `json:"configuration,omitempty"`

	// Etag: Output only. A hash of this resource.
	Etag string `json:"etag,omitempty"`

	// Id: Output only. Opaque ID field of the job.
	Id string `json:"id,omitempty"`

	// JobCreationReason: 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.
	JobCreationReason *JobCreationReason `json:"jobCreationReason,omitempty"`

	// JobReference: Optional. Reference describing the unique-per-user name
	// of the job.
	JobReference *JobReference `json:"jobReference,omitempty"`

	// Kind: Output only. The type of the resource.
	Kind string `json:"kind,omitempty"`

	// PrincipalSubject: 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.
	PrincipalSubject string `json:"principal_subject,omitempty"`

	// SelfLink: Output only. A URL that can be used to access the resource
	// again.
	SelfLink string `json:"selfLink,omitempty"`

	// Statistics: Output only. Information about the job, including
	// starting time and ending time of the job.
	Statistics *JobStatistics `json:"statistics,omitempty"`

	// Status: Output only. The status of this job. Examine this value when
	// polling an asynchronous job to see if the job is complete.
	Status *JobStatus `json:"status,omitempty"`

	// UserEmail: Output only. Email address of the user who ran the job.
	UserEmail string `json:"user_email,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Configuration") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Configuration") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*Job) MarshalJSON

func (s *Job) MarshalJSON() ([]byte, error)

type JobCancelResponse

type JobCancelResponse struct {
	// Job: The final state of the job.
	Job *Job `json:"job,omitempty"`

	// Kind: The resource type of the response.
	Kind string `json:"kind,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Job") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Job") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

JobCancelResponse: Describes format of a jobs cancellation response.

func (*JobCancelResponse) MarshalJSON

func (s *JobCancelResponse) MarshalJSON() ([]byte, error)

type JobConfiguration

type JobConfiguration struct {
	// Copy: [Pick one] Copies a table.
	Copy *JobConfigurationTableCopy `json:"copy,omitempty"`

	// DryRun: 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.
	DryRun bool `json:"dryRun,omitempty"`

	// Extract: [Pick one] Configures an extract job.
	Extract *JobConfigurationExtract `json:"extract,omitempty"`

	// JobTimeoutMs: Optional. Job timeout in milliseconds. If this time
	// limit is exceeded, BigQuery might attempt to stop the job.
	JobTimeoutMs int64 `json:"jobTimeoutMs,omitempty,string"`

	// JobType: Output only. The type of the job. Can be QUERY, LOAD,
	// EXTRACT, COPY or UNKNOWN.
	JobType string `json:"jobType,omitempty"`

	// Labels: 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.
	Labels map[string]string `json:"labels,omitempty"`

	// Load: [Pick one] Configures a load job.
	Load *JobConfigurationLoad `json:"load,omitempty"`

	// Query: [Pick one] Configures a query job.
	Query *JobConfigurationQuery `json:"query,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Copy") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Copy") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

func (*JobConfiguration) MarshalJSON

func (s *JobConfiguration) MarshalJSON() ([]byte, error)

type JobConfigurationExtract

type JobConfigurationExtract struct {
	// Compression: Optional. The compression type to use for exported
	// files. Possible values include DEFLATE, GZIP, NONE, SNAPPY, and ZSTD.
	// The default value is NONE. Not all compression formats are support
	// for all file formats. DEFLATE is only supported for Avro. ZSTD is
	// only supported for Parquet. Not applicable when extracting models.
	Compression string `json:"compression,omitempty"`

	// DestinationFormat: Optional. The exported file format. Possible
	// values include CSV, NEWLINE_DELIMITED_JSON, PARQUET, or AVRO for
	// tables and ML_TF_SAVED_MODEL or ML_XGBOOST_BOOSTER for models. The
	// default value for tables is CSV. Tables with nested or repeated
	// fields cannot be exported as CSV. The default value for models is
	// ML_TF_SAVED_MODEL.
	DestinationFormat string `json:"destinationFormat,omitempty"`

	// DestinationUri: [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.
	DestinationUri string `json:"destinationUri,omitempty"`

	// DestinationUris: [Pick one] A list of fully-qualified Google Cloud
	// Storage URIs where the extracted table should be written.
	DestinationUris []string `json:"destinationUris,omitempty"`

	// FieldDelimiter: Optional. When extracting data in CSV format, this
	// defines the delimiter to use between fields in the exported data.
	// Default is ','. Not applicable when extracting models.
	FieldDelimiter string `json:"fieldDelimiter,omitempty"`

	// ModelExtractOptions: Optional. Model extract options only applicable
	// when extracting models.
	ModelExtractOptions *ModelExtractOptions `json:"modelExtractOptions,omitempty"`

	// PrintHeader: Optional. Whether to print out a header row in the
	// results. Default is true. Not applicable when extracting models.
	//
	// Default: true
	PrintHeader *bool `json:"printHeader,omitempty"`

	// SourceModel: A reference to the model being exported.
	SourceModel *ModelReference `json:"sourceModel,omitempty"`

	// SourceTable: A reference to the table being exported.
	SourceTable *TableReference `json:"sourceTable,omitempty"`

	// UseAvroLogicalTypes: Whether to use logical types when extracting to
	// AVRO format. Not applicable when extracting models.
	UseAvroLogicalTypes bool `json:"useAvroLogicalTypes,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Compression") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Compression") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*JobConfigurationExtract) MarshalJSON

func (s *JobConfigurationExtract) MarshalJSON() ([]byte, error)

type JobConfigurationLoad

type JobConfigurationLoad struct {
	// AllowJaggedRows: 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.
	AllowJaggedRows bool `json:"allowJaggedRows,omitempty"`

	// AllowQuotedNewlines: Indicates if BigQuery should allow quoted data
	// sections that contain newline characters in a CSV file. The default
	// value is false.
	AllowQuotedNewlines bool `json:"allowQuotedNewlines,omitempty"`

	// Autodetect: Optional. Indicates if we should automatically infer the
	// options and schema for CSV and JSON sources.
	Autodetect bool `json:"autodetect,omitempty"`

	// Clustering: Clustering specification for the destination table.
	Clustering *Clustering `json:"clustering,omitempty"`

	// ConnectionProperties: Optional. Connection properties which can
	// modify the load job behavior. Currently, only the 'session_id'
	// connection property is supported, and is used to resolve _SESSION
	// appearing as the dataset id.
	ConnectionProperties []*ConnectionProperty `json:"connectionProperties,omitempty"`

	// CopyFilesOnly: Optional. [Experimental] Configures the load job to
	// only copy files to the destination BigLake managed table with an
	// external storage_uri, without reading file content and writing them
	// to new files. Copying files only is supported when: * source_uris are
	// in the same external storage system as the destination table but they
	// do not overlap with storage_uri of the destination table. *
	// source_format is the same file format as the destination table. *
	// destination_table is an existing BigLake managed table. Its schema
	// does not have default value expression. It schema does not have type
	// parameters other than precision and scale. * No options other than
	// the above are specified.
	CopyFilesOnly bool `json:"copyFilesOnly,omitempty"`

	// CreateDisposition: 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.
	CreateDisposition string `json:"createDisposition,omitempty"`

	// CreateSession: Optional. If this property is true, the job creates a
	// new session using a randomly generated session_id. To continue using
	// a created session with subsequent queries, pass the existing session
	// identifier as a `ConnectionProperty` value. The session identifier is
	// returned as part of the `SessionInfo` message within the query
	// statistics. The new session's location will be set to
	// `Job.JobReference.location` if it is present, otherwise it's set to
	// the default location based on existing routing logic.
	CreateSession bool `json:"createSession,omitempty"`

	// DecimalTargetTypes: 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.
	//
	// Possible values:
	//   "DECIMAL_TARGET_TYPE_UNSPECIFIED" - Invalid type.
	//   "NUMERIC" - Decimal values could be converted to NUMERIC type.
	//   "BIGNUMERIC" - Decimal values could be converted to BIGNUMERIC
	// type.
	//   "STRING" - Decimal values could be converted to STRING type.
	DecimalTargetTypes []string `json:"decimalTargetTypes,omitempty"`

	// DestinationEncryptionConfiguration: Custom encryption configuration
	// (e.g., Cloud KMS keys)
	DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	// DestinationTable: [Required] The destination table to load the data
	// into.
	DestinationTable *TableReference `json:"destinationTable,omitempty"`

	// DestinationTableProperties: Optional. [Experimental] Properties with
	// which to create the destination table if it is new.
	DestinationTableProperties *DestinationTableProperties `json:"destinationTableProperties,omitempty"`

	// Encoding: Optional. The character encoding of the data. The supported
	// values are UTF-8, ISO-8859-1, UTF-16BE, UTF-16LE, UTF-32BE, and
	// UTF-32LE. 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. If you don't specify an encoding, or
	// if you specify a UTF-8 encoding when the CSV file is not UTF-8
	// encoded, BigQuery attempts to convert the data to UTF-8. Generally,
	// your data loads successfully, but it may not match byte-for-byte what
	// you expect. To avoid this, specify the correct encoding by using the
	// `--encoding` flag. If BigQuery can't convert a character other than
	// the ASCII `0` character, BigQuery converts the character to the
	// standard Unicode replacement character: �.
	Encoding string `json:"encoding,omitempty"`

	// FieldDelimiter: Optional. The separator character for fields in a CSV
	// file. The separator is interpreted as a single byte. For files
	// encoded in ISO-8859-1, any single character can be used as a
	// separator. For files encoded in UTF-8, characters represented in
	// decimal range 1-127 (U+0001-U+007F) can be used without any
	// modification. UTF-8 characters encoded with multiple bytes (i.e.
	// U+0080 and above) will have only the first byte used for separating
	// fields. The remaining bytes will be treated as a part of the field.
	// BigQuery also supports the escape sequence "\t" (U+0009) to specify a
	// tab separator. The default value is comma (",", U+002C).
	FieldDelimiter string `json:"fieldDelimiter,omitempty"`

	// FileSetSpecType: Optional. Specifies how source URIs are interpreted
	// for constructing the file set to load. By default, source URIs are
	// expanded against the underlying storage. You can also specify
	// manifest files to control how the file set is constructed. This
	// option is only applicable to object storage systems.
	//
	// Possible values:
	//   "FILE_SET_SPEC_TYPE_FILE_SYSTEM_MATCH" - This option expands source
	// URIs by listing files from the object store. It is the default
	// behavior if FileSetSpecType is not set.
	//   "FILE_SET_SPEC_TYPE_NEW_LINE_DELIMITED_MANIFEST" - This option
	// indicates that the provided URIs are newline-delimited manifest
	// files, with one URI per line. Wildcard URIs are not supported.
	FileSetSpecType string `json:"fileSetSpecType,omitempty"`

	// HivePartitioningOptions: 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.
	HivePartitioningOptions *HivePartitioningOptions `json:"hivePartitioningOptions,omitempty"`

	// IgnoreUnknownValues: 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 in the table schema Avro, Parquet, ORC: Fields
	// in the file schema that don't exist in the table schema.
	IgnoreUnknownValues bool `json:"ignoreUnknownValues,omitempty"`

	// JsonExtension: 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).
	//
	// Possible values:
	//   "JSON_EXTENSION_UNSPECIFIED" - The default if provided value is not
	// one included in the enum, or the value is not specified. The source
	// formate is parsed without any modification.
	//   "GEOJSON" - Use GeoJSON variant of JSON. See
	// https://tools.ietf.org/html/rfc7946.
	JsonExtension string `json:"jsonExtension,omitempty"`

	// MaxBadRecords: 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. The default value is 0, which requires that all records are
	// valid. This is only supported for CSV and NEWLINE_DELIMITED_JSON file
	// formats.
	MaxBadRecords int64 `json:"maxBadRecords,omitempty"`

	// NullMarker: 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.
	NullMarker string `json:"nullMarker,omitempty"`

	// ParquetOptions: Optional. Additional properties to set if
	// sourceFormat is set to PARQUET.
	ParquetOptions *ParquetOptions `json:"parquetOptions,omitempty"`

	// PreserveAsciiControlCharacters: Optional. When sourceFormat is set to
	// "CSV", this indicates whether the embedded ASCII control characters
	// (the first 32 characters in the ASCII-table, from '\x00' to '\x1F')
	// are preserved.
	PreserveAsciiControlCharacters bool `json:"preserveAsciiControlCharacters,omitempty"`

	// ProjectionFields: 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.
	ProjectionFields []string `json:"projectionFields,omitempty"`

	// Quote: 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. To include
	// the specific quote character within a quoted value, precede it with
	// an additional matching quote character. For example, if you want to
	// escape the default character ' " ', use ' "" '. @default "
	//
	// Default: "
	Quote *string `json:"quote,omitempty"`

	// RangePartitioning: Range partitioning specification for the
	// destination table. Only one of timePartitioning and rangePartitioning
	// should be specified.
	RangePartitioning *RangePartitioning `json:"rangePartitioning,omitempty"`

	// ReferenceFileSchemaUri: Optional. The user can provide a reference
	// file with the reader schema. This file is only loaded if it is part
	// of source URIs, but is not loaded otherwise. It is enabled for the
	// following formats: AVRO, PARQUET, ORC.
	ReferenceFileSchemaUri string `json:"referenceFileSchemaUri,omitempty"`

	// Schema: 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.
	Schema *TableSchema `json:"schema,omitempty"`

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

	// SchemaInlineFormat: [Deprecated] The format of the schemaInline
	// property.
	SchemaInlineFormat string `json:"schemaInlineFormat,omitempty"`

	// SchemaUpdateOptions: 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.
	SchemaUpdateOptions []string `json:"schemaUpdateOptions,omitempty"`

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

	// SourceFormat: 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.
	SourceFormat string `json:"sourceFormat,omitempty"`

	// SourceUris: [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.
	SourceUris []string `json:"sourceUris,omitempty"`

	// TimePartitioning: Time-based partitioning specification for the
	// destination table. Only one of timePartitioning and rangePartitioning
	// should be specified.
	TimePartitioning *TimePartitioning `json:"timePartitioning,omitempty"`

	// UseAvroLogicalTypes: Optional. If sourceFormat is set to "AVRO",
	// indicates whether to interpret logical types as the corresponding
	// BigQuery data type (for example, TIMESTAMP), instead of using the raw
	// type (for example, INTEGER).
	UseAvroLogicalTypes bool `json:"useAvroLogicalTypes,omitempty"`

	// WriteDisposition: 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 data, removes the constraints and uses the schema from the load
	// job. * 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.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AllowJaggedRows") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowJaggedRows") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

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

func (*JobConfigurationLoad) MarshalJSON

func (s *JobConfigurationLoad) MarshalJSON() ([]byte, error)

type JobConfigurationQuery

type JobConfigurationQuery struct {
	// AllowLargeResults: 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 GoogleSQL 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.
	AllowLargeResults bool `json:"allowLargeResults,omitempty"`

	// Clustering: Clustering specification for the destination table.
	Clustering *Clustering `json:"clustering,omitempty"`

	// ConnectionProperties: Connection properties which can modify the
	// query behavior.
	ConnectionProperties []*ConnectionProperty `json:"connectionProperties,omitempty"`

	// Continuous: [Optional] Specifies whether the query should be executed
	// as a continuous query. The default value is false.
	Continuous bool `json:"continuous,omitempty"`

	// CreateDisposition: 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.
	CreateDisposition string `json:"createDisposition,omitempty"`

	// CreateSession: If this property is true, the job creates a new
	// session using a randomly generated session_id. To continue using a
	// created session with subsequent queries, pass the existing session
	// identifier as a `ConnectionProperty` value. The session identifier is
	// returned as part of the `SessionInfo` message within the query
	// statistics. The new session's location will be set to
	// `Job.JobReference.location` if it is present, otherwise it's set to
	// the default location based on existing routing logic.
	CreateSession bool `json:"createSession,omitempty"`

	// DefaultDataset: Optional. Specifies the default dataset to use for
	// unqualified table names in the query. This setting does not alter
	// behavior of unqualified dataset names. Setting the system variable
	// `@@dataset_id` achieves the same behavior. See
	// https://cloud.google.com/bigquery/docs/reference/system-variables for
	// more information on system variables.
	DefaultDataset *DatasetReference `json:"defaultDataset,omitempty"`

	// DestinationEncryptionConfiguration: Custom encryption configuration
	// (e.g., Cloud KMS keys)
	DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	// DestinationTable: Optional. Describes the table where the query
	// results should be stored. This property must be set for large results
	// that exceed the maximum response size. For queries that produce
	// anonymous (cached) results, this field will be populated by BigQuery.
	DestinationTable *TableReference `json:"destinationTable,omitempty"`

	// FlattenResults: 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 GoogleSQL
	// queries, this flag is ignored and results are never flattened.
	//
	// Default: true
	FlattenResults *bool `json:"flattenResults,omitempty"`

	// MaximumBillingTier: Optional. [Deprecated] Maximum billing tier
	// allowed for this query. The billing tier controls the amount of
	// compute resources allotted to the query, and multiplies the on-demand
	// cost of the query accordingly. A query that runs within its allotted
	// resources will succeed and indicate its billing tier in
	// statistics.query.billingTier, but if the query exceeds its allotted
	// resources, it will fail with billingTierLimitExceeded. WARNING: The
	// billed byte amount can be multiplied by an amount up to this number!
	// Most users should not need to alter this setting, and we recommend
	// that you avoid introducing new uses of it.
	//
	// Default: 1
	MaximumBillingTier *int64 `json:"maximumBillingTier,omitempty"`

	// MaximumBytesBilled: 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.
	MaximumBytesBilled int64 `json:"maximumBytesBilled,omitempty,string"`

	// ParameterMode: GoogleSQL only. Set to POSITIONAL to use positional
	// (?) query parameters or to NAMED to use named (@myparam) query
	// parameters in this query.
	ParameterMode string `json:"parameterMode,omitempty"`

	// PreserveNulls: [Deprecated] This property is deprecated.
	PreserveNulls bool `json:"preserveNulls,omitempty"`

	// Priority: Optional. Specifies a priority for the query. Possible
	// values include INTERACTIVE and BATCH. The default value is
	// INTERACTIVE.
	Priority string `json:"priority,omitempty"`

	// Query: [Required] SQL query text to execute. The useLegacySql field
	// can be used to indicate whether the query uses legacy SQL or
	// GoogleSQL.
	Query string `json:"query,omitempty"`

	// QueryParameters: Query parameters for GoogleSQL queries.
	QueryParameters []*QueryParameter `json:"queryParameters,omitempty"`

	// RangePartitioning: Range partitioning specification for the
	// destination table. Only one of timePartitioning and rangePartitioning
	// should be specified.
	RangePartitioning *RangePartitioning `json:"rangePartitioning,omitempty"`

	// SchemaUpdateOptions: 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.
	SchemaUpdateOptions []string `json:"schemaUpdateOptions,omitempty"`

	// ScriptOptions: Options controlling the execution of scripts.
	ScriptOptions *ScriptOptions `json:"scriptOptions,omitempty"`

	// SystemVariables: Output only. System variables for GoogleSQL queries.
	// A system variable is output if the variable is settable and its value
	// differs from the system default. "@@" prefix is not included in the
	// name of the System variables.
	SystemVariables *SystemVariables `json:"systemVariables,omitempty"`

	// TableDefinitions: Optional. You can specify external table
	// definitions, which operate as ephemeral tables that can be queried.
	// These definitions are configured using a JSON map, where the string
	// key represents the table identifier, and the value is the
	// corresponding external data configuration object.
	TableDefinitions map[string]ExternalDataConfiguration `json:"tableDefinitions,omitempty"`

	// TimePartitioning: Time-based partitioning specification for the
	// destination table. Only one of timePartitioning and rangePartitioning
	// should be specified.
	TimePartitioning *TimePartitioning `json:"timePartitioning,omitempty"`

	// UseLegacySql: Optional. 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 GoogleSQL:
	// 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.
	//
	// Default: true
	UseLegacySql *bool `json:"useLegacySql,omitempty"`

	// UseQueryCache: 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.
	//
	// Default: true
	UseQueryCache *bool `json:"useQueryCache,omitempty"`

	// UserDefinedFunctionResources: Describes user-defined function
	// resources used in the query.
	UserDefinedFunctionResources []*UserDefinedFunctionResource `json:"userDefinedFunctionResources,omitempty"`

	// WriteDisposition: 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 data, removes the constraints, 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.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "AllowLargeResults")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "AllowLargeResults") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

JobConfigurationQuery: JobConfigurationQuery configures a BigQuery query job.

func (*JobConfigurationQuery) MarshalJSON

func (s *JobConfigurationQuery) MarshalJSON() ([]byte, error)

type JobConfigurationTableCopy

type JobConfigurationTableCopy struct {
	// CreateDisposition: 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.
	CreateDisposition string `json:"createDisposition,omitempty"`

	// DestinationEncryptionConfiguration: Custom encryption configuration
	// (e.g., Cloud KMS keys).
	DestinationEncryptionConfiguration *EncryptionConfiguration `json:"destinationEncryptionConfiguration,omitempty"`

	// DestinationExpirationTime: Optional. The time when the destination
	// table expires. Expired tables will be deleted and their storage
	// reclaimed.
	DestinationExpirationTime string `json:"destinationExpirationTime,omitempty"`

	// DestinationTable: [Required] The destination table.
	DestinationTable *TableReference `json:"destinationTable,omitempty"`

	// OperationType: Optional. Supported operation types in table copy job.
	//
	// Possible values:
	//   "OPERATION_TYPE_UNSPECIFIED" - Unspecified operation type.
	//   "COPY" - The source and destination table have the same table type.
	//   "SNAPSHOT" - The source table type is TABLE and the destination
	// table type is SNAPSHOT.
	//   "RESTORE" - The source table type is SNAPSHOT and the destination
	// table type is TABLE.
	//   "CLONE" - The source and destination table have the same table
	// type, but only bill for unique data.
	OperationType string `json:"operationType,omitempty"`

	// SourceTable: [Pick one] Source table to copy.
	SourceTable *TableReference `json:"sourceTable,omitempty"`

	// SourceTables: [Pick one] Source tables to copy.
	SourceTables []*TableReference `json:"sourceTables,omitempty"`

	// WriteDisposition: 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 and table constraints from the
	// source table. * 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.
	WriteDisposition string `json:"writeDisposition,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CreateDisposition")
	// to unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CreateDisposition") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

JobConfigurationTableCopy: JobConfigurationTableCopy configures a job that copies data from one table to another. For more information on copying tables, see Copy a table (https://cloud.google.com/bigquery/docs/managing-tables#copy-table).

func (*JobConfigurationTableCopy) MarshalJSON

func (s *JobConfigurationTableCopy) MarshalJSON() ([]byte, error)

type JobCreationReason added in v0.148.0

type JobCreationReason struct {
	// Code: Output only. Specifies the high level reason why a Job was
	// created.
	//
	// Possible values:
	//   "CODE_UNSPECIFIED" - Reason is not specified.
	//   "REQUESTED" - Job creation was requested.
	//   "LONG_RUNNING" - The query request ran beyond a system defined
	// timeout specified by the [timeoutMs field in the
	// QueryRequest](https://cloud.google.com/bigquery/docs/reference/rest/v2
	// /jobs/query#queryrequest). As a result it was considered a long
	// running operation for which a job was created.
	//   "LARGE_RESULTS" - The results from the query cannot fit in the
	// response.
	//   "OTHER" - BigQuery has determined that the query needs to be
	// executed as a Job.
	Code string `json:"code,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Code") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Code") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

JobCreationReason: Reason about why a Job was created from a `jobs.query` (https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query) method when used with `JOB_CREATION_OPTIONAL` Job creation mode. For `jobs.insert` (https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/insert) method calls it will always be `REQUESTED`. This feature is not yet available. Jobs will always be created.

func (*JobCreationReason) MarshalJSON added in v0.148.0

func (s *JobCreationReason) MarshalJSON() ([]byte, error)

type JobList

type JobList struct {
	// Etag: A hash of this page of results.
	Etag string `json:"etag,omitempty"`

	// Jobs: List of jobs that were requested.
	Jobs []*JobListJobs `json:"jobs,omitempty"`

	// Kind: The resource type of the response.
	Kind string `json:"kind,omitempty"`

	// NextPageToken: A token to request the next page of results.
	NextPageToken string `json:"nextPageToken,omitempty"`

	// Unreachable: A list of skipped locations that were unreachable. For
	// more information about BigQuery locations, see:
	// https://cloud.google.com/bigquery/docs/locations. Example:
	// "europe-west5"
	Unreachable []string `json:"unreachable,omitempty"`

	// ServerResponse contains the HTTP response code and headers from the
	// server.
	googleapi.ServerResponse `json:"-"`

	// ForceSendFields is a list of field names (e.g. "Etag") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Etag") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*JobList) MarshalJSON

func (s *JobList) MarshalJSON() ([]byte, error)

type JobListJobs

type JobListJobs struct {
	// Configuration: Required. Describes the job configuration.
	Configuration *JobConfiguration `json:"configuration,omitempty"`

	// ErrorResult: A result object that will be present only if the job has
	// failed.
	ErrorResult *ErrorProto `json:"errorResult,omitempty"`

	// Id: Unique opaque ID of the job.
	Id string `json:"id,omitempty"`

	// JobReference: Unique opaque ID of the job.
	JobReference *JobReference `json:"jobReference,omitempty"`

	// Kind: The resource type.
	Kind string `json:"kind,omitempty"`

	// PrincipalSubject: [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.
	PrincipalSubject string `json:"principal_subject,omitempty"`

	// State: Running state of the job. When the state is DONE, errorResult
	// can be checked to determine whether the job succeeded or failed.
	State string `json:"state,omitempty"`

	// Statistics: Output only. Information about the job, including
	// starting time and ending time of the job.
	Statistics *JobStatistics `json:"statistics,omitempty"`

	// Status: [Full-projection-only] Describes the status of this job.
	Status *JobStatus `json:"status,omitempty"`

	// UserEmail: [Full-projection-only] Email address of the user who ran
	// the job.
	UserEmail string `json:"user_email,omitempty"`

	// ForceSendFields is a list of field names (e.g. "Configuration") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "Configuration") to include
	// in API requests with the JSON null value. By default, fields with
	// empty values are omitted from API requests. However, any field with
	// an empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*JobListJobs) MarshalJSON

func (s *JobListJobs) MarshalJSON() ([]byte, error)

type JobReference

type JobReference struct {
	// JobId: 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.
	JobId string `json:"jobId,omitempty"`

	// Location: Optional. The geographic location of the job. The default
	// value is US. For more information about BigQuery locations, see:
	// https://cloud.google.com/bigquery/docs/locations
	Location string `json:"location,omitempty"`

	// ProjectId: Required. The ID of the project containing this job.
	ProjectId string `json:"projectId,omitempty"`

	// ForceSendFields is a list of field names (e.g. "JobId") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "JobId") to include in API
	// requests with the JSON null value. By default, fields with empty
	// values are omitted from API requests. However, any field with an
	// empty value appearing in NullFields will be sent to the server as
	// null. It is an error if a field in this list has a non-empty value.
	// This may be used to include null fields in Patch requests.
	NullFields []string `json:"-"`
}

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

func (*JobReference) MarshalJSON

func (s *JobReference) MarshalJSON() ([]byte, error)

type JobStatistics

type JobStatistics struct {
	// CompletionRatio: Output only. [TrustedTester] Job progress (0.0 ->
	// 1.0) for LOAD and EXTRACT jobs.
	CompletionRatio float64 `json:"completionRatio,omitempty"`

	// Copy: Output only. Statistics for a copy job.
	Copy *JobStatistics5 `json:"copy,omitempty"`

	// CreationTime: Output only. Creation time of this job, in milliseconds
	// since the epoch. This field will be present on all jobs.
	CreationTime int64 `json:"creationTime,omitempty,string"`

	// DataMaskingStatistics: Output only. Statistics for data-masking.
	// Present only for query and extract jobs.
	DataMaskingStatistics *DataMaskingStatistics `json:"dataMaskingStatistics,omitempty"`

	// EndTime: 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.
	EndTime int64 `json:"endTime,omitempty,string"`

	// Extract: Output only. Statistics for an extract job.
	Extract *JobStatistics4 `json:"extract,omitempty"`

	// FinalExecutionDurationMs: Output only. The duration in milliseconds
	// of the execution of the final attempt of this job, as BigQuery may
	// internally re-attempt to execute the job.
	FinalExecutionDurationMs int64 `json:"finalExecutionDurationMs,omitempty,string"`

	// Load: Output only. Statistics for a load job.
	Load *JobStatistics3 `json:"load,omitempty"`

	// NumChildJobs: Output only. Number of child jobs executed.
	NumChildJobs int64 `json:"numChildJobs,omitempty,string"`

	// ParentJobId: Output only. If this is a child job, specifies the job
	// ID of the parent.
	ParentJobId string `json:"parentJobId,omitempty"`

	// Query: Output only. Statistics for a query job.
	Query *JobStatistics2 `json:"query,omitempty"`

	// QuotaDeferments: Output only. Quotas which delayed this job's start
	// time.
	QuotaDeferments []string `json:"quotaDeferments,omitempty"`

	// ReservationUsage: Output only. Job resource usage breakdown by
	// reservation. This field reported misleading information and will no
	// longer be populated.
	ReservationUsage []*JobStatisticsReservationUsage `json:"reservationUsage,omitempty"`

	// ReservationId: Output only. Name of the primary reservation assigned
	// to this job. Note that this could be different than reservations
	// reported in the reservation usage field if parent reservations were
	// used to execute this job.
	ReservationId string `json:"reservation_id,omitempty"`

	// RowLevelSecurityStatistics: Output only. Statistics for row-level
	// security. Present only for query and extract jobs.
	RowLevelSecurityStatistics *RowLevelSecurityStatistics `json:"rowLevelSecurityStatistics,omitempty"`

	// ScriptStatistics: Output only. If this a child job of a script,
	// specifies information about the context of this job within the
	// script.
	ScriptStatistics *ScriptStatistics `json:"scriptStatistics,omitempty"`

	// SessionInfo: Output only. Information of the session if this job is
	// part of one.
	SessionInfo *SessionInfo `json:"sessionInfo,omitempty"`

	// StartTime: 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.
	StartTime int64 `json:"startTime,omitempty,string"`

	// TotalBytesProcessed: Output only. Total bytes processed for the job.
	TotalBytesProcessed int64 `json:"totalBytesProcessed,omitempty,string"`

	// TotalSlotMs: Output only. Slot-milliseconds for the job.
	TotalSlotMs int64 `json:"totalSlotMs,omitempty,string"`

	// TransactionInfo: Output only. [Alpha] Information of the
	// multi-statement transaction if this job is part of one. This property
	// is only expected on a child job or a job that is in a session. A
	// script parent job is not part of the transaction started in the
	// script.
	TransactionInfo *TransactionInfo `json:"transactionInfo,omitempty"`

	// ForceSendFields is a list of field names (e.g. "CompletionRatio") to
	// unconditionally include in API requests. By default, fields with
	// empty or default values are omitted from API requests. However, any
	// non-pointer, non-interface field appearing in ForceSendFields will be
	// sent to the server regardless of whether the field is empty or not.
	// This may be used to include empty fields in Patch requests.
	ForceSendFields []string `json:"-"`

	// NullFields is a list of field names (e.g. "CompletionRatio") to
	// include in API requests with the JSON null value. By default, fields
	// with empty values are omitted from API requests. However, any field
	// with an empty value appearing in NullFields will be sent to the
	// server as null. It is an error if a field in this list has a
	// non-empty value. This may be used to include null fields in Patch
	// requests.
	NullFields []string `json:"-"`
}

JobStatistics: Statistics for a single job execution.

func (*JobStatistics) MarshalJSON

func (s *JobStatistics) MarshalJSON() ([]byte, error)

func (*JobStatistics) UnmarshalJSON

func (s *JobStatistics) UnmarshalJSON(data []byte) error

type JobStatistics2

type JobStatistics2 struct {
	// BiEngineStatistics: Output only. BI Engine specific Statistics.
	BiEngineStatistics *BiEngineStatistics `json:"biEngineStatistics,omitempty"`

	// BillingTier: Output only. Billing tier for the job. This is a
	// BigQuery-specific concept which is not related to the Google Cloud
	// notion of "free tier". The value here is a measure of the query's
	// resource consumption relative to the amount of data scanned. For
	// on-demand queries, the limit is 100, and all queries within this
	// limit are billed at the standard on-demand rates. On-demand queries
	// that exceed this limit will fail with a billingTierLimitExceeded
	// error.
	BillingTier int64 `json:"billingTier,omitempty"`

	// CacheHit: Output only. Whether the query result was fetched from the
	// query cache.
	CacheHit bool `json:"cacheHit,omitempty"`

	// DclTargetDataset: Output only. Referenced dataset for DCL statement.
	DclTargetDataset *DatasetReference `json:"dclTargetDataset,omitempty"`

	// DclTargetTable: Output only. Referenced table for DCL statement.
	DclTargetTable *TableReference `json:"dclTargetTable,omitempty"`

	// DclTargetView: Output only. Referenced view for DCL statement.
	DclTargetView *TableReference `json:"dclTargetView,omitempty"`

	// DdlAffectedRowAccessPolicyCount: Output only. The number of row
	// access policies affected by a DDL statement. Present only for DROP
	// ALL ROW ACCESS POLICIES queries.
	DdlAffectedRowAccessPolicyCount int64 `json:"ddlAffectedRowAccessPolicyCount,omitempty,string"`

	// DdlDestinationTable: Output only. The table after rename. Present
	// only for ALTER TABLE RENAME TO query.
	DdlDestinationTable *TableReference `json:"ddlDestinationTable,omitempty"`

	// DdlOperationPerformed: Output only. The DDL operation performed,
	// possibly dependent on the pre-existence of the DDL target.
	DdlOperationPerformed string `json:"ddlOperationPerformed,omitempty"`

	// DdlTargetDataset: Output only. The DDL target dataset. Present only
	// for CREATE/ALTER/DROP SCHEMA(dataset) queries.
	DdlTargetDataset *DatasetReference `json:"ddlTargetDataset,omitempty"`

	// DdlTargetRoutine: Output only. [Beta] The DDL target routine. Present
	// only for CREATE/DROP FUNCTION/PROCEDURE queries.
	DdlTargetRoutine *RoutineReference `json:"ddlTargetRoutine,omitempty"`

	// DdlTargetRowAccessPolicy: Output only. The DDL target row access
	// policy. Present only for CREATE/DROP ROW ACCESS POLICY queries.
	DdlTargetRowAccessPolicy *RowAccessPolicyReference `json:"ddlTargetRowAccessPolicy,omitempty"`

	// DdlTargetTable: Output only. The DDL target table. Present only for
	// CREATE/DROP TABLE/VIEW and DROP ALL ROW ACCESS POLICIES queries.
	DdlTargetTable *TableReference `json:"ddlTargetTable,omitempty"`

	// DmlStats: Output only. Detailed statistics for DML statements INSERT,
	// UPDATE, DELETE, MERGE or TRUNCATE.
	DmlStats *DmlStatistics `json:"dmlStats,omitempty"`

	// EstimatedBytesProcessed: Output only. The original estimate of bytes
	// processed for the job.
	EstimatedBytesProcessed int64 `json:"estimatedBytesProcessed,omitempty,string"`

	// ExportDataStatistics: Output only. Stats for EXPORT DATA statement.
	ExportDataStatistics *ExportDataStatistics `json:"exportDataStatistics,omitempty"`

	// ExternalServiceCosts: Output only. Job cost breakdown as bigquery
	// internal cost and external service costs.
	ExternalServiceCosts []*ExternalServiceCost `json:"externalServiceCosts,omitempty"`

	// LoadQueryStatistics: Output only. Statistics for a LOAD query.
	LoadQueryStatistics *LoadQueryStatistics `json:"loadQueryStatistics,omitempty"`

	// MaterializedViewStatistics: Output only. Statistics of materialized
	// views of a query job.
	MaterializedViewStatistics *MaterializedViewStatistics `json:"materializedViewStatistics,omitempty"`

	// MetadataCacheStatistics: Output only. Statistics of metadata cache
	// usage in a query for BigLake tables.
	MetadataCacheStatistics *MetadataCacheStatistics `json:"metadataCacheStatistics,omitempty"`

	// MlStatistics: Output only. Statistics of a BigQuery ML training job.
	MlStatistics *MlStatistics `json:"mlStatistics,omitempty"`

	// ModelTraining: Deprecated.
	ModelTraining *BigQueryModelTraining `json:"modelTraining,omitempty"`

	// ModelTrainingCurrentIteration: Deprecated.
	ModelTrainingCurrentIteration int64 `json:"modelTrainingCurrentIteration,omitempty"`

	// ModelTrainingExpectedTotalIteration: Deprecated.
	ModelTrainingExpectedTotalIteration int64 `json:"modelTrainingExpectedTotalIteration,omitempty,string"`

	// NumDmlAffectedRows: Output only. The number of rows affected by a DML
	// statement. Present only for DML statements INSERT, UPDATE or DELETE.
	NumDmlAffectedRows int64 `json:"numDmlAffectedRows,omitempty,string"`

	// PerformanceInsights: Output only. Performance insights.
	PerformanceInsights *PerformanceInsights `json:"performanceInsights,omitempty"`

	// QueryInfo: Output only. Query optimization information for a QUERY
	// job.
	QueryInfo *QueryInfo `json:"queryInfo,omitempty"`

	// QueryPlan: Output only. Describes execution plan for the query.
	QueryPlan []*ExplainQueryStage `json:"queryPlan,omitempty"`

	// ReferencedRoutines: Output only. Referenced routines for the job.
	ReferencedRoutines []*RoutineReference `json:"referencedRoutines,omitempty"`

	// ReferencedTables: Output only. Referenced tables for the job. Queries
	// that reference more than 50 tables will not have a complete list.
	ReferencedTables []*TableReference `json:"referencedTables,omitempty"`

	// ReservationUsage: Output only. Job resource usage breakdown by
	// reservation. This field reported misleading information and will no
	// longer be populated.
	ReservationUsage []*JobStatistics2ReservationUsage `json:"reservationUsage,omitempty"`

	// Schema: Output only. The schema of the results. Present only for
	// successful dry run of non-legacy SQL queries.
	Schema *TableSchema `json:"schema,omitempty"`

	// SearchStatistics: Output only. Search query specific statistics.
	SearchStatistics *SearchStatistics `json:"searchStatistics,omitempty"`

	// SparkStatistics: Output only. Statistics of a Spark procedure job.
	SparkStatistics *SparkStatistics `json:"sparkStatistics,omitempty"`

	// StatementType: Output only. The type of query statement, if valid.
	// Possible values: * `SELECT`: `SELECT`
	// (/bigquery/docs/reference/standard-sql/query-syntax#select_list)
	// statement. * `ASSERT`: `ASSERT`
	// (/bigquery/docs/reference/standard-sql/debugging-statements#assert)
	// statement. * `INSERT`: `INSERT`
	// (/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement)
	// statement. * `UPDATE`: `UPDATE`
	// (/bigquery/docs/reference/standard-sql/query-syntax#update_statement)
	// statement. * `DELETE`: `DELETE`
	// (/bigquery/docs/reference/standard-sql/data-manipulation-language)
	// statement. * `MERGE`: `MERGE`
	// (/bigquery/docs/reference/standard-sql/data-manipulation-language)
	// statement. * `CREATE_TABLE`: `CREATE TABLE`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _table_statement) statement, without `AS SELECT`. *
	// `CREATE_TABLE_AS_SELECT`: `CREATE TABLE AS SELECT`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#query_
	// statement) statement. * `CREATE_VIEW`: `CREATE VIEW`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _view_statement) statement. * `CREATE_MODEL`: `CREATE MODEL`
	// (/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#cre
	// ate_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: `CREATE
	// MATERIALIZED VIEW`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _materialized_view_statement) statement. * `CREATE_FUNCTION`: `CREATE
	// FUNCTION`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _function_statement) statement. * `CREATE_TABLE_FUNCTION`: `CREATE
	// TABLE FUNCTION`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _table_function_statement) statement. * `CREATE_PROCEDURE`: `CREATE
	// PROCEDURE`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: `CREATE ROW
	// ACCESS POLICY`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _row_access_policy_statement) statement. * `CREATE_SCHEMA`: `CREATE
	// SCHEMA`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: `CREATE
	// SNAPSHOT TABLE`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`:
	// `CREATE SEARCH INDEX`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#create
	// _search_index_statement) statement. * `DROP_TABLE`: `DROP TABLE`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#drop_t
	// able_statement) statement. * `DROP_EXTERNAL_TABLE`: `DROP EXTERNAL
	// TABLE`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#drop_e
	// xternal_table_statement) statement. * `DROP_VIEW`: `DROP VIEW`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#drop_v
	// iew_statement) statement. * `DROP_MODEL`: `DROP MODEL`
	// (/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model
	// ) statement. * `DROP_MATERIALIZED_VIEW`: `DROP MATERIALIZED VIEW`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#drop_m
	// aterialized_view_statement) statement. * `DROP_FUNCTION` : `DROP
	// FUNCTION`
	// (/bigquery/docs/reference/standard-sql/data-definition-language#drop_f
	// unction_statement) statement. * `DROP_TAB