Google BigQuery v2 API - Class BigQueryClientImpl (3.9.0) 

public sealed class BigQueryClientImpl : BigQueryClient, IDisposable

Reference documentation and code samples for the Google BigQuery v2 API class BigQueryClientImpl.

Wrapper around BigqueryService to provide simpler operations.

Inheritance

object > BigQueryClient > BigQueryClientImpl

Implements

IDisposable

Namespace

Google.Cloud.BigQuery.V2

Assembly

Google.Cloud.BigQuery.V2.dll

Remarks

This is the "default" implementation of BigQueryClient. Most client code should refer to BigQueryClient, creating instances with Create(string, GoogleCredential) and CreateAsync(string, GoogleCredential). The constructor of this class is public for the sake of constructor-based dependency injection.

Constructors

BigQueryClientImpl(ProjectReference, BigqueryService)

public BigQueryClientImpl(ProjectReference projectReference, BigqueryService service)

Constructs a new client wrapping the given BigqueryService.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
service BigqueryService

The service to wrap. Must not be null.
Remarks

Care should be taken when constructing the service: if the default serializer settings are used, result values which can be parsed as date/time values can cause problems. Where possible, either use Create(string, GoogleCredential) or construct a service using serializer settings from CreateJsonSerializersSettings().

BigQueryClientImpl(ProjectReference, BigqueryService, string)

public BigQueryClientImpl(ProjectReference projectReference, BigqueryService service, string defaultLocation)

Constructs a new client wrapping the given BigqueryService, with a specified default location for location-specific operations.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
service BigqueryService

The service to wrap. Must not be null.
defaultLocation string

The default location to use for location-specific operations. May be null.
Remarks

Care should be taken when constructing the service: if the default serializer settings are used, result values which can be parsed as date/time values can cause problems. Where possible, either use Create(string, GoogleCredential) or construct a service using serializer settings from CreateJsonSerializersSettings().

BigQueryClientImpl(string, BigqueryService)

public BigQueryClientImpl(string projectId, BigqueryService service)

Constructs a new client wrapping the given BigqueryService, with no default location.

Parameters
Name Description
projectId string

The ID of the project to work with. Must not be null.
service BigqueryService

The service to wrap. Must not be null.
Remarks

Care should be taken when constructing the service: if the default serializer settings are used, result values which can be parsed as date/time values can cause problems. Where possible, either use Create(string, GoogleCredential) or construct a service using serializer settings from CreateJsonSerializersSettings().

BigQueryClientImpl(string, BigqueryService, string)

public BigQueryClientImpl(string projectId, BigqueryService service, string defaultLocation)

Constructs a new client wrapping the given BigqueryService, with a specified default location for location-specific operations.

Parameters
Name Description
projectId string

The ID of the project to work with. Must not be null.
service BigqueryService

The service to wrap. Must not be null.
defaultLocation string

The default location to use for location-specific operations. May be null.
Remarks

Care should be taken when constructing the service: if the default serializer settings are used, result values which can be parsed as date/time values can cause problems. Where possible, either use Create(string, GoogleCredential) or construct a service using serializer settings from CreateJsonSerializersSettings().

Properties

ApplicationName

public static string ApplicationName { get; set; }

The default application name used when creating a BigqueryService. Defaults to "google-cloud-dotnet"; must not be null.

Property Value
Type Description
string
Remarks

Most applications will never want to set this, which is why it's in this class rather than BigQueryClient.

DefaultLocation

public override string DefaultLocation { get; }

The default location to use for all operations where locations can be specified, such as dataset and job creation.

Property Value
Type Description
string
Overrides

PrettyPrint

public override bool PrettyPrint { get; }

Determines whether or not responses should be formatted with whitespace for readability.

Property Value
Type Description
bool
Overrides

ProjectId

public override string ProjectId { get; }

The ID of the project this client operates on. All operations that require a project to be specified implicitly supply this ID.

Property Value
Type Description
string
Overrides

Service

public override BigqueryService Service { get; }

The underlying BigQuery service object used by this client.

Property Value
Type Description
BigqueryService
Overrides Remarks

The BigQueryClient class only provides convenience operations built on top of an existing service object. Any more complex operations which are not supported by this wrapper may wish to use the same service object as the wrapper, in order to take advantage of its configuration (for authentication, application naming etc).

Methods

CancelJob(JobReference, CancelJobOptions)

public override BigQueryJob CancelJob(JobReference jobReference, CancelJobOptions options = null)

Cancels the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options CancelJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The final state of the job.
Overrides

CancelJobAsync(JobReference, CancelJobOptions, CancellationToken)

