Show / Hide Table of Contents

Namespace Google.Apis.Bigquery.v2

Classes

BigqueryBaseServiceRequest<TResponse>

A base abstract class for Bigquery requests.

BigqueryService

The Bigquery Service.

BigqueryService.Scope

Available OAuth 2.0 scopes for use with the BigQuery API.

BigqueryService.ScopeConstants

Available OAuth 2.0 scope constants for use with the BigQuery API.

DatasetsResource

The "datasets" collection of methods.

DatasetsResource.DeleteRequest

Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. # IAM Permissions Requires the bigquery.datasets.delete permission on the dataset.

DatasetsResource.GetRequest

Returns the dataset specified by datasetID. # IAM Permissions Requires the bigquery.datasets.get permission on the dataset.

DatasetsResource.InsertRequest

Creates a new empty dataset. # IAM Permissions Requires the bigquery.datasets.create permission on the project.

DatasetsResource.ListRequest

Lists all datasets in the specified project to which the user has been granted the READER dataset role. # IAM Permissions Requires no specific IAM permission(s) to use this method. Results are filtered to only include datasets on which the caller has the bigquery.datasets.get permission.

DatasetsResource.PatchRequest

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) to use this method: - bigquery.datasets.update on the dataset. - bigquery.datasets.get on the dataset.

DatasetsResource.UndeleteRequest

Undeletes a dataset which is within time travel window based on datasetId. If a time is specified, the dataset version deleted at that time is undeleted, else the last live version is undeleted. # IAM Permissions Requires the following IAM permission(s) to use this method: - bigquery.datasets.create on the project. - bigquery.datasets.get on the dataset.

DatasetsResource.UpdateRequest

Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. # IAM Permissions Requires the bigquery.datasets.update permission on the dataset.

JobsResource

The "jobs" collection of methods.

JobsResource.CancelRequest

Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. # IAM Permissions Requires the bigquery.jobs.update permission on the job resource. If the user matches the creator of the job, the bigquery.jobs.create permission on the project is required instead.

JobsResource.DeleteRequest

Requests the deletion of the metadata of a job. This call returns when the job's metadata is deleted. # IAM Permissions Requires the bigquery.jobs.delete permission on the job resource.

JobsResource.GetQueryResultsRequest

RPC to get the results of a query job. # IAM Permissions Requires the following IAM permission(s) to use this method: - bigquery.jobs.get on the job. - bigquery.tables.getData on the destination table. If the user matches the creator of the job, the following IAM permission(s) are required instead: - bigquery.jobs.create on the project. - bigquery.tables.getData on the destination table.

JobsResource.GetRequest

Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. # IAM Permissions Requires the bigquery.jobs.get permission on the job resource. If the user matches the creator of the job, the bigquery.jobs.create permission on the project is required instead.

JobsResource.InsertMediaUpload

Insert media upload which supports resumable upload.

JobsResource.InsertRequest

Starts a new asynchronous job. This API has two different kinds of endpoint URIs, as this method supports a variety of use cases. * The Metadata URI is used for most interactions, as it accepts the job configuration directly. * The Upload URI is ONLY for the case when you're sending both a load job configuration and a data stream together. In this case, the Upload URI accepts the job configuration and the data as two distinct multipart MIME parts. # IAM Permissions Requires the bigquery.jobs.create permission on the project resource. Additional permissions are required depending on the job type: - Load, Export, and Copy jobs: Generally require data-level permissions such as bigquery.tables.export or access to external storage. - Query jobs: Permissions are dependent on the SQL statement. Complex queries (DDL, DCL) may require additional permissions to create reservations, modify IAM policies, or update project settings.

JobsResource.ListRequest

Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. # IAM Permissions Requires no specific IAM permission(s) to use this method. Users are able to list the jobs they created. Additional access is granted based on the following permissions: - Users with the bigquery.jobs.listAll permission can list all jobs with all metadata. - Users with the bigquery.jobs.list permission can list all jobs, but with redacted information for jobs they did not create.

JobsResource.QueryRequest

Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. # IAM Permissions Requires the bigquery.jobs.create permission on the project resource. Data-level permissions are highly dependent on the SQL statement being executed. While standard queries require data access (such as bigquery.tables.getData), complex operations like DDL or DCL may require permissions to manage reservations, IAM policies, or project settings.

ModelsResource

The "models" collection of methods.

ModelsResource.DeleteRequest

Deletes the model specified by modelId from the dataset. # IAM Permissions Requires the bigquery.models.delete permission on the model.

ModelsResource.GetRequest

Gets the specified model resource by model ID. # IAM Permissions Requires the bigquery.models.getMetadata permission on the model.

ModelsResource.ListRequest

Lists all models in the specified dataset. Requires the READER dataset role. After retrieving the list of models, you can get information about a particular model by calling the models.get method. # IAM Permissions Requires the bigquery.models.list permission on the dataset.

ModelsResource.PatchRequest

Patch specific fields in the specified model. # IAM Permissions Requires the bigquery.models.updateMetadata permission on the model.

ProjectsResource

The "projects" collection of methods.

ProjectsResource.GetServiceAccountRequest

RPC to get the service account for a project used for interactions with Google Cloud KMS. Requires the bigquery.jobs.create permission on the project resource. This permission is required to authorize the retrieval of the project's service identity for technical management tasks like encryption configuration.

ProjectsResource.ListRequest

