Google BigQuery

Lists all data exchanges from projects in a given organization and location.

Creates a new data exchange. POST /v1/{+parent}/dataExchanges on Google BigQuery. Requires parent.

DESTRUCTIVE - Deletes an existing data exchange.

Gets the details of a data exchange. GET /v1/{+name} on Google BigQuery. Requires name.

Gets the IAM policy. POST /v1/{+resource}:getIamPolicy on Google BigQuery. Requires resource.

Lists all data exchanges in a given project and location.

Lists all subscriptions on a given Data Exchange or Listing.

Creates a new listing. POST /v1/{+parent}/listings on Google BigQuery. Requires parent.

DESTRUCTIVE — Deletes a listing. DELETE /v1/{+name} on Google BigQuery. Requires name.

Gets the details of a listing. GET /v1/{+name} on Google BigQuery. Requires name.

Gets the IAM policy. POST /v1/{+resource}:getIamPolicy on Google BigQuery. Requires resource.

Lists all listings in a given project and location.

Lists all subscriptions on a given Data Exchange or Listing.

Updates an existing listing. PATCH /v1/{+name} on Google BigQuery. Requires name.

Sets the IAM policy. POST /v1/{+resource}:setIamPolicy on Google BigQuery. Requires resource.

Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.

Returns the permissions that a caller has.

Updates an existing data exchange. PATCH /v1/{+name} on Google BigQuery. Requires name.

Approves a query template. POST /v1/{+name}:approve on Google BigQuery. Requires name.

Creates a new QueryTemplate. POST /v1/{+parent}/queryTemplates on Google BigQuery. Requires parent.

DESTRUCTIVE — Deletes a query template. DELETE /v1/{+name} on Google BigQuery. Requires name.

Gets a QueryTemplate. GET /v1/{+name} on Google BigQuery. Requires name.

Lists all QueryTemplates in a given project and location.

Updates an existing QueryTemplate. PATCH /v1/{+name} on Google BigQuery. Requires name.

Submits a query template for approval. POST /v1/{+name}:submit on Google BigQuery. Requires name.

Sets the IAM policy. POST /v1/{+resource}:setIamPolicy on Google BigQuery. Requires resource.

Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets. Throws a Bad Request error if the Data Exchange does not contain any listings.

Returns the permissions that a caller has.

DESTRUCTIVE — Deletes a subscription. DELETE /v1/{+name} on Google BigQuery. Requires name.

Gets the details of a Subscription. GET /v1/{+name} on Google BigQuery. Requires name.

Gets the IAM policy. POST /v1/{+resource}:getIamPolicy on Google BigQuery. Requires resource.

Lists all subscriptions in a given project and location.

Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.

DESTRUCTIVE - Revokes a given subscription.

Sets the IAM policy. POST /v1/{+resource}:setIamPolicy on Google BigQuery. Requires resource.

Creates a new connection. POST /v1/{+parent}/connections on Google BigQuery. Requires parent.

DESTRUCTIVE - Deletes connection and associated credential.

Returns specified connection. GET /v1/{+name} on Google BigQuery. Requires name.

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

Returns a list of connections in the given project.

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

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

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...

Creates a new data policy under a project with the given `dataPolicyId` (used as the display name), policy tag, and data policy type.

DESTRUCTIVE - Deletes the data policy specified by its resource name.

Gets the data policy specified by its resource name.

Gets the IAM policy for the specified data policy.

List all of the data policies in the specified parent project.

Updates the metadata for an existing data policy. The target data policy can be specified by the resource name.

Renames the id (display name) of the specified data policy.

Sets the IAM policy for the specified data policy.

Returns the caller's permission on the specified data policy resource.