public override Task<BigQueryJob> CancelJobAsync(JobReference jobReference, CancelJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously cancels the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options CancelJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the final state of the job.
Overrides

ClearDatasetLabels(DatasetReference, ModifyLabelsOptions)

public override IDictionary<string, string> ClearDatasetLabels(DatasetReference datasetReference, ModifyLabelsOptions options = null)

Clears all labels on the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
IDictionarystringstring

A dictionary with the labels on the dataset before they were cleared.
Overrides

ClearDatasetLabelsAsync(DatasetReference, ModifyLabelsOptions, CancellationToken)

public override Task<IDictionary<string, string>> ClearDatasetLabelsAsync(DatasetReference datasetReference, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously clears all labels on the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskIDictionarystringstring

A task representing the asynchronous operation. When complete, the result is a dictionary with the labels on the dataset before they were cleared.
Overrides

CreateCopyJob(IEnumerable<TableReference>, TableReference, CreateCopyJobOptions)

public override BigQueryJob CreateCopyJob(IEnumerable<TableReference> sources, TableReference destination, CreateCopyJobOptions options = null)

Creates a job to copy data from at least one table to another.

Parameters
Name Description
sources IEnumerableTableReference

The source tables to copy. Must not be null or empty.
destination TableReference

The destination to copy to. Must not be null.
options CreateCopyJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The job created for the copy operation.
Overrides Remarks

To avoid confusion between source and destination tables, overloads are not provided that take the individual components of table references. Instead, use GetTableReference(string, string) or GetTableReference(string, string, string) to create table references.

CreateCopyJobAsync(IEnumerable<TableReference>, TableReference, CreateCopyJobOptions, CancellationToken)

public override Task<BigQueryJob> CreateCopyJobAsync(IEnumerable<TableReference> sources, TableReference destination, CreateCopyJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a job to copy data from at least one table to another.

Parameters
Name Description
sources IEnumerableTableReference

The source tables to copy. Must not be null or empty.
destination TableReference

The destination to copy to. Must not be null.
options CreateCopyJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the job created for the copy operation.
Overrides Remarks

To avoid confusion between source and destination tables, overloads are not provided that take the individual components of table references. Instead, use GetTableReference(string, string) or GetTableReference(string, string, string) to create table references.

CreateDataset(DatasetReference, Dataset, CreateDatasetOptions)

public override BigQueryDataset CreateDataset(DatasetReference datasetReference, Dataset resource = null, CreateDatasetOptions options = null)

Creates the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the creation. May be null in which case default values will be used.
options CreateDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryDataset

The created dataset.
Overrides Remarks

If resourceDatasetReference is specified, then it must be the same as the DatasetReference obtained from the other parameters.

CreateDatasetAsync(DatasetReference, Dataset, CreateDatasetOptions, CancellationToken)

public override Task<BigQueryDataset> CreateDatasetAsync(DatasetReference datasetReference, Dataset resource = null, CreateDatasetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the creation. May be null in which case default values will be used.
options CreateDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryDataset

A task representing the asynchronous operation. When complete, the result is the created dataset.
Overrides Remarks

If resourceDatasetReference is specified, then it must be the same as the DatasetReference obtained from the other parameters.

CreateExtractJob(TableReference, IEnumerable<string>, CreateExtractJobOptions)

public override BigQueryJob CreateExtractJob(TableReference tableReference, IEnumerable<string> destinationUris, CreateExtractJobOptions options = null)

Creates a job to extract data from the specified BigQuery table to Google Cloud Storage. See the BigQuery documentation for more information on extract jobs.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
destinationUris IEnumerablestring

The Google Cloud Storage URIs (possibly including a wildcard) to extract the data to. Must not be null or empty.
options CreateExtractJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The job created for the extract operation.
Overrides

CreateExtractJobAsync(TableReference, IEnumerable<string>, CreateExtractJobOptions, CancellationToken)

public override Task<BigQueryJob> CreateExtractJobAsync(TableReference tableReference, IEnumerable<string> destinationUris, CreateExtractJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a job to extract data from the specified BigQuery table to Google Cloud Storage. See the BigQuery documentation for more information on extract jobs.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
destinationUris IEnumerablestring

The Google Cloud Storage URIs (possibly including a wildcard) to extract the data to. Must not be null or empty.
options CreateExtractJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the job created for the extract operation.
Overrides

CreateLoadJob(IEnumerable<string>, TableReference, TableSchema, CreateLoadJobOptions)

public override BigQueryJob CreateLoadJob(IEnumerable<string> sourceUris, TableReference destination, TableSchema schema, CreateLoadJobOptions options = null)

Creates a job to load data from at least one Google Cloud Storage file to a BigQuery table.

Parameters
Name Description
sourceUris IEnumerablestring

The Google Cloud Storage URIs of the files to load. Must not be null or empty.
destination TableReference

The destination table to write data to. Must not be null.
schema TableSchema

The schema for the table. May be null if the load operation does not require a schema, such as if the table already exists, the data is being loaded from a Google Cloud Datastore backup, or if the options are set to autodetect the schema.
options CreateLoadJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The job created for the load operation.
Overrides Remarks

To avoid confusion between source and destination tables, overloads are not provided that take the individual components of table references. Instead, use GetTableReference(string, string) or GetTableReference(string, string, string) to create table references.

CreateLoadJobAsync(IEnumerable<string>, TableReference, TableSchema, CreateLoadJobOptions, CancellationToken)

public override Task<BigQueryJob> CreateLoadJobAsync(IEnumerable<string> sourceUris, TableReference destination, TableSchema schema, CreateLoadJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a job to load data from at least one Google Cloud Storage file to a BigQuery table.

Parameters
Name Description
sourceUris IEnumerablestring

The Google Cloud Storage URIs of the files to load. Must not be null or empty.
destination TableReference

The destination table to write data to. Must not be null.
schema TableSchema

The schema for the table. May be null if the load operation does not require a schema, such as if the table already exists, the data is being loaded from a Google Cloud Datastore backup, or if the options are set to autodetect the schema.
options CreateLoadJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the job created for the load operation.
Overrides Remarks

To avoid confusion between source and destination tables, overloads are not provided that take the individual components of table references. Instead, use GetTableReference(string, string) or GetTableReference(string, string, string) to create table references.

CreateModelExtractJob(ModelReference, IEnumerable<string>, CreateModelExtractJobOptions)

public override BigQueryJob CreateModelExtractJob(ModelReference modelReference, IEnumerable<string> destinationUris, CreateModelExtractJobOptions options = null)

Creates a job to extract the specified BigQuery model to Google Cloud Storage. See the BigQuery documentation for more information on model extract jobs.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
destinationUris IEnumerablestring

The Google Cloud Storage URIs (possibly including a wildcard) to extract the model to. Must not be null or empty.
options CreateModelExtractJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The job created for the extract operation.
Overrides

CreateModelExtractJobAsync(ModelReference, IEnumerable<string>, CreateModelExtractJobOptions, CancellationToken)

public override Task<BigQueryJob> CreateModelExtractJobAsync(ModelReference modelReference, IEnumerable<string> destinationUris, CreateModelExtractJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a job to extract the specified BigQuery model to Google Cloud Storage. See the BigQuery documentation for more information on model extract jobs.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
destinationUris IEnumerablestring

The Google Cloud Storage URIs (possibly including a wildcard) to extract the model to. Must not be null or empty.
options CreateModelExtractJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the job created for the extract operation.
Overrides

CreateQueryJob(string, IEnumerable<BigQueryParameter>, QueryOptions)

public override BigQueryJob CreateQueryJob(string sql, IEnumerable<BigQueryParameter> parameters, QueryOptions options = null)

Creates a job for a SQL query.

Parameters
Name Description
sql string

The SQL query. Must not be null.
parameters IEnumerableBigQueryParameter

The parameters for the query. May be null, which is equivalent to specifying an empty list of parameters. Must not contain null elements.
options QueryOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The query job created. Use GetQueryResults(JobReference, GetQueryResultsOptions) to retrieve the results of the query.
Overrides

CreateQueryJobAsync(string, IEnumerable<BigQueryParameter>, QueryOptions, CancellationToken)

public override Task<BigQueryJob> CreateQueryJobAsync(string sql, IEnumerable<BigQueryParameter> parameters, QueryOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates a job for a SQL query.

Parameters
Name Description
sql string

The SQL query. Must not be null.
parameters IEnumerableBigQueryParameter

The parameters for the query. May be null, which is equivalent to specifying an empty list of parameters. Must not contain null elements.
options QueryOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the query job created. Use GetQueryResultsAsync(JobReference, GetQueryResultsOptions, CancellationToken) to retrieve the results of the query.
Overrides

CreateRoutine(RoutineReference, Routine, CreateRoutineOptions)

public override BigQueryRoutine CreateRoutine(RoutineReference routineReference, Routine resource, CreateRoutineOptions options = null)

Creates the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the creation. Must not be null. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options CreateRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryRoutine

The newly created routine.
Overrides

CreateRoutineAsync(RoutineReference, Routine, CreateRoutineOptions, CancellationToken)

public override Task<BigQueryRoutine> CreateRoutineAsync(RoutineReference routineReference, Routine resource, CreateRoutineOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the creation. Must not be null. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options CreateRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryRoutine

A task representing the asynchronous operation. When complete, the result is the newly created routine.
Overrides

CreateTable(TableReference, Table, CreateTableOptions)

public override BigQueryTable CreateTable(TableReference tableReference, Table resource, CreateTableOptions options = null)

Creates the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the creation. Must not be null. If this table's TableReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options CreateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The newly created table.
Overrides

CreateTable(TableReference, TableSchema, CreateTableOptions)

public override BigQueryTable CreateTable(TableReference tableReference, TableSchema schema, CreateTableOptions options = null)

Creates the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema for the new table. Must not be null.
options CreateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The newly created table.
Overrides

CreateTableAsync(TableReference, Table, CreateTableOptions, CancellationToken)

public override Task<BigQueryTable> CreateTableAsync(TableReference tableReference, Table resource, CreateTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the creation. Must not be null. If this table's TableReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options CreateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the newly created table.
Overrides

CreateTableAsync(TableReference, TableSchema, CreateTableOptions, CancellationToken)

public override Task<BigQueryTable> CreateTableAsync(TableReference tableReference, TableSchema schema, CreateTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously creates the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema for the new table. Must not be null.
options CreateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the newly created table.
Overrides

DeleteDataset(DatasetReference, DeleteDatasetOptions)

public override void DeleteDataset(DatasetReference datasetReference, DeleteDatasetOptions options = null)

Deletes the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options DeleteDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Overrides

DeleteDatasetAsync(DatasetReference, DeleteDatasetOptions, CancellationToken)

public override Task DeleteDatasetAsync(DatasetReference datasetReference, DeleteDatasetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options DeleteDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides

DeleteJob(JobReference, DeleteJobOptions)

public override void DeleteJob(JobReference jobReference, DeleteJobOptions options = null)

Deletes the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options DeleteJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Overrides

DeleteJobAsync(JobReference, DeleteJobOptions, CancellationToken)

public override Task DeleteJobAsync(JobReference jobReference, DeleteJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options DeleteJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides

DeleteModel(ModelReference, DeleteModelOptions)

public override void DeleteModel(ModelReference modelReference, DeleteModelOptions options = null)

Deletes the specified model.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
options DeleteModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
Overrides

DeleteModelAsync(ModelReference, DeleteModelOptions, CancellationToken)

public override Task DeleteModelAsync(ModelReference modelReference, DeleteModelOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes the specified model.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
options DeleteModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides

DeleteRoutine(RoutineReference, DeleteRoutineOptions)

public override void DeleteRoutine(RoutineReference routineReference, DeleteRoutineOptions options = null)

Deletes the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
options DeleteRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
Overrides

DeleteRoutineAsync(RoutineReference, DeleteRoutineOptions, CancellationToken)

public override Task DeleteRoutineAsync(RoutineReference routineReference, DeleteRoutineOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
options DeleteRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides

DeleteTable(TableReference, DeleteTableOptions)

public override void DeleteTable(TableReference tableReference, DeleteTableOptions options = null)

Deletes the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options DeleteTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Overrides

DeleteTableAsync(TableReference, DeleteTableOptions, CancellationToken)

public override Task DeleteTableAsync(TableReference tableReference, DeleteTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously deletes the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options DeleteTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Task

A task representing the asynchronous operation.
Overrides

Dispose()

public override void Dispose()

Dispose of this instance. See the BigQueryClient remarks on when this should be called.

Overrides

GetBigQueryServiceAccountEmail(ProjectReference, GetBigQueryServiceAccountEmailOptions)

public override string GetBigQueryServiceAccountEmail(ProjectReference projectReference, GetBigQueryServiceAccountEmailOptions options = null)

Retrieves the service account email address that Google Cloud BigQuery uses for operations on other services such as the Google Cloud Key Management Service.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options GetBigQueryServiceAccountEmailOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
string

The email address of the service account.
Overrides

GetBigQueryServiceAccountEmailAsync(ProjectReference, GetBigQueryServiceAccountEmailOptions, CancellationToken)

public override Task<string> GetBigQueryServiceAccountEmailAsync(ProjectReference projectReference, GetBigQueryServiceAccountEmailOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the service account email address that Google Cloud BigQuery uses for operations on other services such as the Google Cloud Key Management Service.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options GetBigQueryServiceAccountEmailOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Taskstring

A task representing the asynchronous operation. When complete, the result is the email address of the service account.
Overrides

GetDataset(DatasetReference, GetDatasetOptions)

public override BigQueryDataset GetDataset(DatasetReference datasetReference, GetDatasetOptions options = null)

Retrieves the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options GetDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryDataset

The requested dataset.
Overrides

GetDatasetAsync(DatasetReference, GetDatasetOptions, CancellationToken)

public override Task<BigQueryDataset> GetDatasetAsync(DatasetReference datasetReference, GetDatasetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options GetDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryDataset

A task representing the asynchronous operation. When complete, the result is the requested dataset.
Overrides

GetJob(JobReference, GetJobOptions)

public override BigQueryJob GetJob(JobReference jobReference, GetJobOptions options = null)

Retrieves the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The retrieved job.
Overrides

GetJobAsync(JobReference, GetJobOptions, CancellationToken)

public override Task<BigQueryJob> GetJobAsync(JobReference jobReference, GetJobOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the specified job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the retrieved job.
Overrides

GetModel(ModelReference, GetModelOptions)

public override BigQueryModel GetModel(ModelReference modelReference, GetModelOptions options = null)

Retrieves the specified model.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
options GetModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryModel

The requested model.
Overrides

GetModelAsync(ModelReference, GetModelOptions, CancellationToken)

public override Task<BigQueryModel> GetModelAsync(ModelReference modelReference, GetModelOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the specified model.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
options GetModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryModel

A task representing the asynchronous operation. When complete, the result is the requested model.
Overrides

GetOrCreateDataset(DatasetReference, Dataset, GetDatasetOptions, CreateDatasetOptions)

public override BigQueryDataset GetOrCreateDataset(DatasetReference datasetReference, Dataset resource = null, GetDatasetOptions getOptions = null, CreateDatasetOptions createOptions = null)

Attempts to fetch the specified dataset, creating it if it doesn't exist.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the creation. May be null in which case default values will be used.
getOptions GetDatasetOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateDatasetOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryDataset

The existing or new dataset.
Overrides Remarks

If resourceDatasetReference is specified, then it must be the same as the DatasetReference obtained from the other parameters.

GetOrCreateDatasetAsync(DatasetReference, Dataset, GetDatasetOptions, CreateDatasetOptions, CancellationToken)

public override Task<BigQueryDataset> GetOrCreateDatasetAsync(DatasetReference datasetReference, Dataset resource = null, GetDatasetOptions getOptions = null, CreateDatasetOptions createOptions = null, CancellationToken cancellationToken = default)

Asynchronously attempts to fetch the specified dataset, creating it if it doesn't exist.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the creation. May be null in which case default values will be used.
getOptions GetDatasetOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateDatasetOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryDataset

A task representing the asynchronous operation. When complete, the result is the existing or new dataset.
Overrides Remarks

If resourceDatasetReference is specified, then it must be the same as the DatasetReference obtained from the other parameters.

GetOrCreateRoutine(RoutineReference, Routine, GetRoutineOptions, CreateRoutineOptions)

public override BigQueryRoutine GetOrCreateRoutine(RoutineReference routineReference, Routine resource, GetRoutineOptions getOptions = null, CreateRoutineOptions createOptions = null)

Attempts to fetch the specified routine, creating it if it doesn't exist.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the creation. Must not be null. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
getOptions GetRoutineOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateRoutineOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryRoutine

The existing or new routine.
Overrides

GetOrCreateRoutineAsync(RoutineReference, Routine, GetRoutineOptions, CreateRoutineOptions, CancellationToken)

public override Task<BigQueryRoutine> GetOrCreateRoutineAsync(RoutineReference routineReference, Routine resource, GetRoutineOptions getOptions = null, CreateRoutineOptions createOptions = null, CancellationToken cancellationToken = default)

Asynchronously attempts to fetch the specified routine, creating it if it doesn't exist.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the creation. Must not be null. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
getOptions GetRoutineOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateRoutineOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryRoutine

A task representing the asynchronous operation. When complete, the result is the existing or new routine.
Overrides

GetOrCreateTable(TableReference, Table, GetTableOptions, CreateTableOptions)

public override BigQueryTable GetOrCreateTable(TableReference tableReference, Table resource, GetTableOptions getOptions = null, CreateTableOptions createOptions = null)

Attempts to fetch the specified table, creating it if it doesn't exist.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the creation. Must not be null. If this table's TableReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
getOptions GetTableOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateTableOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The existing or new table.
Overrides

GetOrCreateTable(TableReference, TableSchema, GetTableOptions, CreateTableOptions)

public override BigQueryTable GetOrCreateTable(TableReference tableReference, TableSchema schema, GetTableOptions getOptions = null, CreateTableOptions createOptions = null)

Attempts to fetch the specified table, creating it if it doesn't exist.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema for the new table. Must not be null.
getOptions GetTableOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateTableOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The existing or new table.
Overrides

GetOrCreateTableAsync(TableReference, Table, GetTableOptions, CreateTableOptions, CancellationToken)

public override Task<BigQueryTable> GetOrCreateTableAsync(TableReference tableReference, Table resource, GetTableOptions getOptions = null, CreateTableOptions createOptions = null, CancellationToken cancellationToken = default)

Asynchronously attempts to fetch the specified table, creating it if it doesn't exist.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the creation. Must not be null. If this table's TableReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
getOptions GetTableOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateTableOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the existing or new table.
Overrides

GetOrCreateTableAsync(TableReference, TableSchema, GetTableOptions, CreateTableOptions, CancellationToken)

public override Task<BigQueryTable> GetOrCreateTableAsync(TableReference tableReference, TableSchema schema, GetTableOptions getOptions = null, CreateTableOptions createOptions = null, CancellationToken cancellationToken = default)

Asynchronously attempts to fetch the specified table, creating it if it doesn't exist.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema for the new table. Must not be null.
getOptions GetTableOptions

The options for the "get" operation. May be null, in which case defaults will be supplied.
createOptions CreateTableOptions

The options for the "create" operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the existing or new table.
Overrides

GetQueryResults(JobReference, GetQueryResultsOptions)

public override BigQueryResults GetQueryResults(JobReference jobReference, GetQueryResultsOptions options = null)

Retrieves the results of the specified job, which must be a query job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetQueryResultsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryResults

The results of the query.
Overrides Remarks

This operation will only complete when the specified query has completed.

GetQueryResultsAsync(JobReference, GetQueryResultsOptions, CancellationToken)

public override Task<BigQueryResults> GetQueryResultsAsync(JobReference jobReference, GetQueryResultsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the results of the specified job, which must be a query job.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetQueryResultsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryResults

A task representing the asynchronous operation. When complete, the result is the results of the query.
Overrides Remarks

This operation will only complete when the specified query has completed.

GetRoutine(RoutineReference, GetRoutineOptions)

public override BigQueryRoutine GetRoutine(RoutineReference routineReference, GetRoutineOptions options = null)

Retrieves the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
options GetRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryRoutine

The requested routine.
Overrides

GetRoutineAsync(RoutineReference, GetRoutineOptions, CancellationToken)

public override Task<BigQueryRoutine> GetRoutineAsync(RoutineReference routineReference, GetRoutineOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the specified routine.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
options GetRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryRoutine

A task representing the asynchronous operation. When complete, the result is the requested routine.
Overrides

GetTable(TableReference, GetTableOptions)

public override BigQueryTable GetTable(TableReference tableReference, GetTableOptions options = null)

Retrieves the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options GetTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The requested table.
Overrides

GetTableAsync(TableReference, GetTableOptions, CancellationToken)

public override Task<BigQueryTable> GetTableAsync(TableReference tableReference, GetTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously retrieves the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options GetTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the requested table.
Overrides

GetTableIamPolicy(TableReference, GetTableIamPolicyOptions)

public override Policy GetTableIamPolicy(TableReference tableReference, GetTableIamPolicyOptions options = null)

Gets the IAM policy applied to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options GetTableIamPolicyOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
Policy

The table's IAM policy.
Overrides

GetTableIamPolicyAsync(TableReference, GetTableIamPolicyOptions, CancellationToken)

public override Task<Policy> GetTableIamPolicyAsync(TableReference tableReference, GetTableIamPolicyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously gets the IAM policy applied to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
options GetTableIamPolicyOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskPolicy

A task representing the asynchronous operation. When complete, the result is the table's IAM policy.
Overrides

InsertRows(TableReference, IEnumerable<BigQueryInsertRow>, InsertOptions)

public override BigQueryInsertResults InsertRows(TableReference tableReference, IEnumerable<BigQueryInsertRow> rows, InsertOptions options = null)

Inserts all the given rows of data into the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
rows IEnumerableBigQueryInsertRow

The data to insert. Must not be null, or contain null entries.
options InsertOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryInsertResults

An insert result object which contains information on insert errors if any.
Overrides

InsertRowsAsync(TableReference, IEnumerable<BigQueryInsertRow>, InsertOptions, CancellationToken)

public override Task<BigQueryInsertResults> InsertRowsAsync(TableReference tableReference, IEnumerable<BigQueryInsertRow> rows, InsertOptions options = null, CancellationToken cancellationToken = default)

Asynchronously inserts all the given rows of data into the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
rows IEnumerableBigQueryInsertRow

The data to insert. Must not be null, or contain null entries.
options InsertOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryInsertResults

A task representing the asynchronous operation. When complete, the result is an insert result object which contains information on insert errors if any.
Overrides

ListDatasets(ProjectReference, ListDatasetsOptions)

public override PagedEnumerable<DatasetList, BigQueryDataset> ListDatasets(ProjectReference projectReference, ListDatasetsOptions options = null)

Lists the datasets within the specified project.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options ListDatasetsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableDatasetListBigQueryDataset

A sequence of datasets within the specified project.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListDatasetsAsync(ProjectReference, ListDatasetsOptions)

public override PagedAsyncEnumerable<DatasetList, BigQueryDataset> ListDatasetsAsync(ProjectReference projectReference, ListDatasetsOptions options = null)

Asynchronously lists the datasets within the specified project.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options ListDatasetsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableDatasetListBigQueryDataset

An asynchronous sequence of datasets within the specified project.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListJobs(ProjectReference, ListJobsOptions)

public override PagedEnumerable<JobList, BigQueryJob> ListJobs(ProjectReference projectReference, ListJobsOptions options = null)

Lists the jobs within the specified project.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options ListJobsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableJobListBigQueryJob

A sequence of the jobs within the specified project.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListJobsAsync(ProjectReference, ListJobsOptions)

public override PagedAsyncEnumerable<JobList, BigQueryJob> ListJobsAsync(ProjectReference projectReference, ListJobsOptions options = null)

Asynchronously lists the jobs within the specified project.

Parameters
Name Description
projectReference ProjectReference

A fully-qualified identifier for the project. Must not be null.
options ListJobsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableJobListBigQueryJob

An asynchronous sequence of the jobs within the specified project.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListModels(DatasetReference, ListModelsOptions)

public override PagedEnumerable<ListModelsResponse, BigQueryModel> ListModels(DatasetReference datasetReference, ListModelsOptions options = null)

Lists the models in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListModelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableListModelsResponseBigQueryModel

A sequence of models within the dataset.
Overrides Remarks

The returned models will not have all the properties in the resource populated. For complete information, make a GetModel call for each model you need the details of.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListModelsAsync(DatasetReference, ListModelsOptions)

public override PagedAsyncEnumerable<ListModelsResponse, BigQueryModel> ListModelsAsync(DatasetReference datasetReference, ListModelsOptions options = null)

Lists the models in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListModelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableListModelsResponseBigQueryModel

A sequence of models within the dataset.
Overrides Remarks

The returned models will not have all the properties in the resource populated. For complete information, make a GetModel call for each model you need the details of.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListProjects(ListProjectsOptions)

public override PagedEnumerable<ProjectList, CloudProject> ListProjects(ListProjectsOptions options = null)

Lists the cloud projects available using the current credentials.

Parameter
Name Description
options ListProjectsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableProjectListCloudProject

A sequence of projects the user has access to.
Overrides Remarks

The project associated with this client is irrelevant for this operation.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListProjectsAsync(ListProjectsOptions)

public override PagedAsyncEnumerable<ProjectList, CloudProject> ListProjectsAsync(ListProjectsOptions options = null)

Asynchronously lists the cloud projects available using the current credentials.

Parameter
Name Description
options ListProjectsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableProjectListCloudProject

An asynchronous sequence of projects the user has access to.
Overrides Remarks

The project associated with this client is irrelevant for this operation.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListRoutines(DatasetReference, ListRoutinesOptions)

public override PagedEnumerable<ListRoutinesResponse, BigQueryRoutine> ListRoutines(DatasetReference datasetReference, ListRoutinesOptions options = null)

Lists the routines in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListRoutinesOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableListRoutinesResponseBigQueryRoutine

A sequence of tables within the dataset.
Overrides Remarks

The returned routines will contain populated properties as specified by ReadMask or the default ones. ReadMask for more information.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListRoutinesAsync(DatasetReference, ListRoutinesOptions)

public override PagedAsyncEnumerable<ListRoutinesResponse, BigQueryRoutine> ListRoutinesAsync(DatasetReference datasetReference, ListRoutinesOptions options = null)

Lists the routines in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListRoutinesOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableListRoutinesResponseBigQueryRoutine

A sequence of routines within the dataset.
Overrides Remarks

The returned routines will contain populated properties as specified by ReadMask or the default ones. ReadMask for more information.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListRows(TableReference, TableSchema, ListRowsOptions)

public override PagedEnumerable<TableDataList, BigQueryRow> ListRows(TableReference tableReference, TableSchema schema = null, ListRowsOptions options = null)

Lists the rows within a table, similar to a SELECT * FROM ... query.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema to use when interpreting results. If this is a partial schema, then partial rows will be fetched. See SelectedFields for how to obtain a table's partial schema. This may be null or empty (i.e. Fields null or empty), in which case it will be fetched from the table first.
options ListRowsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableTableDataListBigQueryRow

The results of listing the rows within the table.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListRowsAsync(TableReference, TableSchema, ListRowsOptions)

public override PagedAsyncEnumerable<TableDataList, BigQueryRow> ListRowsAsync(TableReference tableReference, TableSchema schema = null, ListRowsOptions options = null)

Lists the rows within a table, similar to a SELECT * FROM ... query.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema to use when interpreting results. This may be null, in which case it will be fetched from the table first.
options ListRowsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableTableDataListBigQueryRow

An asynchronous sequence of the rows within the table.
Overrides Remarks

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListTables(DatasetReference, ListTablesOptions)

public override PagedEnumerable<TableList, BigQueryTable> ListTables(DatasetReference datasetReference, ListTablesOptions options = null)

Lists the tables in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListTablesOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedEnumerableTableListBigQueryTable

A sequence of tables within the dataset.
Overrides Remarks

The returned tables will not have all the properties in the resource populated. For complete information, make a GetTable call for each table you need the details of.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ListTablesAsync(DatasetReference, ListTablesOptions)

public override PagedAsyncEnumerable<TableList, BigQueryTable> ListTablesAsync(DatasetReference datasetReference, ListTablesOptions options = null)

Lists the tables in a dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
options ListTablesOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
PagedAsyncEnumerableTableListBigQueryTable

A sequence of tables within the dataset.
Overrides Remarks

The returned tables will not have all the properties in the resource populated. For complete information, make a GetTable call for each table you need the details of.

No network requests are made until the returned sequence is enumerated. This means that any exception due to an invalid request will be deferred until that time. Callers should be prepared for exceptions to be thrown while enumerating the results. In addition to failures due to invalid requests, network or service failures can cause exceptions even after the first results have been returned.

ModifyDatasetLabels(DatasetReference, IDictionary<string, string>, ModifyLabelsOptions)

public override IDictionary<string, string> ModifyDatasetLabels(DatasetReference datasetReference, IDictionary<string, string> labels, ModifyLabelsOptions options = null)

Sets or removes one or more labels on the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labels IDictionarystringstring

The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
IDictionarystringstring

A dictionary with the same keys as labels, and values indicating the corresponding label value before this operation completed. Labels which weren't present on the dataset before the modification have corresponding null values in the returned dictionary.
Overrides Remarks

Each entry in labels is treated as a label to set or remove. If the value is null, it will be removed from the dataset; otherwise, it will be set/added. Labels which do not have an entry in the dictionary will be ignored.

ModifyDatasetLabelsAsync(DatasetReference, IDictionary<string, string>, ModifyLabelsOptions, CancellationToken)

public override Task<IDictionary<string, string>> ModifyDatasetLabelsAsync(DatasetReference datasetReference, IDictionary<string, string> labels, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously sets or removes one or more labels on the specified dataset.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labels IDictionarystringstring

The labels to set. Must contain at least one entry; keys must not be null, but values may be (indicating label removal).
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskIDictionarystringstring

A task representing the asynchronous operation. When complete, the result is a dictionary with the same keys as labels, and values indicating the corresponding label value before this operation completed. Labels which weren't present on the dataset before the modification have corresponding null values in the returned dictionary.
Overrides Remarks

Each entry in labels is treated as a label to set or remove. If the value is null, it will be removed from the dataset; otherwise, it will be set/added. Labels which do not have an entry in the dictionary will be ignored.

PatchDataset(DatasetReference, Dataset, PatchDatasetOptions)

public override BigQueryDataset PatchDataset(DatasetReference datasetReference, Dataset resource, PatchDatasetOptions options = null)

Patches the specified dataset with fields in the given resource.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryDataset

The updated dataset.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PatchDatasetAsync(DatasetReference, Dataset, PatchDatasetOptions, CancellationToken)

public override Task<BigQueryDataset> PatchDatasetAsync(DatasetReference datasetReference, Dataset resource, PatchDatasetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously patches the specified dataset with fields in the given resource.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryDataset

A task representing the asynchronous operation. When complete, the result is the updated dataset.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PatchModel(ModelReference, Model, PatchModelOptions)

public override BigQueryModel PatchModel(ModelReference modelReference, Model resource, PatchModelOptions options = null)

Patches the specified model with fields in the given resource.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
resource Model

The model resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryModel

The updated model.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PatchModelAsync(ModelReference, Model, PatchModelOptions, CancellationToken)

public override Task<BigQueryModel> PatchModelAsync(ModelReference modelReference, Model resource, PatchModelOptions options = null, CancellationToken cancellationToken = default)

Asynchronously patches the specified model with fields in the given resource.

Parameters
Name Description
modelReference ModelReference

A fully-qualified identifier for the model. Must not be null.
resource Model

The model resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchModelOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryModel

A task representing the asynchronous operation. When complete, the result is the updated model.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PatchTable(TableReference, Table, PatchTableOptions)

public override BigQueryTable PatchTable(TableReference tableReference, Table resource, PatchTableOptions options = null)

Patches the specified table with fields in the given resource.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The updated table.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PatchTableAsync(TableReference, Table, PatchTableOptions, CancellationToken)

public override Task<BigQueryTable> PatchTableAsync(TableReference tableReference, Table resource, PatchTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously patches the specified table with fields in the given resource.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the patch. Only fields present in the resource will be updated.
options PatchTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the updated table.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

PollJobUntilCompleted(JobReference, GetJobOptions, PollSettings)

public override BigQueryJob PollJobUntilCompleted(JobReference jobReference, GetJobOptions options = null, PollSettings pollSettings = null)

Polls the specified job for completion.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
pollSettings PollSettings

The settings to control how often and long the job is fetched before timing out if it is still incomplete. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

The completed job.
Overrides

PollJobUntilCompletedAsync(JobReference, GetJobOptions, PollSettings, CancellationToken)

public override Task<BigQueryJob> PollJobUntilCompletedAsync(JobReference jobReference, GetJobOptions options = null, PollSettings pollSettings = null, CancellationToken cancellationToken = default)

Asynchronously polls the specified job for completion.

Parameters
Name Description
jobReference JobReference

A fully-qualified identifier for the job. Must not be null.
options GetJobOptions

The options for the operation. May be null, in which case defaults will be supplied.
pollSettings PollSettings

The settings to control how often and long the job is fetched before timing out if it is still incomplete. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is the completed job.
Overrides

RemoveDatasetLabel(DatasetReference, string, ModifyLabelsOptions)

public override string RemoveDatasetLabel(DatasetReference datasetReference, string labelName, ModifyLabelsOptions options = null)

Removes a label from a dataset, if it previously existed. It is not an error to attempt to remove a label that doesn't already exist.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labelName string

The name of the label. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
string

The previous value of the label, or null if the label was not previously set.
Overrides

RemoveDatasetLabelAsync(DatasetReference, string, ModifyLabelsOptions, CancellationToken)

public override Task<string> RemoveDatasetLabelAsync(DatasetReference datasetReference, string labelName, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously removes a label from a dataset, if it previously existed. It is not an error to attempt to remove a label that doesn't already exist.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labelName string

The name of the label. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Taskstring

A task representing the asynchronous operation. When complete, the result is the previous value of the label, or null if the label was not previously set.
Overrides

SetDatasetLabel(DatasetReference, string, string, ModifyLabelsOptions)

public override string SetDatasetLabel(DatasetReference datasetReference, string labelName, string labelValue, ModifyLabelsOptions options = null)

Sets the value for a single label on a dataset. The label will be added if it does not exist, or updated if it already exists.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labelName string

The name of the label. Must not be null.
labelValue string

The new value of the label. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
string

The previous value of the label, or null if the label was not previously set.
Overrides Remarks

The dataset is first fetched to retrieve the current values, then a patch call is made.

SetDatasetLabelAsync(DatasetReference, string, string, ModifyLabelsOptions, CancellationToken)

public override Task<string> SetDatasetLabelAsync(DatasetReference datasetReference, string labelName, string labelValue, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously sets the value for a single label on a dataset. The label will be added if it does not exist, or updated if it already exists.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
labelName string

The name of the label. Must not be null.
labelValue string

The new value of the label. Must not be null.
options ModifyLabelsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
Taskstring

A task representing the asynchronous operation. When complete, the result is the previous value of the label, or null if the label was not previously set.
Overrides Remarks

The dataset is first fetched to retrieve the current values, then a patch call is made.

SetTableIamPolicy(TableReference, Policy, SetTableIamPolicyOptions)

public override Policy SetTableIamPolicy(TableReference tableReference, Policy policy, SetTableIamPolicyOptions options = null)

Applies the given IAM policy to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
policy Policy

The policy to set on the table. An update mask may be specified through options.
options SetTableIamPolicyOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
Policy

The resulting IAM policy after aplying the given policy.
Overrides

SetTableIamPolicyAsync(TableReference, Policy, SetTableIamPolicyOptions, CancellationToken)

public override Task<Policy> SetTableIamPolicyAsync(TableReference tableReference, Policy policy, SetTableIamPolicyOptions options = null, CancellationToken cancellationToken = default)

Asynchronously applies the given IAM policy to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
policy Policy

The policy to set on the table. An update mask may be specified through options.
options SetTableIamPolicyOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskPolicy

A task representing the asynchronous operation. When complete, the result is the resulting IAM policy after aplying the given policy.
Overrides

TestTableIamPermissions(TableReference, IList<string>, TestTableIamPermissionsOptions)

public override TestIamPermissionsResponse TestTableIamPermissions(TableReference tableReference, IList<string> permissions, TestTableIamPermissionsOptions options = null)

Returns the subset of permissions that the caller has on the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
permissions IListstring

The permissions to test on the table.
options TestTableIamPermissionsOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
TestIamPermissionsResponse

The subset of permissions that the caller has on {target}.
Overrides

TestTableIamPermissionsAsync(TableReference, IList<string>, TestTableIamPermissionsOptions, CancellationToken)

public override Task<TestIamPermissionsResponse> TestTableIamPermissionsAsync(TableReference tableReference, IList<string> permissions, TestTableIamPermissionsOptions options = null, CancellationToken cancellationToken = default)

Asynchronously returns the subset of permissions that the caller has on the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
permissions IListstring

The permissions to test on the table.
options TestTableIamPermissionsOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskTestIamPermissionsResponse

A task representing the asynchronous operation. When complete, the result is the subset of permissions that the caller has on {target}.
Overrides

UpdateDataset(DatasetReference, Dataset, UpdateDatasetOptions)

public override BigQueryDataset UpdateDataset(DatasetReference datasetReference, Dataset resource, UpdateDatasetOptions options = null)

Updates the specified dataset to match the specified resource.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the update. All updatable fields will be updated.
options UpdateDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryDataset

The updated dataset.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UpdateDatasetAsync(DatasetReference, Dataset, UpdateDatasetOptions, CancellationToken)

public override Task<BigQueryDataset> UpdateDatasetAsync(DatasetReference datasetReference, Dataset resource, UpdateDatasetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously updates the specified dataset to match the specified resource.

Parameters
Name Description
datasetReference DatasetReference

A fully-qualified identifier for the dataset. Must not be null.
resource Dataset

The dataset resource representation to use for the update. All updatable fields will be updated.
options UpdateDatasetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryDataset

A task representing the asynchronous operation. When complete, the result is the updated dataset.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UpdateRoutine(RoutineReference, Routine, UpdateRoutineOptions)

public override BigQueryRoutine UpdateRoutine(RoutineReference routineReference, Routine resource, UpdateRoutineOptions options = null)

Updates the specified routine to match the specified resource.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the update. All updatable fields will be updated. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options UpdateRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryRoutine

The updated routine.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UpdateRoutineAsync(RoutineReference, Routine, UpdateRoutineOptions, CancellationToken)

public override Task<BigQueryRoutine> UpdateRoutineAsync(RoutineReference routineReference, Routine resource, UpdateRoutineOptions options = null, CancellationToken cancellationToken = default)

Asynchronously updates the specified routine to match the specified resource.

Parameters
Name Description
routineReference RoutineReference

A fully-qualified identifier for the routine. Must not be null.
resource Routine

The routine resource representation to use for the update. All updatable fields will be updated. If this routine's RoutineReference is specified, then it must be the same as the one obtained from the other parameters, else it will be set to the one obtained from the other parameters.
options UpdateRoutineOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryRoutine

A task representing the asynchronous operation. When complete, the result is the updated routine.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UpdateTable(TableReference, Table, UpdateTableOptions)

public override BigQueryTable UpdateTable(TableReference tableReference, Table resource, UpdateTableOptions options = null)

Updates the specified table to match the specified resource.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the update. All updatable fields will be updated.
options UpdateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryTable

The updated table.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UpdateTableAsync(TableReference, Table, UpdateTableOptions, CancellationToken)

public override Task<BigQueryTable> UpdateTableAsync(TableReference tableReference, Table resource, UpdateTableOptions options = null, CancellationToken cancellationToken = default)

Asynchronously updates the specified table to match the specified resource.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
resource Table

The table resource representation to use for the update. All updatable fields will be updated.
options UpdateTableOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryTable

A task representing the asynchronous operation. When complete, the result is the updated table.
Overrides Remarks

If the resource contains an ETag, it is used for optimistic concurrency validation.

UploadAvro(TableReference, TableSchema, Stream, UploadAvroOptions)

public override BigQueryJob UploadAvro(TableReference tableReference, TableSchema schema, Stream input, UploadAvroOptions options = null)

Uploads a stream of Avro data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

Unused. In earlier versions this specified the schema of the data, but it is now ignored as the schema is always inferred from the data. The parameter is only present for backward compatibility.
input Stream

The stream of input data. Must not be null.
options UploadAvroOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides

UploadAvroAsync(TableReference, TableSchema, Stream, UploadAvroOptions, CancellationToken)

public override Task<BigQueryJob> UploadAvroAsync(TableReference tableReference, TableSchema schema, Stream input, UploadAvroOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a stream of Avro data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

Unused. In earlier versions this specified the schema of the data, but it is now ignored as the schema is always inferred from the data. The parameter is only present for backward compatibility.
input Stream

The stream of input data. Must not be null.
options UploadAvroOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides

UploadCsv(TableReference, TableSchema, Stream, UploadCsvOptions)

public override BigQueryJob UploadCsv(TableReference tableReference, TableSchema schema, Stream input, UploadCsvOptions options = null)

Uploads a stream of CSV data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
input Stream

The stream of input data. Must not be null.
options UploadCsvOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides Remarks

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadCsvAsync(TableReference, TableSchema, Stream, UploadCsvOptions, CancellationToken)

public override Task<BigQueryJob> UploadCsvAsync(TableReference tableReference, TableSchema schema, Stream input, UploadCsvOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a stream of CSV data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
input Stream

The stream of input data. Must not be null.
options UploadCsvOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides Remarks

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadJson(TableReference, TableSchema, IEnumerable<string>, UploadJsonOptions)

public override BigQueryJob UploadJson(TableReference tableReference, TableSchema schema, IEnumerable<string> rows, UploadJsonOptions options = null)

Uploads a sequence of JSON rows to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
rows IEnumerablestring

The sequence of JSON strings to upload. Must not be null, and must not contain null elements.
options UploadJsonOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides Remarks

Each element of rows is converted into a single line of text by replacing carriage returns and line feeds with spaces. This is safe as they cannot exist within well-formed JSON keys or values, and simply means that the original JSON can be formatted however you choose.

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadJson(TableReference, TableSchema, Stream, UploadJsonOptions)

public override BigQueryJob UploadJson(TableReference tableReference, TableSchema schema, Stream input, UploadJsonOptions options = null)

Uploads a stream of JSON data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
input Stream

The stream of input data. Must not be null.
options UploadJsonOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides Remarks

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadJsonAsync(TableReference, TableSchema, IEnumerable<string>, UploadJsonOptions, CancellationToken)

public override Task<BigQueryJob> UploadJsonAsync(TableReference tableReference, TableSchema schema, IEnumerable<string> rows, UploadJsonOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a sequence of JSON rows to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
rows IEnumerablestring

The sequence of JSON strings to upload. Must not be null, and must not contain null elements.
options UploadJsonOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides Remarks

Each element of rows is converted into a single line of text by replacing carriage returns and line feeds with spaces. This is safe as they cannot exist within well-formed JSON keys or values, and simply means that the original JSON can be formatted however you choose.

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadJsonAsync(TableReference, TableSchema, Stream, UploadJsonOptions, CancellationToken)

public override Task<BigQueryJob> UploadJsonAsync(TableReference tableReference, TableSchema schema, Stream input, UploadJsonOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a stream of JSON data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
schema TableSchema

The schema of the data, or null for the schema to be loaded from the destination table or inferred (based on options).
input Stream

The stream of input data. Must not be null.
options UploadJsonOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides Remarks

The schema can come from three places: it can be specified by schema, it can be retrieved from the destination table if that already exists, or it can be inferred by the server. If schema is null and the Autodetect of options is not set to true, it is expected that the table already exists, and its schema is loaded automatically.

UploadOrc(TableReference, Stream, UploadOrcOptions)

public override BigQueryJob UploadOrc(TableReference tableReference, Stream input, UploadOrcOptions options = null)

Uploads a stream of ORC data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
input Stream

The stream of input data. Must not be null.
options UploadOrcOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides

UploadOrcAsync(TableReference, Stream, UploadOrcOptions, CancellationToken)

public override Task<BigQueryJob> UploadOrcAsync(TableReference tableReference, Stream input, UploadOrcOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a stream of ORC data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
input Stream

The stream of input data. Must not be null.
options UploadOrcOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides

UploadParquet(TableReference, Stream, UploadParquetOptions)

public override BigQueryJob UploadParquet(TableReference tableReference, Stream input, UploadParquetOptions options = null)

Uploads a stream of Parquet data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
input Stream

The stream of input data. Must not be null.
options UploadParquetOptions

The options for the operation. May be null, in which case defaults will be supplied.
Returns
Type Description
BigQueryJob

A data upload job.
Overrides

UploadParquetAsync(TableReference, Stream, UploadParquetOptions, CancellationToken)

public override Task<BigQueryJob> UploadParquetAsync(TableReference tableReference, Stream input, UploadParquetOptions options = null, CancellationToken cancellationToken = default)

Asynchronously uploads a stream of Parquet data to the specified table.

Parameters
Name Description
tableReference TableReference

A fully-qualified identifier for the table. Must not be null.
input Stream

The stream of input data. Must not be null.
options UploadParquetOptions

The options for the operation. May be null, in which case defaults will be supplied.
cancellationToken CancellationToken

The token to monitor for cancellation requests.
Returns
Type Description
TaskBigQueryJob

A task representing the asynchronous operation. When complete, the result is a data upload job.
Overrides

WithDefaultLocation(string)

public override BigQueryClient WithDefaultLocation(string defaultLocation)

Creates a new client which uses the specified location by default for all operations where locations can be specified, such as dataset and job creation.

Parameter
Name Description
defaultLocation string

The location to use by default, for job creation etc.
Returns
Type Description
BigQueryClient

A new client with the specified default location.
Overrides Remarks

Implementations should normally ensure that the object returned is of the same type as this client, in case users need implementation-specific features of that client.