Class BigQueryClientImpl

public sealed class BigQueryClientImpl : BigQueryClient, IDisposable

Wrapper around BigqueryService to provide simpler operations.

Inheritance

Object > BigQueryClient > BigQueryClientImpl

Implements

IDisposable

Inherited Members

BigQueryClient.CreateAsync(String, GoogleCredential)

BigQueryClient.Create(String, GoogleCredential)

BigQueryClient.GetTableReference(String, String)

BigQueryClient.GetTableReference(String, String, String)

BigQueryClient.GetDatasetReference(String)

BigQueryClient.GetDatasetReference(String, String)

BigQueryClient.GetProjectReference(String)

BigQueryClient.GetJobReference(String)

BigQueryClient.GetJobReference(String, String)

BigQueryClient.GetJobReference(String, String, String)

BigQueryClient.GetModelReference(String, String)

BigQueryClient.GetModelReference(String, String, String)

BigQueryClient.GetRoutineReference(String, String)

BigQueryClient.GetRoutineReference(String, String, String)

BigQueryClient.CreateJsonSerializersSettings()

BigQueryClient.GetDataset(String, GetDatasetOptions)

BigQueryClient.GetDataset(String, String, GetDatasetOptions)

BigQueryClient.GetDatasetAsync(String, GetDatasetOptions, CancellationToken)

BigQueryClient.GetDatasetAsync(String, String, GetDatasetOptions, CancellationToken)

BigQueryClient.ListDatasets(ListDatasetsOptions)

BigQueryClient.ListDatasets(String, ListDatasetsOptions)

BigQueryClient.ListDatasetsAsync(ListDatasetsOptions)

BigQueryClient.ListDatasetsAsync(String, ListDatasetsOptions)

BigQueryClient.CreateDataset(String, Dataset, CreateDatasetOptions)

BigQueryClient.CreateDataset(String, String, Dataset, CreateDatasetOptions)

BigQueryClient.CreateDatasetAsync(String, Dataset, CreateDatasetOptions, CancellationToken)

BigQueryClient.CreateDatasetAsync(String, String, Dataset, CreateDatasetOptions, CancellationToken)

BigQueryClient.GetOrCreateDataset(String, Dataset, GetDatasetOptions, CreateDatasetOptions)

BigQueryClient.GetOrCreateDataset(String, String, Dataset, GetDatasetOptions, CreateDatasetOptions)

BigQueryClient.GetOrCreateDatasetAsync(String, Dataset, GetDatasetOptions, CreateDatasetOptions, CancellationToken)

BigQueryClient.GetOrCreateDatasetAsync(String, String, Dataset, GetDatasetOptions, CreateDatasetOptions, CancellationToken)

BigQueryClient.DeleteDataset(String, DeleteDatasetOptions)

BigQueryClient.DeleteDataset(String, String, DeleteDatasetOptions)

BigQueryClient.DeleteDatasetAsync(String, DeleteDatasetOptions, CancellationToken)

BigQueryClient.DeleteDatasetAsync(String, String, DeleteDatasetOptions, CancellationToken)

BigQueryClient.UpdateDataset(String, Dataset, UpdateDatasetOptions)

BigQueryClient.UpdateDataset(String, String, Dataset, UpdateDatasetOptions)

BigQueryClient.UpdateDatasetAsync(String, Dataset, UpdateDatasetOptions, CancellationToken)

BigQueryClient.UpdateDatasetAsync(String, String, Dataset, UpdateDatasetOptions, CancellationToken)

BigQueryClient.PatchDataset(String, Dataset, PatchDatasetOptions)

BigQueryClient.PatchDataset(String, String, Dataset, PatchDatasetOptions)

BigQueryClient.PatchDatasetAsync(String, Dataset, PatchDatasetOptions, CancellationToken)

BigQueryClient.PatchDatasetAsync(String, String, Dataset, PatchDatasetOptions, CancellationToken)

BigQueryClient.SetDatasetLabel(String, String, String, ModifyLabelsOptions)

BigQueryClient.SetDatasetLabel(String, String, String, String, ModifyLabelsOptions)

