Class BigQueryClientImpl (3.1.0)

Stay organized with collections Save and categorize content based on your preferences.
public sealed class BigQueryClientImpl : BigQueryClient, IDisposable

Wrapper around Google.Apis.Bigquery.v2.BigqueryService to provide simpler operations.

Inheritance

Object > BigQueryClient > BigQueryClientImpl

Implements

IDisposable

Namespace

Google.Cloud.BigQuery.V2

Assembly

Google.Cloud.BigQuery.V2.dll

Remarks

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

Constructors

BigQueryClientImpl(ProjectReference, BigqueryService)

public BigQueryClientImpl(ProjectReference projectReference, BigqueryService service)

Constructs a new client wrapping the given Google.Apis.Bigquery.v2.BigqueryService.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

serviceGoogle.Apis.Bigquery.v2.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 Google.Apis.Bigquery.v2.BigqueryService, with a specified default location for location-specific operations.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

serviceGoogle.Apis.Bigquery.v2.BigqueryService

The service to wrap. Must not be null.

defaultLocationString

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 Google.Apis.Bigquery.v2.BigqueryService, with no default location.

Parameters
NameDescription
projectIdString

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

serviceGoogle.Apis.Bigquery.v2.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 Google.Apis.Bigquery.v2.BigqueryService, with a specified default location for location-specific operations.

Parameters
NameDescription
projectIdString

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

serviceGoogle.Apis.Bigquery.v2.BigqueryService

The service to wrap. Must not be null.

defaultLocationString

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 Google.Apis.Bigquery.v2.BigqueryService. Defaults to "google-cloud-dotnet"; must not be null.

Property Value
TypeDescription
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
TypeDescription
String
Overrides

PrettyPrint

public override bool PrettyPrint { get; }

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

Property Value
TypeDescription
Boolean
Overrides

ProjectId

public override string ProjectId { get; }

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

Property Value
TypeDescription
String
Overrides

Service

public override BigqueryService Service { get; }

The underlying BigQuery service object used by this client.

Property Value
TypeDescription
Google.Apis.Bigquery.v2.BigqueryService
Overrides Remarks

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

Methods

CancelJob(JobReference, CancelJobOptions)

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

Cancels the specified job.

Parameters
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsCancelJobOptions

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

Returns
TypeDescription
BigQueryJob

The final state of the job.

Overrides

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
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsCancelJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides

ClearDatasetLabels(DatasetReference, ModifyLabelsOptions)

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

Clears all labels on the specified dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsModifyLabelsOptions

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

Returns
TypeDescription
IDictionary<String, String>

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

Overrides

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
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsModifyLabelsOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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

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
NameDescription
sourcesIEnumerable<Google.Apis.Bigquery.v2.Data.TableReference>

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

destinationGoogle.Apis.Bigquery.v2.Data.TableReference

The destination to copy to. Must not be null.

optionsCreateCopyJobOptions

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

Returns
TypeDescription
BigQueryJob

The job created for the copy operation.

Overrides Remarks

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

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

public override 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
NameDescription
sourcesIEnumerable<Google.Apis.Bigquery.v2.Data.TableReference>

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

destinationGoogle.Apis.Bigquery.v2.Data.TableReference

The destination to copy to. Must not be null.

optionsCreateCopyJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides Remarks

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

CreateDataset(DatasetReference, Dataset, CreateDatasetOptions)

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

Creates the specified dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Dataset

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

optionsCreateDatasetOptions

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

Returns
TypeDescription
BigQueryDataset

The created dataset.

Overrides Remarks

If resourceGoogle.Apis.Bigquery.v2.Data.Dataset.DatasetReference is specified, then it must be the same as the Google.Apis.Bigquery.v2.Data.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
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Dataset

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

optionsCreateDatasetOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryDataset>

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

Overrides Remarks

If resourceGoogle.Apis.Bigquery.v2.Data.Dataset.DatasetReference is specified, then it must be the same as the Google.Apis.Bigquery.v2.Data.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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

destinationUrisIEnumerable<String>

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

optionsCreateExtractJobOptions

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

Returns
TypeDescription
BigQueryJob

The job created for the extract operation.

Overrides

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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

destinationUrisIEnumerable<String>

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

optionsCreateExtractJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides

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

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

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

Parameters
NameDescription
sourceUrisIEnumerable<String>

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

destinationGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.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.

optionsCreateLoadJobOptions

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

Returns
TypeDescription
BigQueryJob

The job created for the load operation.

Overrides Remarks

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

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

public override 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
NameDescription
sourceUrisIEnumerable<String>

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

destinationGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.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.

optionsCreateLoadJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides Remarks

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