DESTRUCTIVE - 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...

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

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

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...

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...

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...

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`...

Returns true if valid credentials exist for the given data source and requesting user.

Retrieves a supported data source and returns its settings.

Lists supported data sources and returns their settings.

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and...

Returns true if valid credentials exist for the given data source and requesting user.

Retrieves a supported data source and returns its settings.

Lists supported data sources and returns their settings.

Enroll data sources in a user project. This allows users to create transfer configurations for these data sources. They will also appear in the ListDataSources RPC and as such, will appear in the [BigQuery UI](https://console.cloud.google.com/bigquery), and...

Gets information about a location. GET /v1/{+name} on Google BigQuery. Requires name.

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations...

Creates a new data transfer configuration. Requires credentials of its own for data sources that read a third party on the user's behalf (scheduled_query, google_ads, youtube_channel, drive and similar): pass service_account_name (an email, for unattended runs) or version_info (a short-lived consent code from the Data Transfer Service's own OAuth screen). Google marks both optional because a BigQuery-to-BigQuery transfer needs neither; for the sources above the create is refused without one.

DESTRUCTIVE - Deletes a data transfer configuration, including any associated transfer runs and logs.

Returns information about a data transfer config.

Returns information about all transfer configs owned by a project in the specified location.

Updates a data transfer configuration. All fields must be set, even if they are not updated. Requires credentials of its own for data sources that read a third party on the user's behalf (scheduled_query, google_ads, youtube_channel, drive and similar): pass service_account_name (an email, for unattended runs) or version_info (a short-lived consent code from the Data Transfer Service's own OAuth screen). Google marks both optional because a BigQuery-to-BigQuery transfer needs neither; for the sources above the create is refused without one.

DESTRUCTIVE - Deletes the specified transfer run.

Returns information about the particular transfer run.

Returns information about running and completed transfer runs.

Returns log messages for the transfer run.

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use...

Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is...

Returns a transfer resource. GET /v1/{+name} on Google BigQuery. Requires name.

Returns information about transfer resources.

Unenroll data sources in a user project. This allows users to remove transfer configurations for these data sources. They will no longer appear in the ListDataSources RPC and will also no longer appear in the [BigQuery...

Creates a new data transfer configuration. Requires credentials of its own for data sources that read a third party on the user's behalf (scheduled_query, google_ads, youtube_channel, drive and similar): pass service_account_name (an email, for unattended runs) or version_info (a short-lived consent code from the Data Transfer Service's own OAuth screen). Google marks both optional because a BigQuery-to-BigQuery transfer needs neither; for the sources above the create is refused without one.

DESTRUCTIVE - Deletes a data transfer configuration, including any associated transfer runs and logs.

Returns information about a data transfer config.

Returns information about all transfer configs owned by a project in the specified location.

Updates a data transfer configuration. All fields must be set, even if they are not updated. Requires credentials of its own for data sources that read a third party on the user's behalf (scheduled_query, google_ads, youtube_channel, drive and similar): pass service_account_name (an email, for unattended runs) or version_info (a short-lived consent code from the Data Transfer Service's own OAuth screen). Google marks both optional because a BigQuery-to-BigQuery transfer needs neither; for the sources above the create is refused without one.

DESTRUCTIVE - Deletes the specified transfer run.

Returns information about the particular transfer run.

Returns information about running and completed transfer runs.

Returns log messages for the transfer run.

Creates transfer runs for a time range [start_time, end_time]. For each date - or whatever granularity the data source supports - in the range, one transfer run is created. Note that runs are created per UTC time in the time range. DEPRECATED: use...

Manually initiates transfer runs. You can schedule these runs in two ways: 1. For a specific point in time using the 'requested_run_time' parameter. 2. For a period between 'start_time' (inclusive) and 'end_time' (exclusive). If scheduling a single run, it is...

Returns a transfer resource. GET /v1/{+name} on Google BigQuery. Requires name.

Returns information about transfer resources.

DESTRUCTIVE - 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`...