RPC to list projects to which the user has been granted any project role. Users of this method are encouraged to consider the Resource Manager API, which provides the underlying data for this method and has more capabilities. # IAM Permissions Requires no specific IAM permission(s) to use this method. The results are filtered to only include projects on which the caller has been granted a project-level role such as a BigQuery predefined IAM role or a basic role such as Viewer or Owner.

RoutinesResource

The "routines" collection of methods.

RoutinesResource.DeleteRequest

Deletes the routine specified by routineId from the dataset. # IAM Permissions Requires the bigquery.routines.delete permission on the routine.

RoutinesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

RoutinesResource.GetRequest

Gets the specified routine resource by routine ID. # IAM Permissions Requires the bigquery.routines.get permission on the routine.

RoutinesResource.InsertRequest

Creates a new routine in the dataset. # IAM Permissions Requires the bigquery.routines.create permission on the dataset.

RoutinesResource.ListRequest

Lists all routines in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the bigquery.routines.list permission on the dataset.

RoutinesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

RoutinesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

RoutinesResource.UpdateRequest

Updates information in an existing routine. The update method replaces the entire Routine resource. # IAM Permissions Requires the bigquery.routines.update permission on the routine.

RowAccessPoliciesResource

The "rowAccessPolicies" collection of methods.

RowAccessPoliciesResource.BatchDeleteRequest

Deletes provided row access policies. # IAM Permissions Requires the following IAM permission(s) on the table: - bigquery.rowAccessPolicies.delete - bigquery.rowAccessPolicies.setIamPolicy

RowAccessPoliciesResource.DeleteRequest

Deletes a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - bigquery.rowAccessPolicies.delete - bigquery.rowAccessPolicies.setIamPolicy

RowAccessPoliciesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

RowAccessPoliciesResource.GetRequest

Gets the specified row access policy by policy ID. # IAM Permissions Requires the bigquery.rowAccessPolicies.get permission on the table.

RowAccessPoliciesResource.InsertRequest

Creates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - bigquery.rowAccessPolicies.create - bigquery.rowAccessPolicies.setIamPolicy - bigquery.tables.getData

RowAccessPoliciesResource.ListRequest

Lists all row access policies on the specified table. # IAM Permissions Requires the bigquery.rowAccessPolicies.list permission on the table.

RowAccessPoliciesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

RowAccessPoliciesResource.UpdateRequest

Updates a row access policy. # IAM Permissions Requires the following IAM permission(s) on the table: - bigquery.rowAccessPolicies.update - bigquery.rowAccessPolicies.setIamPolicy - bigquery.tables.getData

TabledataResource

The "tabledata" collection of methods.

TabledataResource.InsertAllRequest

Streams data into BigQuery one record at a time without needing to run a load job. # IAM Permissions Requires the following IAM permission(s) to use this method: - bigquery.tables.updateData on the table. - bigquery.tables.get on the table. - bigquery.datasets.get on the dataset.

TabledataResource.ListRequest

List the content of a table in rows. # IAM Permissions Requires the bigquery.tables.getData permission on the table.

TablesResource

The "tables" collection of methods.

TablesResource.DeleteRequest

Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. # IAM Permissions Requires the bigquery.tables.delete permission on the table.

TablesResource.GetIamPolicyRequest

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

TablesResource.GetRequest

Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. # IAM Permissions Requires the bigquery.tables.get permission on the table.

TablesResource.InsertRequest

Creates a new, empty table in the dataset. # IAM Permissions Requires the bigquery.tables.create permission on the dataset.

TablesResource.ListRequest

Lists all tables in the specified dataset. Requires the READER dataset role. # IAM Permissions Requires the bigquery.tables.list permission on the dataset.

TablesResource.PatchRequest

Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports RFC5789 patch semantics. # IAM Permissions Requires the following IAM permission(s) on the table: - bigquery.tables.update - bigquery.tables.get

TablesResource.SetIamPolicyRequest

Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

TablesResource.TestIamPermissionsRequest

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.

TablesResource.UpdateRequest

Updates information in an existing table. The update method replaces the entire Table resource, whereas the patch method only replaces fields that are provided in the submitted Table resource. # IAM Permissions Requires the bigquery.tables.update permission on the table.

Enums

BigqueryBaseServiceRequest<TResponse>.AltEnum

Data format for response.

BigqueryBaseServiceRequest<TResponse>.XgafvEnum

V1 error format.

DatasetsResource.GetRequest.DatasetViewEnum

Optional. Specifies the view that determines which dataset information is returned. By default, metadata and ACL information are returned.

DatasetsResource.PatchRequest.UpdateModeEnum

Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.

DatasetsResource.UpdateRequest.UpdateModeEnum

Optional. Specifies the fields of dataset that update/patch operation is targeting By default, both metadata and ACL fields are updated.

JobsResource.GetQueryResultsRequest.FormatOptionsTimestampOutputFormatEnum

Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing use_int64_timestamp option.

JobsResource.InsertMediaUpload.AltEnum

Data format for response.

JobsResource.InsertMediaUpload.XgafvEnum

V1 error format.

JobsResource.ListRequest.ProjectionEnum

Restrict information returned to a set of selected fields

JobsResource.ListRequest.StateFilterEnum

Filter for job state

TabledataResource.ListRequest.FormatOptionsTimestampOutputFormatEnum

Optional. The API output format for a timestamp. This offers more explicit control over the timestamp output format as compared to the existing use_int64_timestamp option.

TablesResource.GetRequest.ViewEnum

Optional. Specifies the view that determines which table information is returned. By default, basic table information and storage statistics (STORAGE_STATS) are returned.

In this article
Back to top Generated by DocFX