CreateModelExtractJob(ModelReference, IEnumerable<String>, CreateModelExtractJobOptions)

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

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

Parameters
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

destinationUrisIEnumerable<String>

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

optionsCreateModelExtractJobOptions

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

Returns
TypeDescription
BigQueryJob

The job created for the extract operation.

Overrides

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
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

destinationUrisIEnumerable<String>

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

optionsCreateModelExtractJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides

CreateQueryJob(String, IEnumerable<BigQueryParameter>, QueryOptions)

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

Creates a job for a SQL query.

Parameters
NameDescription
sqlString

The SQL query. Must not be null.

parametersIEnumerable<BigQueryParameter>

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

optionsQueryOptions

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

Returns
TypeDescription
BigQueryJob

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

Overrides

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

public override 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
NameDescription
sqlString

The SQL query. Must not be null.

parametersIEnumerable<BigQueryParameter>

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

optionsQueryOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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

CreateRoutine(RoutineReference, Routine, CreateRoutineOptions)

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

Creates the specified routine.

Parameters
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Routine

The routine resource representation to use for the creation. Must not be null. If this routine's Google.Apis.Bigquery.v2.Data.Routine.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.

optionsCreateRoutineOptions

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

Returns
TypeDescription
BigQueryRoutine

The newly created routine.

Overrides

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
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Routine

The routine resource representation to use for the creation. Must not be null. If this routine's Google.Apis.Bigquery.v2.Data.Routine.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.

optionsCreateRoutineOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryRoutine>

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

Overrides

CreateTable(TableReference, Table, CreateTableOptions)

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

Creates the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Table

The table resource representation to use for the creation. Must not be null. If this table's Google.Apis.Bigquery.v2.Data.Table.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.

optionsCreateTableOptions

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

Returns
TypeDescription
BigQueryTable

The newly created table.

Overrides

CreateTable(TableReference, TableSchema, CreateTableOptions)

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

Creates the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.TableSchema

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

optionsCreateTableOptions

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

Returns
TypeDescription
BigQueryTable

The newly created table.

Overrides

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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Table

The table resource representation to use for the creation. Must not be null. If this table's Google.Apis.Bigquery.v2.Data.Table.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.

optionsCreateTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryTable>

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

Overrides

CreateTableAsync(TableReference, TableSchema, CreateTableOptions, CancellationToken)

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

Asynchronously creates the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.TableSchema

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

optionsCreateTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryTable>

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

Overrides

DeleteDataset(DatasetReference, DeleteDatasetOptions)

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

Deletes the specified dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsDeleteDatasetOptions

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

Overrides

DeleteDatasetAsync(DatasetReference, DeleteDatasetOptions, CancellationToken)

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

Asynchronously deletes the specified dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsDeleteDatasetOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Overrides

DeleteJob(JobReference, DeleteJobOptions)

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

Deletes the specified job.

Parameters
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsDeleteJobOptions

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

Overrides

DeleteJobAsync(JobReference, DeleteJobOptions, CancellationToken)

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

Asynchronously deletes the specified job.

Parameters
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsDeleteJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Overrides

DeleteModel(ModelReference, DeleteModelOptions)

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

Deletes the specified model.

Parameters
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

optionsDeleteModelOptions

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

Overrides

DeleteModelAsync(ModelReference, DeleteModelOptions, CancellationToken)

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

Asynchronously deletes the specified model.

Parameters
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

optionsDeleteModelOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Overrides

DeleteRoutine(RoutineReference, DeleteRoutineOptions)

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

Deletes the specified routine.

Parameters
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

optionsDeleteRoutineOptions

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

Overrides

DeleteRoutineAsync(RoutineReference, DeleteRoutineOptions, CancellationToken)

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

Asynchronously deletes the specified routine.

Parameters
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

optionsDeleteRoutineOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Overrides

DeleteTable(TableReference, DeleteTableOptions)

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

Deletes the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsDeleteTableOptions

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

Overrides

DeleteTableAsync(TableReference, DeleteTableOptions, CancellationToken)

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

Asynchronously deletes the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsDeleteTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task

A task representing the asynchronous operation.

Overrides

Dispose()

public override void Dispose()

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

Overrides

GetBigQueryServiceAccountEmail(ProjectReference, GetBigQueryServiceAccountEmailOptions)

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

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

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsGetBigQueryServiceAccountEmailOptions

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

Returns
TypeDescription
String

The email address of the service account.

Overrides

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
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsGetBigQueryServiceAccountEmailOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<String>

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

Overrides

GetDataset(DatasetReference, GetDatasetOptions)

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

Retrieves the specified dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsGetDatasetOptions

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

Returns
TypeDescription
BigQueryDataset

The requested dataset.

Overrides

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
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsGetDatasetOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryDataset>

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

