public sealed class BigQueryClientImpl : BigQueryClient, IDisposableReference documentation and code samples for the Google BigQuery v2 API class BigQueryClientImpl.
Wrapper around Google.Apis.Bigquery.v2.BigqueryService to provide simpler operations.
Implements
IDisposableNamespace
Google.Cloud.BigQuery.V2Assembly
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 | |
|---|---|
| Name | Description |
projectReference | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
service | Google.Apis.Bigquery.v2.BigqueryServiceThe service to wrap. Must not be null. |
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 | |
|---|---|
| Name | Description |
projectReference | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
service | Google.Apis.Bigquery.v2.BigqueryServiceThe service to wrap. Must not be null. |
defaultLocation | StringThe default location to use for location-specific operations. May be null. |
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 | |
|---|---|
| Name | Description |
projectId | StringThe ID of the project to work with. Must not be null. |
service | Google.Apis.Bigquery.v2.BigqueryServiceThe service to wrap. Must not be null. |
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 | |
|---|---|
| Name | Description |
projectId | StringThe ID of the project to work with. Must not be null. |
service | Google.Apis.Bigquery.v2.BigqueryServiceThe service to wrap. Must not be null. |
defaultLocation | StringThe default location to use for location-specific operations. May be null. |
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 | |
|---|---|
| Type | Description |
String | |
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 | |
PrettyPrint
public override bool PrettyPrint { get; }Determines whether or not responses should be formatted with whitespace for readability.
| Property Value | |
|---|---|
| Type | Description |
Boolean | |
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 | |
Service
public override BigqueryService Service { get; }The underlying BigQuery service object used by this client.
| Property Value | |
|---|---|
| Type | Description |
Google.Apis.Bigquery.v2.BigqueryService | |
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 | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | CancelJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | The final state of the job. |
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 | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | CancelJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ModifyLabelsOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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<Google.Apis.Bigquery.v2.Data.TableReference>The source tables to copy. Must not be null or empty. |
destination | Google.Apis.Bigquery.v2.Data.TableReferenceThe destination to copy to. Must not be null. |
options | CreateCopyJobOptionsThe 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. |
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<Google.Apis.Bigquery.v2.Data.TableReference>The source tables to copy. Must not be null or empty. |
destination | Google.Apis.Bigquery.v2.Data.TableReferenceThe destination to copy to. Must not be null. |
options | CreateCopyJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the creation. May be null in which case default values will be used. |
options | CreateDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryDataset | The created dataset. |
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 | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the creation. May be null in which case default values will be used. |
options | CreateDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA 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 | CreateExtractJobOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA 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 | CreateExtractJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceThe destination table to write data to. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe 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 | CreateLoadJobOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceThe destination table to write data to. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe 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 | CreateLoadJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.ModelReferenceA 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 | CreateModelExtractJobOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.ModelReferenceA 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 | CreateModelExtractJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | StringThe 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 | QueryOptionsThe 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. |
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 | StringThe 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 | QueryOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
CreateRoutine(RoutineReference, Routine, CreateRoutineOptions)
public override BigQueryRoutine CreateRoutine(RoutineReference routineReference, Routine resource, CreateRoutineOptions options = null)Creates the specified routine.
| Parameters | |
|---|---|
| Name | Description |
routineReference | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe 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. |
options | CreateRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryRoutine | The newly created routine. |
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 | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe 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. |
options | CreateRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
CreateTable(TableReference, Table, CreateTableOptions)
public override BigQueryTable CreateTable(TableReference tableReference, Table resource, CreateTableOptions options = null)Creates the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe 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. |
options | CreateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The newly created table. |
CreateTable(TableReference, TableSchema, CreateTableOptions)
public override BigQueryTable CreateTable(TableReference tableReference, TableSchema schema, CreateTableOptions options = null)Creates the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema for the new table. Must not be null. |
options | CreateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The newly created table. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe 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. |
options | CreateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema for the new table. Must not be null. |
options | CreateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
DeleteDataset(DatasetReference, DeleteDatasetOptions)
public override void DeleteDataset(DatasetReference datasetReference, DeleteDatasetOptions options = null)Deletes the specified dataset.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | DeleteDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | DeleteDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous operation. |
DeleteJob(JobReference, DeleteJobOptions)
public override void DeleteJob(JobReference jobReference, DeleteJobOptions options = null)Deletes the specified job.
| Parameters | |
|---|---|
| Name | Description |
jobReference | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | DeleteJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
DeleteJobAsync(JobReference, DeleteJobOptions, CancellationToken)
public override async Task DeleteJobAsync(JobReference jobReference, DeleteJobOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously deletes the specified job.
| Parameters | |
|---|---|
| Name | Description |
jobReference | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | DeleteJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous operation. |
DeleteModel(ModelReference, DeleteModelOptions)
public override void DeleteModel(ModelReference modelReference, DeleteModelOptions options = null)Deletes the specified model.
| Parameters | |
|---|---|
| Name | Description |
modelReference | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
options | DeleteModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
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 | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
options | DeleteModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous operation. |
DeleteRoutine(RoutineReference, DeleteRoutineOptions)
public override void DeleteRoutine(RoutineReference routineReference, DeleteRoutineOptions options = null)Deletes the specified routine.
| Parameters | |
|---|---|
| Name | Description |
routineReference | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
options | DeleteRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
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 | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
options | DeleteRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous operation. |
DeleteTable(TableReference, DeleteTableOptions)
public override void DeleteTable(TableReference tableReference, DeleteTableOptions options = null)Deletes the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | DeleteTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | DeleteTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task | A task representing the asynchronous operation. |
Dispose()
public override void Dispose()Dispose of this instance. See the BigQueryClient remarks on when this should be called.
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | GetBigQueryServiceAccountEmailOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | GetBigQueryServiceAccountEmailOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
GetDataset(DatasetReference, GetDatasetOptions)
public override BigQueryDataset GetDataset(DatasetReference datasetReference, GetDatasetOptions options = null)Retrieves the specified dataset.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | GetDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryDataset | The requested dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | GetDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
GetJob(JobReference, GetJobOptions)
public override BigQueryJob GetJob(JobReference jobReference, GetJobOptions options = null)Retrieves the specified job.
| Parameters | |
|---|---|
| Name | Description |
jobReference | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | The retrieved job. |
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 | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
GetModel(ModelReference, GetModelOptions)
public override BigQueryModel GetModel(ModelReference modelReference, GetModelOptions options = null)Retrieves the specified model.
| Parameters | |
|---|---|
| Name | Description |
modelReference | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
options | GetModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryModel | The requested model. |
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 | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
options | GetModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the creation. May be null in which case default values will be used. |
getOptions | GetDatasetOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateDatasetOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryDataset | The existing or new dataset. |
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 | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the creation. May be null in which case default values will be used. |
getOptions | GetDatasetOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateDatasetOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | |
|---|---|
| Name | Description |
routineReference | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe 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. |
getOptions | GetRoutineOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateRoutineOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryRoutine | The existing or new routine. |
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 | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe 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. |
getOptions | GetRoutineOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateRoutineOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe 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. |
getOptions | GetTableOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateTableOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The existing or new table. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema for the new table. Must not be null. |
getOptions | GetTableOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateTableOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The existing or new table. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe 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. |
getOptions | GetTableOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateTableOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema for the new table. Must not be null. |
getOptions | GetTableOptionsThe options for the "get" operation. May be null, in which case defaults will be supplied. |
createOptions | CreateTableOptionsThe options for the "create" operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetQueryResultsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryResults | The results of the query. |
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 | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetQueryResultsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
options | GetRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryRoutine | The requested routine. |
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 | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
options | GetRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
GetTable(TableReference, GetTableOptions)
public override BigQueryTable GetTable(TableReference tableReference, GetTableOptions options = null)Retrieves the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | GetTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The requested table. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | GetTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
GetTableIamPolicy(TableReference, GetTableIamPolicyOptions)
public override Policy GetTableIamPolicy(TableReference tableReference, GetTableIamPolicyOptions options = null)Gets the IAM policy applied to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | GetTableIamPolicyOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
Google.Apis.Bigquery.v2.Data.Policy | The table's IAM policy. |
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 | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
options | GetTableIamPolicyOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<Google.Apis.Bigquery.v2.Data.Policy> | A task representing the asynchronous operation. When complete, the result is the table's IAM policy. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA 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 | InsertOptionsThe 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. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA 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 | InsertOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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. |
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | ListDatasetsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.DatasetList, BigQueryDataset> | A sequence of datasets within the specified project. |
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | ListDatasetsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.DatasetList, BigQueryDataset> | An asynchronous sequence of datasets within the specified project. |
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | ListJobsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.JobList, BigQueryJob> | A sequence of the jobs within the specified project. |
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 | Google.Apis.Bigquery.v2.Data.ProjectReferenceA fully-qualified identifier for the project. Must not be null. |
options | ListJobsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.JobList, BigQueryJob> | An asynchronous sequence of the jobs within the specified project. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListModelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ListModelsResponse, BigQueryModel> | A sequence of models within the dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListModelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ListModelsResponse, BigQueryModel> | A sequence of models within the dataset. |
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 | ListProjectsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ProjectList, CloudProject> | A sequence of projects the user has access to. |
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 | ListProjectsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ProjectList, CloudProject> | An asynchronous sequence of projects the user has access to. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListRoutinesOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.ListRoutinesResponse, BigQueryRoutine> | A sequence of tables within the dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListRoutinesOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.ListRoutinesResponse, BigQueryRoutine> | A sequence of routines within the dataset. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe 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. |
options | ListRowsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.TableDataList, BigQueryRow> | The results of listing the rows within the table. |
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 | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema to use when interpreting results. This may be null, in which case it will be fetched from the table first. |
options | ListRowsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.TableDataList, BigQueryRow> | An asynchronous sequence of the rows within the table. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListTablesOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<Google.Apis.Bigquery.v2.Data.TableList, BigQueryTable> | A sequence of tables within the dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
options | ListTablesOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<Google.Apis.Bigquery.v2.Data.TableList, BigQueryTable> | A sequence of tables within the dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA 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 | ModifyLabelsOptionsThe 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 |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA 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 | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe 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 |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryDataset | The updated dataset. |
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 | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryDataset> | A task representing the asynchronous operation. When complete, the result is the updated dataset. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
PatchModel(ModelReference, Model, PatchModelOptions)
public override BigQueryModel PatchModel(ModelReference modelReference, Model resource, PatchModelOptions options = null)Patches the specified model with fields in the given resource.
| Parameters | |
|---|---|
| Name | Description |
modelReference | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.ModelThe model resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryModel | The updated model. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
PatchModelAsync(ModelReference, Model, PatchModelOptions, CancellationToken)
public override async Task<BigQueryModel> PatchModelAsync(ModelReference modelReference, Model resource, PatchModelOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously patches the specified model with fields in the given resource.
| Parameters | |
|---|---|
| Name | Description |
modelReference | Google.Apis.Bigquery.v2.Data.ModelReferenceA fully-qualified identifier for the model. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.ModelThe model resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchModelOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryModel> | A task representing the asynchronous operation. When complete, the result is the updated model. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
PatchTable(TableReference, Table, PatchTableOptions)
public override BigQueryTable PatchTable(TableReference tableReference, Table resource, PatchTableOptions options = null)Patches the specified table with fields in the given resource.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe table resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The updated table. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
PatchTableAsync(TableReference, Table, PatchTableOptions, CancellationToken)
public override async Task<BigQueryTable> PatchTableAsync(TableReference tableReference, Table resource, PatchTableOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously patches the specified table with fields in the given resource.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe table resource representation to use for the patch. Only fields present in the resource will be updated. |
options | PatchTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryTable> | A task representing the asynchronous operation. When complete, the result is the updated table. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
PollJobUntilCompleted(JobReference, GetJobOptions, PollSettings)
public override BigQueryJob PollJobUntilCompleted(JobReference jobReference, GetJobOptions options = null, PollSettings pollSettings = null)Polls the specified job for completion.
| Parameters | |
|---|---|
| Name | Description |
jobReference | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
pollSettings | PollSettingsThe settings to control how often and long the job is fetched before timing out if it is still incomplete. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | The completed job. |
PollJobUntilCompletedAsync(JobReference, GetJobOptions, PollSettings, CancellationToken)
public override Task<BigQueryJob> PollJobUntilCompletedAsync(JobReference jobReference, GetJobOptions options = null, PollSettings pollSettings = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously polls the specified job for completion.
| Parameters | |
|---|---|
| Name | Description |
jobReference | Google.Apis.Bigquery.v2.Data.JobReferenceA fully-qualified identifier for the job. Must not be null. |
options | GetJobOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
pollSettings | PollSettingsThe settings to control how often and long the job is fetched before timing out if it is still incomplete. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is the completed job. |
RemoveDatasetLabel(DatasetReference, String, ModifyLabelsOptions)
public override string RemoveDatasetLabel(DatasetReference datasetReference, string labelName, ModifyLabelsOptions options = null)Removes a label from a dataset, if it previously existed. It is not an error to attempt to remove a label that doesn't already exist.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
labelName | StringThe name of the label. Must not be null. |
options | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
String | The previous value of the label, or |
RemoveDatasetLabelAsync(DatasetReference, String, ModifyLabelsOptions, CancellationToken)
public override async Task<string> RemoveDatasetLabelAsync(DatasetReference datasetReference, string labelName, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously removes a label from a dataset, if it previously existed. It is not an error to attempt to remove a label that doesn't already exist.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
labelName | StringThe name of the label. Must not be null. |
options | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<String> | A task representing the asynchronous operation. When complete, the result is
the previous value of the label, or |
SetDatasetLabel(DatasetReference, String, String, ModifyLabelsOptions)
public override string SetDatasetLabel(DatasetReference datasetReference, string labelName, string labelValue, ModifyLabelsOptions options = null)Sets the value for a single label on a dataset. The label will be added if it does not exist, or updated if it already exists.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
labelName | StringThe name of the label. Must not be null. |
labelValue | StringThe new value of the label. Must not be null. |
options | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
String | The previous value of the label, or |
The dataset is first fetched to retrieve the current values, then a patch call is made.
SetDatasetLabelAsync(DatasetReference, String, String, ModifyLabelsOptions, CancellationToken)
public override async Task<string> SetDatasetLabelAsync(DatasetReference datasetReference, string labelName, string labelValue, ModifyLabelsOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously sets the value for a single label on a dataset. The label will be added if it does not exist, or updated if it already exists.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
labelName | StringThe name of the label. Must not be null. |
labelValue | StringThe new value of the label. Must not be null. |
options | ModifyLabelsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<String> | A task representing the asynchronous operation. When complete, the result is
the previous value of the label, or |
The dataset is first fetched to retrieve the current values, then a patch call is made.
SetTableIamPolicy(TableReference, Policy, SetTableIamPolicyOptions)
public override Policy SetTableIamPolicy(TableReference tableReference, Policy policy, SetTableIamPolicyOptions options = null)Applies the given IAM policy to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
policy | Google.Apis.Bigquery.v2.Data.PolicyThe policy to set on the table. An update mask may be specified through options. |
options | SetTableIamPolicyOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
Google.Apis.Bigquery.v2.Data.Policy | The resulting IAM policy after aplying the given policy. |
SetTableIamPolicyAsync(TableReference, Policy, SetTableIamPolicyOptions, CancellationToken)
public override async Task<Policy> SetTableIamPolicyAsync(TableReference tableReference, Policy policy, SetTableIamPolicyOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously applies the given IAM policy to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
policy | Google.Apis.Bigquery.v2.Data.PolicyThe policy to set on the table. An update mask may be specified through options. |
options | SetTableIamPolicyOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<Google.Apis.Bigquery.v2.Data.Policy> | A task representing the asynchronous operation. When complete, the result is the resulting IAM policy after aplying the given policy. |
TestTableIamPermissions(TableReference, IList<String>, TestTableIamPermissionsOptions)
public override TestIamPermissionsResponse TestTableIamPermissions(TableReference tableReference, IList<string> permissions, TestTableIamPermissionsOptions options = null)Returns the subset of permissions that the caller has on the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
permissions | IList<String>The permissions to test on the table. |
options | TestTableIamPermissionsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
Google.Apis.Bigquery.v2.Data.TestIamPermissionsResponse | The subset of permissions that the caller has on {target}. |
TestTableIamPermissionsAsync(TableReference, IList<String>, TestTableIamPermissionsOptions, CancellationToken)
public override async Task<TestIamPermissionsResponse> TestTableIamPermissionsAsync(TableReference tableReference, IList<string> permissions, TestTableIamPermissionsOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously returns the subset of permissions that the caller has on the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
permissions | IList<String>The permissions to test on the table. |
options | TestTableIamPermissionsOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<Google.Apis.Bigquery.v2.Data.TestIamPermissionsResponse> | A task representing the asynchronous operation. When complete, the result is the subset of permissions that the caller has on {target}. |
UpdateDataset(DatasetReference, Dataset, UpdateDatasetOptions)
public override BigQueryDataset UpdateDataset(DatasetReference datasetReference, Dataset resource, UpdateDatasetOptions options = null)Updates the specified dataset to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the update. All updatable fields will be updated. |
options | UpdateDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryDataset | The updated dataset. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UpdateDatasetAsync(DatasetReference, Dataset, UpdateDatasetOptions, CancellationToken)
public override async Task<BigQueryDataset> UpdateDatasetAsync(DatasetReference datasetReference, Dataset resource, UpdateDatasetOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously updates the specified dataset to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
datasetReference | Google.Apis.Bigquery.v2.Data.DatasetReferenceA fully-qualified identifier for the dataset. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.DatasetThe dataset resource representation to use for the update. All updatable fields will be updated. |
options | UpdateDatasetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryDataset> | A task representing the asynchronous operation. When complete, the result is the updated dataset. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UpdateRoutine(RoutineReference, Routine, UpdateRoutineOptions)
public override BigQueryRoutine UpdateRoutine(RoutineReference routineReference, Routine resource, UpdateRoutineOptions options = null)Updates the specified routine to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
routineReference | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe routine resource representation to use for the update. All updatable fields will be updated. 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. |
options | UpdateRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryRoutine | The updated routine. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UpdateRoutineAsync(RoutineReference, Routine, UpdateRoutineOptions, CancellationToken)
public override async Task<BigQueryRoutine> UpdateRoutineAsync(RoutineReference routineReference, Routine resource, UpdateRoutineOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously updates the specified routine to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
routineReference | Google.Apis.Bigquery.v2.Data.RoutineReferenceA fully-qualified identifier for the routine. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.RoutineThe routine resource representation to use for the update. All updatable fields will be updated. 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. |
options | UpdateRoutineOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryRoutine> | A task representing the asynchronous operation. When complete, the result is the updated routine. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UpdateTable(TableReference, Table, UpdateTableOptions)
public override BigQueryTable UpdateTable(TableReference tableReference, Table resource, UpdateTableOptions options = null)Updates the specified table to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe table resource representation to use for the update. All updatable fields will be updated. |
options | UpdateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryTable | The updated table. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UpdateTableAsync(TableReference, Table, UpdateTableOptions, CancellationToken)
public override async Task<BigQueryTable> UpdateTableAsync(TableReference tableReference, Table resource, UpdateTableOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously updates the specified table to match the specified resource.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
resource | Google.Apis.Bigquery.v2.Data.TableThe table resource representation to use for the update. All updatable fields will be updated. |
options | UpdateTableOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryTable> | A task representing the asynchronous operation. When complete, the result is the updated table. |
If the resource contains an ETag, it is used for optimistic concurrency validation.
UploadAvro(TableReference, TableSchema, Stream, UploadAvroOptions)
public override BigQueryJob UploadAvro(TableReference tableReference, TableSchema schema, Stream input, UploadAvroOptions options = null)Uploads a stream of Avro data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaUnused. In earlier versions this specified the schema of the data, but it is now ignored as the schema is always inferred from the data. The parameter is only present for backward compatibility. |
input | StreamThe stream of input data. Must not be null. |
options | UploadAvroOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
UploadAvroAsync(TableReference, TableSchema, Stream, UploadAvroOptions, CancellationToken)
public override async Task<BigQueryJob> UploadAvroAsync(TableReference tableReference, TableSchema schema, Stream input, UploadAvroOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a stream of Avro data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaUnused. In earlier versions this specified the schema of the data, but it is now ignored as the schema is always inferred from the data. The parameter is only present for backward compatibility. |
input | StreamThe stream of input data. Must not be null. |
options | UploadAvroOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
UploadCsv(TableReference, TableSchema, Stream, UploadCsvOptions)
public override BigQueryJob UploadCsv(TableReference tableReference, TableSchema schema, Stream input, UploadCsvOptions options = null)Uploads a stream of CSV data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
input | StreamThe stream of input data. Must not be null. |
options | UploadCsvOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadCsvAsync(TableReference, TableSchema, Stream, UploadCsvOptions, CancellationToken)
public override async Task<BigQueryJob> UploadCsvAsync(TableReference tableReference, TableSchema schema, Stream input, UploadCsvOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a stream of CSV data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
input | StreamThe stream of input data. Must not be null. |
options | UploadCsvOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadJson(TableReference, TableSchema, IEnumerable<String>, UploadJsonOptions)
public override BigQueryJob UploadJson(TableReference tableReference, TableSchema schema, IEnumerable<string> rows, UploadJsonOptions options = null)Uploads a sequence of JSON rows to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
rows | IEnumerable<String>The sequence of JSON strings to upload. Must not be null, and must not contain null elements. |
options | UploadJsonOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
Each element of rows is converted into a single line of text by replacing carriage returns and line
feeds with spaces. This is safe as they cannot exist within well-formed JSON keys or values, and simply means that the
original JSON can be formatted however you choose.
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadJson(TableReference, TableSchema, Stream, UploadJsonOptions)
public override BigQueryJob UploadJson(TableReference tableReference, TableSchema schema, Stream input, UploadJsonOptions options = null)Uploads a stream of JSON data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
input | StreamThe stream of input data. Must not be null. |
options | UploadJsonOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadJsonAsync(TableReference, TableSchema, IEnumerable<String>, UploadJsonOptions, CancellationToken)
public override Task<BigQueryJob> UploadJsonAsync(TableReference tableReference, TableSchema schema, IEnumerable<string> rows, UploadJsonOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a sequence of JSON rows to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
rows | IEnumerable<String>The sequence of JSON strings to upload. Must not be null, and must not contain null elements. |
options | UploadJsonOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
Each element of rows is converted into a single line of text by replacing carriage returns and line
feeds with spaces. This is safe as they cannot exist within well-formed JSON keys or values, and simply means that the
original JSON can be formatted however you choose.
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadJsonAsync(TableReference, TableSchema, Stream, UploadJsonOptions, CancellationToken)
public override async Task<BigQueryJob> UploadJsonAsync(TableReference tableReference, TableSchema schema, Stream input, UploadJsonOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a stream of JSON data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
schema | Google.Apis.Bigquery.v2.Data.TableSchemaThe schema of the data, or null for the schema to be loaded from the destination table or inferred (based on |
input | StreamThe stream of input data. Must not be null. |
options | UploadJsonOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
The schema can come from three places: it can be specified by schema,
it can be retrieved from the destination table if that already exists, or it can be inferred by the server.
If schema is null and the Autodetect of options is not set to true,
it is expected that the table already exists, and its schema is loaded automatically.
UploadOrc(TableReference, Stream, UploadOrcOptions)
public override BigQueryJob UploadOrc(TableReference tableReference, Stream input, UploadOrcOptions options = null)Uploads a stream of ORC data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
input | StreamThe stream of input data. Must not be null. |
options | UploadOrcOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
UploadOrcAsync(TableReference, Stream, UploadOrcOptions, CancellationToken)
public override async Task<BigQueryJob> UploadOrcAsync(TableReference tableReference, Stream input, UploadOrcOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a stream of ORC data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
input | StreamThe stream of input data. Must not be null. |
options | UploadOrcOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
UploadParquet(TableReference, Stream, UploadParquetOptions)
public override BigQueryJob UploadParquet(TableReference tableReference, Stream input, UploadParquetOptions options = null)Uploads a stream of Parquet data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
input | StreamThe stream of input data. Must not be null. |
options | UploadParquetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
| Returns | |
|---|---|
| Type | Description |
BigQueryJob | A data upload job. |
UploadParquetAsync(TableReference, Stream, UploadParquetOptions, CancellationToken)
public override async Task<BigQueryJob> UploadParquetAsync(TableReference tableReference, Stream input, UploadParquetOptions options = null, CancellationToken cancellationToken = default(CancellationToken))Asynchronously uploads a stream of Parquet data to the specified table.
| Parameters | |
|---|---|
| Name | Description |
tableReference | Google.Apis.Bigquery.v2.Data.TableReferenceA fully-qualified identifier for the table. Must not be null. |
input | StreamThe stream of input data. Must not be null. |
options | UploadParquetOptionsThe options for the operation. May be null, in which case defaults will be supplied. |
cancellationToken | CancellationTokenThe token to monitor for cancellation requests. |
| Returns | |
|---|---|
| Type | Description |
Task<BigQueryJob> | A task representing the asynchronous operation. When complete, the result is a data upload job. |
WithDefaultLocation(String)
public override BigQueryClient WithDefaultLocation(string defaultLocation)Creates a new client which uses the specified location by default for all operations where locations can be specified, such as dataset and job creation.
| Parameter | |
|---|---|
| Name | Description |
defaultLocation | StringThe location to use by default, for job creation etc. |
| Returns | |
|---|---|
| Type | Description |
BigQueryClient | A new client with the specified default location. |
Implementations should normally ensure that the object returned is of the same type as this client, in case users need implementation-specific features of that client.