DESTRUCTIVE - 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.

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...

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...

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...

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...

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...

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

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

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`...

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

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...

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](https://cloud.google.com/resource-manager/docs/) API, which provides the underlying data for this method and has...

Creates a new capacity commitment resource.

DESTRUCTIVE - Deletes a capacity commitment. Attempting to delete capacity commitment before its commitment_end_time will fail with the error code `google.rpc.Code.FAILED_PRECONDITION`.

Returns information about the capacity commitment.

Lists all the capacity commitments for the admin project.

Merges capacity commitments of the same plan into a single commitment. The resulting capacity commitment has the greater commitment_end_time out of the to-be-merged capacity commitments. Attempting to merge capacity commitments of different plan will fail...

Updates an existing capacity commitment. Only `plan` and `renewal_plan` fields can be updated. Plan can only be changed to a plan of a longer commitment period. Attempting to change to a plan with shorter commitment period will fail with the error code...

Splits capacity commitment to two commitments of the same plan and `commitment_end_time`. A common use case is to enable downgrading commitments. For example, in order to downgrade from 10000 slots to 8000, you might split a 10000 capacity commitment into...

Retrieves a BI reservation. GET /v1/{+name} on Google BigQuery. Requires name.

Creates a new reservation group. POST /v1/{+parent}/reservationGroups on Google BigQuery. Requires parent.

DESTRUCTIVE - Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.

Returns information about the reservation group.

Lists all the reservation groups for the project in the specified location.

Updates an existing reservation group resource.

Creates an assignment object which allows the given project to submit jobs of a certain type using slots from the specified reservation. Currently a resource (project, folder, organization) can only have one assignment per each (job_type, location)...

DESTRUCTIVE - Deletes a assignment. No expansion will happen. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously to define the following...

Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: -...

Lists assignments. Only explicitly created assignments will be returned. Example: * Organization `organizationA` contains two projects, `project1` and `project2`. * Reservation `res1` exists and was created previously. * CreateAssignment was used previously...

Moves an assignment under a new reservation. This differs from removing an existing assignment and recreating a new one by providing a transactional change that ensures an assignee always has an associated reservation.

Updates an existing assignment. Only the `priority` field can be updated.

Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.setIamPolicy` to set policies on...

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM permissions are required to call this method.

Creates a new reservation resource. POST /v1/{+parent}/reservations on Google BigQuery. Requires parent.

DESTRUCTIVE - Deletes a reservation. Returns `google.rpc.Code.FAILED_PRECONDITION` when reservation has assignments.

Fail over a reservation to the secondary location. The operation should be done in the current secondary location, which will be promoted to the new primary location for the reservation. Attempting to failover a reservation in the current primary location...

Returns information about the reservation.

Gets the access control policy for a resource. May return: * A`NOT_FOUND` error if the resource doesn't exist or you don't have the permission to view it. * An empty policy if the resource exists but doesn't have a set policy. Supported resources are: -...

Lists all the reservations for the project in the specified location.

Updates an existing reservation resource.

Sets an access control policy for a resource. Replaces any existing policy. Supported resources are: - Reservations To call this method, you must have the following Google IAM permissions: - `bigqueryreservation.reservations.setIamPolicy` to set policies on...

Gets your permissions on a resource. Returns an empty set of permissions if the resource doesn't exist. Supported resources are: - Reservations No Google IAM permissions are required to call this method.

Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be returned. 3...

Deprecated: Looks up assignments for a specified resource for a particular region. If the request is about a project: 1. Assignments created on the project will be returned if they exist. 2. Otherwise assignments created on the closest ancestor will be...

Updates a BI reservation. Only fields specified in the `field_mask` are updated. A singleton BI reservation always exists with default size 0. In order to reserve BI capacity it needs to be updated to an amount greater than 0. In order to release BI capacity...

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

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

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

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

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

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

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...

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.

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

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

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

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

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`

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

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...

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`

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. -...

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

DESTRUCTIVE - 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.

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.

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

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

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

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...

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

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...

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...