Overrides

GetJob(JobReference, GetJobOptions)

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

Retrieves the specified job.

Parameters
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsGetJobOptions

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

Returns
TypeDescription
BigQueryJob

The retrieved job.

Overrides

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
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsGetJobOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryJob>

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

Overrides

GetModel(ModelReference, GetModelOptions)

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

Retrieves the specified model.

Parameters
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

optionsGetModelOptions

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

Returns
TypeDescription
BigQueryModel

The requested model.

Overrides

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
NameDescription
modelReferenceGoogle.Apis.Bigquery.v2.Data.ModelReference

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

optionsGetModelOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryModel>

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

Overrides

GetOrCreateDataset(DatasetReference, Dataset, GetDatasetOptions, CreateDatasetOptions)

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

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

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Dataset

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

getOptionsGetDatasetOptions

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

createOptionsCreateDatasetOptions

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

Returns
TypeDescription
BigQueryDataset

The existing or new dataset.

Overrides Remarks

If resourceGoogle.Apis.Bigquery.v2.Data.Dataset.DatasetReference is specified, then it must be the same as the Google.Apis.Bigquery.v2.Data.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
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Dataset

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

getOptionsGetDatasetOptions

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

createOptionsCreateDatasetOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryDataset>

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

Overrides Remarks

If resourceGoogle.Apis.Bigquery.v2.Data.Dataset.DatasetReference is specified, then it must be the same as the Google.Apis.Bigquery.v2.Data.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
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Routine

The routine resource representation to use for the creation. Must not be null. If this routine's Google.Apis.Bigquery.v2.Data.Routine.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.

getOptionsGetRoutineOptions

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

createOptionsCreateRoutineOptions

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

Returns
TypeDescription
BigQueryRoutine

The existing or new routine.

Overrides

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
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Routine

The routine resource representation to use for the creation. Must not be null. If this routine's Google.Apis.Bigquery.v2.Data.Routine.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.

getOptionsGetRoutineOptions

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

createOptionsCreateRoutineOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryRoutine>

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

Overrides

GetOrCreateTable(TableReference, Table, GetTableOptions, CreateTableOptions)

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Table

The table resource representation to use for the creation. Must not be null. If this table's Google.Apis.Bigquery.v2.Data.Table.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.

getOptionsGetTableOptions

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

createOptionsCreateTableOptions

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

Returns
TypeDescription
BigQueryTable

The existing or new table.

Overrides

GetOrCreateTable(TableReference, TableSchema, GetTableOptions, CreateTableOptions)

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.TableSchema

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

getOptionsGetTableOptions

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

createOptionsCreateTableOptions

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

Returns
TypeDescription
BigQueryTable

The existing or new table.

Overrides

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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

resourceGoogle.Apis.Bigquery.v2.Data.Table

The table resource representation to use for the creation. Must not be null. If this table's Google.Apis.Bigquery.v2.Data.Table.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.

getOptionsGetTableOptions

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

createOptionsCreateTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryTable>

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

Overrides

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

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.TableSchema

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

getOptionsGetTableOptions

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

createOptionsCreateTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryTable>

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

Overrides

GetQueryResults(JobReference, GetQueryResultsOptions)

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

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

Parameters
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsGetQueryResultsOptions

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

Returns
TypeDescription
BigQueryResults

The results of the query.

Overrides Remarks

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

GetQueryResultsAsync(JobReference, GetQueryResultsOptions, CancellationToken)

public override 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
NameDescription
jobReferenceGoogle.Apis.Bigquery.v2.Data.JobReference

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

optionsGetQueryResultsOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryResults>

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

Overrides Remarks

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

GetRoutine(RoutineReference, GetRoutineOptions)

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

Retrieves the specified routine.

Parameters
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

optionsGetRoutineOptions

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

Returns
TypeDescription
BigQueryRoutine

The requested routine.

Overrides

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
NameDescription
routineReferenceGoogle.Apis.Bigquery.v2.Data.RoutineReference

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

optionsGetRoutineOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryRoutine>

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

Overrides

GetTable(TableReference, GetTableOptions)

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

Retrieves the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsGetTableOptions

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

Returns
TypeDescription
BigQueryTable

The requested table.

Overrides

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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsGetTableOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<BigQueryTable>

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

Overrides

GetTableIamPolicy(TableReference, GetTableIamPolicyOptions)

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

Gets the IAM policy applied to the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsGetTableIamPolicyOptions

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

Returns
TypeDescription
Google.Apis.Bigquery.v2.Data.Policy

The table's IAM policy.

Overrides

GetTableIamPolicyAsync(TableReference, GetTableIamPolicyOptions, CancellationToken)

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

Asynchronously gets the IAM policy applied to the specified table.

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

optionsGetTableIamPolicyOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
Task<Google.Apis.Bigquery.v2.Data.Policy>

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

Overrides

InsertRows(TableReference, IEnumerable<BigQueryInsertRow>, InsertOptions)

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

rowsIEnumerable<BigQueryInsertRow>

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

optionsInsertOptions

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

Returns
TypeDescription
BigQueryInsertResults

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

Overrides

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
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

rowsIEnumerable<BigQueryInsertRow>

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

optionsInsertOptions

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

cancellationTokenCancellationToken

The token to monitor for cancellation requests.

Returns
TypeDescription
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

ListDatasets(ProjectReference, ListDatasetsOptions)

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

Lists the datasets within the specified project.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsListDatasetsOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.DatasetList, BigQueryDataset>

A sequence of datasets within the specified project.

Overrides Remarks

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

ListDatasetsAsync(ProjectReference, ListDatasetsOptions)

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

Asynchronously lists the datasets within the specified project.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsListDatasetsOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.DatasetList, BigQueryDataset>

An asynchronous sequence of datasets within the specified project.

Overrides Remarks

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

ListJobs(ProjectReference, ListJobsOptions)

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

Lists the jobs within the specified project.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsListJobsOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.JobList, BigQueryJob>

A sequence of the jobs within the specified project.

Overrides Remarks

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

ListJobsAsync(ProjectReference, ListJobsOptions)

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

Asynchronously lists the jobs within the specified project.

Parameters
NameDescription
projectReferenceGoogle.Apis.Bigquery.v2.Data.ProjectReference

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

optionsListJobsOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.JobList, BigQueryJob>

An asynchronous sequence of the jobs within the specified project.

Overrides Remarks

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

ListModels(DatasetReference, ListModelsOptions)

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

Lists the models in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListModelsOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ListModelsResponse, BigQueryModel>

A sequence of models within the dataset.

Overrides Remarks

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

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

ListModelsAsync(DatasetReference, ListModelsOptions)

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

Lists the models in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListModelsOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ListModelsResponse, BigQueryModel>

A sequence of models within the dataset.

Overrides Remarks

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

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

ListProjects(ListProjectsOptions)

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

Lists the cloud projects available using the current credentials.

Parameter
NameDescription
optionsListProjectsOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ProjectList, CloudProject>

A sequence of projects the user has access to.

Overrides Remarks

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

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

ListProjectsAsync(ListProjectsOptions)

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

Asynchronously lists the cloud projects available using the current credentials.

Parameter
NameDescription
optionsListProjectsOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ProjectList, CloudProject>

An asynchronous sequence of projects the user has access to.

Overrides Remarks

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

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

ListRoutines(DatasetReference, ListRoutinesOptions)

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

Lists the routines in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListRoutinesOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ListRoutinesResponse, BigQueryRoutine>

A sequence of tables within the dataset.

Overrides Remarks

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

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

ListRoutinesAsync(DatasetReference, ListRoutinesOptions)

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

Lists the routines in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListRoutinesOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ListRoutinesResponse, BigQueryRoutine>

A sequence of routines within the dataset.

Overrides Remarks

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

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

ListRows(TableReference, TableSchema, ListRowsOptions)

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.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. Google.Apis.Bigquery.v2.Data.TableSchema.Fields null or empty), in which case it will be fetched from the table first.

optionsListRowsOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.TableDataList, BigQueryRow>

The results of listing the rows within the table.

Overrides Remarks

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

ListRowsAsync(TableReference, TableSchema, ListRowsOptions)

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

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

Parameters
NameDescription
tableReferenceGoogle.Apis.Bigquery.v2.Data.TableReference

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

schemaGoogle.Apis.Bigquery.v2.Data.TableSchema

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

optionsListRowsOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.TableDataList, BigQueryRow>

An asynchronous sequence of the rows within the table.

Overrides Remarks

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

ListTables(DatasetReference, ListTablesOptions)

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

Lists the tables in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListTablesOptions

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

Returns
TypeDescription
PagedEnumerable<Google.Apis.Bigquery.v2.Data.TableList, BigQueryTable>

A sequence of tables within the dataset.

Overrides Remarks

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

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

ListTablesAsync(DatasetReference, ListTablesOptions)

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

Lists the tables in a dataset.

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

optionsListTablesOptions

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

Returns
TypeDescription
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.TableList, BigQueryTable>

A sequence of tables within the dataset.

Overrides Remarks

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

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

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

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

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

Parameters
NameDescription
datasetReferenceGoogle.Apis.Bigquery.v2.Data.DatasetReference

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

labelsIDictionary<String, String>

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

optionsModifyLabelsOptions

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

Returns
TypeDescription
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