BigQueryClient.SetDatasetLabelAsync(String, String, String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.SetDatasetLabelAsync(String, String, String, String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.RemoveDatasetLabel(String, String, ModifyLabelsOptions)

BigQueryClient.RemoveDatasetLabel(String, String, String, ModifyLabelsOptions)

BigQueryClient.RemoveDatasetLabelAsync(String, String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.RemoveDatasetLabelAsync(String, String, String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.ClearDatasetLabels(String, ModifyLabelsOptions)

BigQueryClient.ClearDatasetLabels(String, String, ModifyLabelsOptions)

BigQueryClient.ClearDatasetLabelsAsync(String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.ClearDatasetLabelsAsync(String, String, ModifyLabelsOptions, CancellationToken)

BigQueryClient.ModifyDatasetLabels(String, IDictionary<String, String>, ModifyLabelsOptions)

BigQueryClient.ModifyDatasetLabels(String, String, IDictionary<String, String>, ModifyLabelsOptions)

BigQueryClient.ModifyDatasetLabelsAsync(String, IDictionary<String, String>, ModifyLabelsOptions, CancellationToken)

BigQueryClient.ModifyDatasetLabelsAsync(String, String, IDictionary<String, String>, ModifyLabelsOptions, CancellationToken)

BigQueryClient.UploadCsv(String, String, TableSchema, Stream, UploadCsvOptions)

BigQueryClient.UploadCsv(String, String, String, TableSchema, Stream, UploadCsvOptions)

BigQueryClient.UploadCsvAsync(String, String, TableSchema, Stream, UploadCsvOptions, CancellationToken)

BigQueryClient.UploadCsvAsync(String, String, String, TableSchema, Stream, UploadCsvOptions, CancellationToken)

BigQueryClient.UploadJson(String, String, TableSchema, Stream, UploadJsonOptions)

BigQueryClient.UploadJson(String, String, String, TableSchema, Stream, UploadJsonOptions)

BigQueryClient.UploadJsonAsync(String, String, TableSchema, Stream, UploadJsonOptions, CancellationToken)

BigQueryClient.UploadJsonAsync(String, String, String, TableSchema, Stream, UploadJsonOptions, CancellationToken)

BigQueryClient.UploadJson(String, String, TableSchema, IEnumerable<String>, UploadJsonOptions)

BigQueryClient.UploadJson(String, String, String, TableSchema, IEnumerable<String>, UploadJsonOptions)

BigQueryClient.UploadJsonAsync(String, String, TableSchema, IEnumerable<String>, UploadJsonOptions, CancellationToken)

BigQueryClient.UploadJsonAsync(String, String, String, TableSchema, IEnumerable<String>, UploadJsonOptions, CancellationToken)

BigQueryClient.UploadAvro(String, String, TableSchema, Stream, UploadAvroOptions)

BigQueryClient.UploadAvro(String, String, String, TableSchema, Stream, UploadAvroOptions)

BigQueryClient.UploadAvroAsync(String, String, TableSchema, Stream, UploadAvroOptions, CancellationToken)

BigQueryClient.UploadAvroAsync(String, String, String, TableSchema, Stream, UploadAvroOptions, CancellationToken)

BigQueryClient.UploadParquet(String, String, Stream, UploadParquetOptions)

BigQueryClient.UploadParquet(String, String, String, Stream, UploadParquetOptions)

BigQueryClient.UploadParquetAsync(String, String, Stream, UploadParquetOptions, CancellationToken)

BigQueryClient.UploadParquetAsync(String, String, String, Stream, UploadParquetOptions, CancellationToken)

BigQueryClient.InsertRow(String, String, String, BigQueryInsertRow, InsertOptions)

BigQueryClient.InsertRow(String, String, BigQueryInsertRow, InsertOptions)

BigQueryClient.InsertRow(TableReference, BigQueryInsertRow, InsertOptions)

BigQueryClient.InsertRowAsync(String, String, String, BigQueryInsertRow, InsertOptions, CancellationToken)

BigQueryClient.InsertRowAsync(String, String, BigQueryInsertRow, InsertOptions, CancellationToken)

BigQueryClient.InsertRowAsync(TableReference, BigQueryInsertRow, InsertOptions, CancellationToken)

BigQueryClient.InsertRows(String, String, String, BigQueryInsertRow[])

BigQueryClient.InsertRows(String, String, BigQueryInsertRow[])

BigQueryClient.InsertRows(TableReference, BigQueryInsertRow[])

BigQueryClient.InsertRowsAsync(String, String, String, BigQueryInsertRow[])

BigQueryClient.InsertRowsAsync(String, String, BigQueryInsertRow[])

BigQueryClient.InsertRowsAsync(TableReference, BigQueryInsertRow[])

BigQueryClient.InsertRows(String, String, IEnumerable<BigQueryInsertRow>, InsertOptions)

BigQueryClient.InsertRows(String, String, String, IEnumerable<BigQueryInsertRow>, InsertOptions)

BigQueryClient.InsertRowsAsync(String, String, IEnumerable<BigQueryInsertRow>, InsertOptions, CancellationToken)

BigQueryClient.InsertRowsAsync(String, String, String, IEnumerable<BigQueryInsertRow>, InsertOptions, CancellationToken)

BigQueryClient.UploadOrc(String, String, Stream, UploadOrcOptions)

BigQueryClient.UploadOrc(String, String, String, Stream, UploadOrcOptions)

BigQueryClient.UploadOrcAsync(String, String, Stream, UploadOrcOptions, CancellationToken)

BigQueryClient.UploadOrcAsync(String, String, String, Stream, UploadOrcOptions, CancellationToken)

BigQueryClient.ListJobs(ListJobsOptions)

BigQueryClient.ListJobs(String, ListJobsOptions)

BigQueryClient.ListJobsAsync(ListJobsOptions)

BigQueryClient.ListJobsAsync(String, ListJobsOptions)

BigQueryClient.PollJobUntilCompleted(String, GetJobOptions, PollSettings)

BigQueryClient.PollJobUntilCompleted(String, String, GetJobOptions, PollSettings)

BigQueryClient.PollJobUntilCompletedAsync(String, GetJobOptions, PollSettings, CancellationToken)

BigQueryClient.PollJobUntilCompletedAsync(String, String, GetJobOptions, PollSettings, CancellationToken)

BigQueryClient.GetJob(String, GetJobOptions)

BigQueryClient.GetJob(String, String, GetJobOptions)

BigQueryClient.GetJobAsync(String, GetJobOptions, CancellationToken)

BigQueryClient.GetJobAsync(String, String, GetJobOptions, CancellationToken)

BigQueryClient.CancelJob(String, CancelJobOptions)

BigQueryClient.CancelJob(String, String, CancelJobOptions)

BigQueryClient.CancelJobAsync(String, CancelJobOptions, CancellationToken)

BigQueryClient.CancelJobAsync(String, String, CancelJobOptions, CancellationToken)

BigQueryClient.CreateExtractJob(String, String, String, String, CreateExtractJobOptions)

BigQueryClient.CreateExtractJob(String, String, String, CreateExtractJobOptions)

BigQueryClient.CreateExtractJob(TableReference, String, CreateExtractJobOptions)

BigQueryClient.CreateExtractJobAsync(String, String, String, String, CreateExtractJobOptions, CancellationToken)

BigQueryClient.CreateExtractJobAsync(String, String, String, CreateExtractJobOptions, CancellationToken)

BigQueryClient.CreateExtractJobAsync(TableReference, String, CreateExtractJobOptions, CancellationToken)

BigQueryClient.CreateExtractJob(String, String, IEnumerable<String>, CreateExtractJobOptions)

BigQueryClient.CreateExtractJob(String, String, String, IEnumerable<String>, CreateExtractJobOptions)

BigQueryClient.CreateExtractJobAsync(String, String, IEnumerable<String>, CreateExtractJobOptions, CancellationToken)

BigQueryClient.CreateExtractJobAsync(String, String, String, IEnumerable<String>, CreateExtractJobOptions, CancellationToken)

BigQueryClient.CreateCopyJob(TableReference, TableReference, CreateCopyJobOptions)

BigQueryClient.CreateCopyJobAsync(TableReference, TableReference, CreateCopyJobOptions, CancellationToken)

BigQueryClient.CreateLoadJob(String, TableReference, TableSchema, CreateLoadJobOptions)

BigQueryClient.CreateLoadJobAsync(String, TableReference, TableSchema, CreateLoadJobOptions, CancellationToken)

BigQueryClient.CreateModelExtractJob(String, String, String, CreateModelExtractJobOptions)

BigQueryClient.CreateModelExtractJob(String, String, String, String, CreateModelExtractJobOptions)

BigQueryClient.CreateModelExtractJob(ModelReference, String, CreateModelExtractJobOptions)

BigQueryClient.CreateModelExtractJobAsync(String, String, String, CreateModelExtractJobOptions, CancellationToken)

BigQueryClient.CreateModelExtractJobAsync(String, String, String, String, CreateModelExtractJobOptions, CancellationToken)

BigQueryClient.CreateModelExtractJobAsync(ModelReference, String, CreateModelExtractJobOptions, CancellationToken)

BigQueryClient.CreateModelExtractJob(String, String, IEnumerable<String>, CreateModelExtractJobOptions)

BigQueryClient.CreateModelExtractJob(String, String, String, IEnumerable<String>, CreateModelExtractJobOptions)

BigQueryClient.CreateModelExtractJobAsync(String, String, IEnumerable<String>, CreateModelExtractJobOptions, CancellationToken)

BigQueryClient.CreateModelExtractJobAsync(String, String, String, IEnumerable<String>, CreateModelExtractJobOptions, CancellationToken)

BigQueryClient.GetModel(String, String, GetModelOptions)

BigQueryClient.GetModel(String, String, String, GetModelOptions)

BigQueryClient.GetModelAsync(String, String, GetModelOptions, CancellationToken)

BigQueryClient.GetModelAsync(String, String, String, GetModelOptions, CancellationToken)

BigQueryClient.DeleteModel(String, String, DeleteModelOptions)

BigQueryClient.DeleteModel(String, String, String, DeleteModelOptions)

BigQueryClient.DeleteModelAsync(String, String, DeleteModelOptions, CancellationToken)

BigQueryClient.DeleteModelAsync(String, String, String, DeleteModelOptions, CancellationToken)

BigQueryClient.PatchModel(String, String, Model, PatchModelOptions)

BigQueryClient.PatchModel(String, String, String, Model, PatchModelOptions)

BigQueryClient.PatchModelAsync(String, String, Model, PatchModelOptions, CancellationToken)

BigQueryClient.PatchModelAsync(String, String, String, Model, PatchModelOptions, CancellationToken)

BigQueryClient.ListModels(String, String, ListModelsOptions)

BigQueryClient.ListModels(String, ListModelsOptions)

BigQueryClient.ListModelsAsync(String, String, ListModelsOptions)

BigQueryClient.ListModelsAsync(String, ListModelsOptions)

BigQueryClient.ExecuteQuery(String, IEnumerable<BigQueryParameter>, QueryOptions, GetQueryResultsOptions)

BigQueryClient.ExecuteQueryAsync(String, IEnumerable<BigQueryParameter>, QueryOptions, GetQueryResultsOptions, CancellationToken)

BigQueryClient.GetQueryResults(String, GetQueryResultsOptions)

BigQueryClient.GetQueryResults(String, String, GetQueryResultsOptions)

BigQueryClient.GetQueryResultsAsync(String, GetQueryResultsOptions, CancellationToken)

BigQueryClient.GetQueryResultsAsync(String, String, GetQueryResultsOptions, CancellationToken)

BigQueryClient.ListRows(String, String, String, TableSchema, ListRowsOptions)

BigQueryClient.ListRows(String, String, TableSchema, ListRowsOptions)

BigQueryClient.ListRowsAsync(String, String, String, TableSchema, ListRowsOptions)

BigQueryClient.ListRowsAsync(String, String, TableSchema, ListRowsOptions)

BigQueryClient.GetRoutine(String, String, GetRoutineOptions)

BigQueryClient.GetRoutine(String, String, String, GetRoutineOptions)

BigQueryClient.GetRoutineAsync(String, String, GetRoutineOptions, CancellationToken)

BigQueryClient.GetRoutineAsync(String, String, String, GetRoutineOptions, CancellationToken)

BigQueryClient.ListRoutines(String, String, ListRoutinesOptions)

BigQueryClient.ListRoutines(String, ListRoutinesOptions)

BigQueryClient.ListRoutinesAsync(String, String, ListRoutinesOptions)

BigQueryClient.ListRoutinesAsync(String, ListRoutinesOptions)

BigQueryClient.CreateRoutine(String, String, Routine, CreateRoutineOptions)

BigQueryClient.CreateRoutine(String, String, String, Routine, CreateRoutineOptions)

BigQueryClient.CreateRoutineAsync(String, String, Routine, CreateRoutineOptions, CancellationToken)

BigQueryClient.CreateRoutineAsync(String, String, String, Routine, CreateRoutineOptions, CancellationToken)

BigQueryClient.GetOrCreateRoutine(String, String, Routine, GetRoutineOptions, CreateRoutineOptions)

BigQueryClient.GetOrCreateRoutine(String, String, String, Routine, GetRoutineOptions, CreateRoutineOptions)

BigQueryClient.GetOrCreateRoutineAsync(String, String, Routine, GetRoutineOptions, CreateRoutineOptions, CancellationToken)

BigQueryClient.GetOrCreateRoutineAsync(String, String, String, Routine, GetRoutineOptions, CreateRoutineOptions, CancellationToken)

BigQueryClient.DeleteRoutine(String, String, DeleteRoutineOptions)

BigQueryClient.DeleteRoutine(String, String, String, DeleteRoutineOptions)

BigQueryClient.DeleteRoutineAsync(String, String, DeleteRoutineOptions, CancellationToken)

BigQueryClient.DeleteRoutineAsync(String, String, String, DeleteRoutineOptions, CancellationToken)

BigQueryClient.UpdateRoutine(String, String, Routine, UpdateRoutineOptions)

BigQueryClient.UpdateRoutine(String, String, String, Routine, UpdateRoutineOptions)

BigQueryClient.UpdateRoutineAsync(String, String, Routine, UpdateRoutineOptions, CancellationToken)

BigQueryClient.UpdateRoutineAsync(String, String, String, Routine, UpdateRoutineOptions, CancellationToken)

BigQueryClient.GetBigQueryServiceAccountEmail(GetBigQueryServiceAccountEmailOptions)

BigQueryClient.GetBigQueryServiceAccountEmail(String, GetBigQueryServiceAccountEmailOptions)

BigQueryClient.GetBigQueryServiceAccountEmailAsync(GetBigQueryServiceAccountEmailOptions, CancellationToken)

BigQueryClient.GetBigQueryServiceAccountEmailAsync(String, GetBigQueryServiceAccountEmailOptions, CancellationToken)

BigQueryClient.GetTable(String, String, GetTableOptions)

BigQueryClient.GetTable(String, String, String, GetTableOptions)

BigQueryClient.GetTableAsync(String, String, GetTableOptions, CancellationToken)

BigQueryClient.GetTableAsync(String, String, String, GetTableOptions, CancellationToken)

BigQueryClient.ListTables(String, String, ListTablesOptions)

BigQueryClient.ListTables(String, ListTablesOptions)

BigQueryClient.ListTablesAsync(String, String, ListTablesOptions)

BigQueryClient.ListTablesAsync(String, ListTablesOptions)

BigQueryClient.CreateTable(String, String, Table, CreateTableOptions)

BigQueryClient.CreateTable(String, String, String, Table, CreateTableOptions)

BigQueryClient.CreateTableAsync(String, String, Table, CreateTableOptions, CancellationToken)

BigQueryClient.CreateTableAsync(String, String, String, Table, CreateTableOptions, CancellationToken)

BigQueryClient.CreateTable(String, String, TableSchema, CreateTableOptions)

BigQueryClient.CreateTable(String, String, String, TableSchema, CreateTableOptions)

BigQueryClient.CreateTableAsync(String, String, TableSchema, CreateTableOptions, CancellationToken)

BigQueryClient.CreateTableAsync(String, String, String, TableSchema, CreateTableOptions, CancellationToken)

BigQueryClient.GetOrCreateTable(String, String, Table, GetTableOptions, CreateTableOptions)

BigQueryClient.GetOrCreateTable(String, String, String, Table, GetTableOptions, CreateTableOptions)

BigQueryClient.GetOrCreateTableAsync(String, String, Table, GetTableOptions, CreateTableOptions, CancellationToken)

BigQueryClient.GetOrCreateTableAsync(String, String, String, Table, GetTableOptions, CreateTableOptions, CancellationToken)

BigQueryClient.GetOrCreateTable(String, String, TableSchema, GetTableOptions, CreateTableOptions)

BigQueryClient.GetOrCreateTable(String, String, String, TableSchema, GetTableOptions, CreateTableOptions)

BigQueryClient.GetOrCreateTableAsync(String, String, TableSchema, GetTableOptions, CreateTableOptions, CancellationToken)

BigQueryClient.GetOrCreateTableAsync(String, String, String, TableSchema, GetTableOptions, CreateTableOptions, CancellationToken)

BigQueryClient.DeleteTable(String, String, DeleteTableOptions)

BigQueryClient.DeleteTable(String, String, String, DeleteTableOptions)

BigQueryClient.DeleteTableAsync(String, String, DeleteTableOptions, CancellationToken)

BigQueryClient.DeleteTableAsync(String, String, String, DeleteTableOptions, CancellationToken)

BigQueryClient.UpdateTable(String, String, Table, UpdateTableOptions)

BigQueryClient.UpdateTable(String, String, String, Table, UpdateTableOptions)

BigQueryClient.UpdateTableAsync(String, String, Table, UpdateTableOptions, CancellationToken)

BigQueryClient.UpdateTableAsync(String, String, String, Table, UpdateTableOptions, CancellationToken)

BigQueryClient.PatchTable(String, String, Table, PatchTableOptions)

BigQueryClient.PatchTable(String, String, String, Table, PatchTableOptions)

BigQueryClient.PatchTableAsync(String, String, Table, PatchTableOptions, CancellationToken)

BigQueryClient.PatchTableAsync(String, String, String, Table, PatchTableOptions, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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

BigQueryClient.DefaultLocation

PrettyPrint

public override bool PrettyPrint { get; }

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

Property Value

Type	Description
Boolean

Overrides

BigQueryClient.PrettyPrint

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

BigQueryClient.ProjectId

Service

public override BigqueryService Service { get; }

The underlying BigQuery service object used by this client.

Property Value

Type	Description
BigqueryService

Overrides

BigQueryClient.Service

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

BigQueryClient.CancelJob(JobReference, CancelJobOptions)

CancelJobAsync(JobReference, CancelJobOptions, CancellationToken)

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

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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the final state of the job.

Overrides

BigQueryClient.CancelJobAsync(JobReference, CancelJobOptions, CancellationToken)

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
IDictionary<String, String>	A dictionary with the labels on the dataset before they were cleared.

Overrides

BigQueryClient.ClearDatasetLabels(DatasetReference, ModifyLabelsOptions)

ClearDatasetLabelsAsync(DatasetReference, ModifyLabelsOptions, CancellationToken)

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

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
Task<IDictionary<String, String>>	A task representing the asynchronous operation. When complete, the result is a dictionary with the labels on the dataset before they were cleared.

Overrides

BigQueryClient.ClearDatasetLabelsAsync(DatasetReference, ModifyLabelsOptions, CancellationToken)

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	IEnumerable<TableReference> 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

BigQueryClient.CreateCopyJob(IEnumerable<TableReference>, TableReference, CreateCopyJobOptions)

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 async Task<BigQueryJob> CreateCopyJobAsync(IEnumerable<TableReference> sources, TableReference destination, CreateCopyJobOptions options = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters

Name	Description
sources	IEnumerable<TableReference> 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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the job created for the copy operation.

Overrides

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

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

BigQueryClient.CreateDataset(DatasetReference, Dataset, CreateDatasetOptions)

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 async Task<BigQueryDataset> CreateDatasetAsync(DatasetReference datasetReference, Dataset resource = null, CreateDatasetOptions options = null, CancellationToken cancellationToken = default(CancellationToken))

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
Task<BigQueryDataset>	A task representing the asynchronous operation. When complete, the result is the created dataset.

Overrides

BigQueryClient.CreateDatasetAsync(DatasetReference, Dataset, CreateDatasetOptions, CancellationToken)

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	IEnumerable<String> 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

BigQueryClient.CreateExtractJob(TableReference, IEnumerable<String>, CreateExtractJobOptions)

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

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

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	IEnumerable<String> 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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the job created for the extract operation.

Overrides

BigQueryClient.CreateExtractJobAsync(TableReference, IEnumerable<String>, CreateExtractJobOptions, CancellationToken)

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	IEnumerable<String> 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

BigQueryClient.CreateLoadJob(IEnumerable<String>, TableReference, TableSchema, CreateLoadJobOptions)

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 async Task<BigQueryJob> CreateLoadJobAsync(IEnumerable<string> sourceUris, TableReference destination, TableSchema schema, CreateLoadJobOptions options = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters

Name	Description
sourceUris	IEnumerable<String> 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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the job created for the load operation.

Overrides

BigQueryClient.CreateLoadJobAsync(IEnumerable<String>, TableReference, TableSchema, CreateLoadJobOptions, CancellationToken)

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	IEnumerable<String> 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

BigQueryClient.CreateModelExtractJob(ModelReference, IEnumerable<String>, CreateModelExtractJobOptions)

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

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

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	IEnumerable<String> 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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the job created for the extract operation.

Overrides

BigQueryClient.CreateModelExtractJobAsync(ModelReference, IEnumerable<String>, CreateModelExtractJobOptions, CancellationToken)

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	IEnumerable<BigQueryParameter> 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

BigQueryClient.CreateQueryJob(String, IEnumerable<BigQueryParameter>, QueryOptions)

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

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

Asynchronously creates a job for a SQL query.

Parameters

Name	Description
sql	String The SQL query. Must not be null.
parameters	IEnumerable<BigQueryParameter> 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
Task<BigQueryJob>	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

BigQueryClient.CreateQueryJobAsync(String, IEnumerable<BigQueryParameter>, QueryOptions, CancellationToken)

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

BigQueryClient.CreateRoutine(RoutineReference, Routine, CreateRoutineOptions)

CreateRoutineAsync(RoutineReference, Routine, CreateRoutineOptions, CancellationToken)

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

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
Task<BigQueryRoutine>	A task representing the asynchronous operation. When complete, the result is the newly created routine.

Overrides

BigQueryClient.CreateRoutineAsync(RoutineReference, Routine, CreateRoutineOptions, CancellationToken)

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

BigQueryClient.CreateTable(TableReference, Table, CreateTableOptions)

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

BigQueryClient.CreateTable(TableReference, TableSchema, CreateTableOptions)

CreateTableAsync(TableReference, Table, CreateTableOptions, CancellationToken)

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

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
Task<BigQueryTable>	A task representing the asynchronous operation. When complete, the result is the newly created table.

Overrides

BigQueryClient.CreateTableAsync(TableReference, Table, CreateTableOptions, CancellationToken)

CreateTableAsync(TableReference, TableSchema, CreateTableOptions, CancellationToken)

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

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
Task<BigQueryTable>	A task representing the asynchronous operation. When complete, the result is the newly created table.

Overrides

BigQueryClient.CreateTableAsync(TableReference, TableSchema, CreateTableOptions, CancellationToken)

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

BigQueryClient.DeleteDataset(DatasetReference, DeleteDatasetOptions)

DeleteDatasetAsync(DatasetReference, DeleteDatasetOptions, CancellationToken)

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

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

BigQueryClient.DeleteDatasetAsync(DatasetReference, DeleteDatasetOptions, CancellationToken)

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

BigQueryClient.DeleteModel(ModelReference, DeleteModelOptions)

DeleteModelAsync(ModelReference, DeleteModelOptions, CancellationToken)

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

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

BigQueryClient.DeleteModelAsync(ModelReference, DeleteModelOptions, CancellationToken)

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

BigQueryClient.DeleteRoutine(RoutineReference, DeleteRoutineOptions)

DeleteRoutineAsync(RoutineReference, DeleteRoutineOptions, CancellationToken)

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

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

BigQueryClient.DeleteRoutineAsync(RoutineReference, DeleteRoutineOptions, CancellationToken)

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

BigQueryClient.DeleteTable(TableReference, DeleteTableOptions)

DeleteTableAsync(TableReference, DeleteTableOptions, CancellationToken)

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

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

BigQueryClient.DeleteTableAsync(TableReference, DeleteTableOptions, CancellationToken)

Dispose()

public override void Dispose()

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

Overrides

BigQueryClient.Dispose()

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

BigQueryClient.GetBigQueryServiceAccountEmail(ProjectReference, GetBigQueryServiceAccountEmailOptions)

GetBigQueryServiceAccountEmailAsync(ProjectReference, GetBigQueryServiceAccountEmailOptions, CancellationToken)

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

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
Task<String>	A task representing the asynchronous operation. When complete, the result is the email address of the service account.

Overrides

BigQueryClient.GetBigQueryServiceAccountEmailAsync(ProjectReference, GetBigQueryServiceAccountEmailOptions, CancellationToken)

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

BigQueryClient.GetDataset(DatasetReference, GetDatasetOptions)

GetDatasetAsync(DatasetReference, GetDatasetOptions, CancellationToken)

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

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
Task<BigQueryDataset>	A task representing the asynchronous operation. When complete, the result is the requested dataset.

Overrides

BigQueryClient.GetDatasetAsync(DatasetReference, GetDatasetOptions, CancellationToken)

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

BigQueryClient.GetJob(JobReference, GetJobOptions)

GetJobAsync(JobReference, GetJobOptions, CancellationToken)

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

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
Task<BigQueryJob>	A task representing the asynchronous operation. When complete, the result is the retrieved job.

Overrides

BigQueryClient.GetJobAsync(JobReference, GetJobOptions, CancellationToken)

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

BigQueryClient.GetModel(ModelReference, GetModelOptions)

GetModelAsync(ModelReference, GetModelOptions, CancellationToken)

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

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
Task<BigQueryModel>	A task representing the asynchronous operation. When complete, the result is the requested model.

Overrides

BigQueryClient.GetModelAsync(ModelReference, GetModelOptions, CancellationToken)

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

BigQueryClient.GetOrCreateDataset(DatasetReference, Dataset, GetDatasetOptions, CreateDatasetOptions)

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 async Task<BigQueryDataset> GetOrCreateDatasetAsync(DatasetReference datasetReference, Dataset resource = null, GetDatasetOptions getOptions = null, CreateDatasetOptions createOptions = null, CancellationToken cancellationToken = default(CancellationToken))

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
Task<BigQueryDataset>	A task representing the asynchronous operation. When complete, the result is the existing or new dataset.

Overrides

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

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

BigQueryClient.GetOrCreateRoutine(RoutineReference, Routine, GetRoutineOptions, CreateRoutineOptions)

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

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

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
Task<BigQueryRoutine>	A task representing the asynchronous operation. When complete, the result is the existing or new routine.

Overrides

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

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

BigQueryClient.GetOrCreateTable(TableReference, Table, GetTableOptions, CreateTableOptions)

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

BigQueryClient.GetOrCreateTable(TableReference, TableSchema, GetTableOptions, CreateTableOptions)

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

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

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
Task<BigQueryTable>	A task representing the asynchronous operation. When complete, the result is the existing or new table.

Overrides

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

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

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

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
Task<BigQueryTable>	A task representing the asynchronous operation. When complete, the result is the existing or new table.

Overrides

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

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

BigQueryClient.GetQueryResults(JobReference, GetQueryResultsOptions)

Remarks

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

GetQueryResultsAsync(JobReference, GetQueryResultsOptions, CancellationToken)

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

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
Task<BigQueryResults>	A task representing the asynchronous operation. When complete, the result is the results of the query.

Overrides

BigQueryClient.GetQueryResultsAsync(JobReference, GetQueryResultsOptions, CancellationToken)

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

BigQueryClient.GetRoutine(RoutineReference, GetRoutineOptions)

GetRoutineAsync(RoutineReference, GetRoutineOptions, CancellationToken)

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

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
Task<BigQueryRoutine>	A task representing the asynchronous operation. When complete, the result is the requested routine.

Overrides

BigQueryClient.GetRoutineAsync(RoutineReference, GetRoutineOptions, CancellationToken)

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

BigQueryClient.GetTable(TableReference, GetTableOptions)

GetTableAsync(TableReference, GetTableOptions, CancellationToken)

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

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
Task<BigQueryTable>	A task representing the asynchronous operation. When complete, the result is the requested table.

Overrides

BigQueryClient.GetTableAsync(TableReference, GetTableOptions, CancellationToken)

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	IEnumerable<BigQueryInsertRow> 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

BigQueryClient.InsertRows(TableReference, IEnumerable<BigQueryInsertRow>, InsertOptions)

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

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

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	IEnumerable<BigQueryInsertRow> 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
Task<BigQueryInsertResults>	A task representing the asynchronous operation. When complete, the result is an insert result object which contains information on insert errors if any.

Overrides

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

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
PagedEnumerable<DatasetList, BigQueryDataset>	A sequence of datasets within the specified project.

Overrides

BigQueryClient.ListDatasets(ProjectReference, ListDatasetsOptions)

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
PagedAsyncEnumerable<DatasetList, BigQueryDataset>	An asynchronous sequence of datasets within the specified project.

Overrides

BigQueryClient.ListDatasetsAsync(ProjectReference, ListDatasetsOptions)

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
PagedEnumerable<JobList, BigQueryJob>	A sequence of the jobs within the specified project.

Overrides

BigQueryClient.ListJobs(ProjectReference, ListJobsOptions)

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
PagedAsyncEnumerable<JobList, BigQueryJob>	An asynchronous sequence of the jobs within the specified project.

Overrides

BigQueryClient.ListJobsAsync(ProjectReference, ListJobsOptions)

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
PagedEnumerable<ListModelsResponse, BigQueryModel>	A sequence of models within the dataset.

Overrides

BigQueryClient.ListModels(DatasetReference, ListModelsOptions)

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
PagedAsyncEnumerable<ListModelsResponse, BigQueryModel>	A sequence of models within the dataset.

Overrides

BigQueryClient.ListModelsAsync(DatasetReference, ListModelsOptions)

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
PagedEnumerable<ProjectList, CloudProject>	A sequence of projects the user has access to.

Overrides

BigQueryClient.ListProjects(ListProjectsOptions)

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
PagedAsyncEnumerable<ProjectList, CloudProject>	An asynchronous sequence of projects the user has access to.

Overrides

BigQueryClient.ListProjectsAsync(ListProjectsOptions)

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
PagedEnumerable<ListRoutinesResponse, BigQueryRoutine>	A sequence of tables within the dataset.

Overrides

BigQueryClient.ListRoutines(DatasetReference, ListRoutinesOptions)

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
PagedAsyncEnumerable<ListRoutinesResponse, BigQueryRoutine>	A sequence of routines within the dataset.

Overrides

BigQueryClient.ListRoutinesAsync(DatasetReference, ListRoutinesOptions)

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
PagedEnumerable<TableDataList, BigQueryRow>	The results of listing the rows within the table.

Overrides

BigQueryClient.ListRows(TableReference, TableSchema, ListRowsOptions)

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
PagedAsyncEnumerable<TableDataList, BigQueryRow>	An asynchronous sequence of the rows within the table.

Overrides

BigQueryClient.ListRowsAsync(TableReference, TableSchema, ListRowsOptions)

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
PagedEnumerable<TableList, BigQueryTable>	A sequence of tables within the dataset.

Overrides

BigQueryClient.ListTables(DatasetReference, ListTablesOptions)

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
PagedAsyncEnumerable<TableList, BigQueryTable>	A sequence of tables within the dataset.

Overrides

BigQueryClient.ListTablesAsync(DatasetReference, ListTablesOptions)

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	IDictionary<String, String> 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
IDictionary<String, String>	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

BigQueryClient.ModifyDatasetLabels(DatasetReference, IDictionary<String, String>, ModifyLabelsOptions)

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 async Task<IDictionary<string, string>> ModifyDatasetLabelsAsync(DatasetReference datasetReference, IDictionary<string, string> labels, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default(CancellationToken))

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	IDictionary<String, String> 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
Task<IDictionary<String, String>>	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

BigQueryClient.ModifyDatasetLabelsAsync(DatasetReference, IDictionary<String, String>, ModifyLabelsOptions, CancellationToken)

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

BigQueryClient.PatchDataset(DatasetReference, Dataset, PatchDatasetOptions)

Remarks

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

PatchDatasetAsync(DatasetReference, Dataset, PatchDatasetOptions, CancellationToken)

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

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