Skip to content

feat(bigquery): add internal listProjects API to core client#13429

Open
keshavdandeva wants to merge 3 commits into
mainfrom
add-listProjects
Open

feat(bigquery): add internal listProjects API to core client#13429
keshavdandeva wants to merge 3 commits into
mainfrom
add-listProjects

Conversation

@keshavdandeva

Copy link
Copy Markdown
Contributor

b/521443900

This PR introduces support for fetching a list of GCP projects via the BigQuery API. This functionality is being exposed primarily to support cross-project dataset resolution in the native BigQuery JDBC driver.

Changes included:

  • Domain Model: Added Project domain model representing a BigQuery project (@BetaApi).
  • Client Interface: Added listProjects(ProjectListOption... options) to the BigQuery client interface, marked as @InternalApi to preserve the public GA surface.
  • SPI Layer: Added listProjects mapping to BigQueryRpc and implemented the underlying HTTP execution in HttpBigQueryRpc, including pagination and OpenTelemetry tracing support.
  • Implementation: Implemented ProjectPageFetcher inside BigQueryImpl to seamlessly handle paginated project results.
  • Testing: Added unit test coverage in BigQueryImplTest and HttpBigQueryRpcTest.

@keshavdandeva keshavdandeva requested review from a team as code owners June 11, 2026 14:40
@keshavdandeva keshavdandeva requested a review from lqiu96 June 11, 2026 14:41

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces the ability to list Google Cloud Projects accessible to the caller. It adds a new Project model class, a ProjectListOption class for pagination options, and the listProjects method to the BigQuery interface and its implementation BigQueryImpl. It also updates the underlying RPC layer (BigQueryRpc and HttpBigQueryRpc) to support the new API call with OpenTelemetry tracing, and includes corresponding unit tests. There are no review comments to address.

import java.util.Objects;

@BetaApi
public class Project implements Serializable {

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add some documentation that this is a wrapper for Projects: https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/projects/list.

I think something similar to

/**
* Google BigQuery Job information. Jobs are objects that manage asynchronous tasks such as running
* queries, loading data, and exporting data. Use {@link CopyJobConfiguration} for a job that copies
* an existing table. Use {@link ExtractJobConfiguration} for a job that exports a table to Google
* Cloud Storage. Use {@link LoadJobConfiguration} for a job that loads data from Google Cloud
* Storage into a table. Use {@link QueryJobConfiguration} for a job that runs a query.
*
* @see <a href="https://cloud.google.com/bigquery/docs/reference/v2/jobs">Jobs</a>
*/

Comment on lines +39 to +53
public String getId() {
return id;
}

public String getNumericId() {
return numericId;
}

public String getProjectId() {
return projectId;
}

public String getFriendlyName() {
return friendlyName;
}

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for these public getters can you add a small javadoc section?

Comment on lines +33 to +35
this.id = id;
this.numericId = numericId;
this.projectId = projectId;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

qq, what is the difference between id, numericId, and projectId?

From the link (https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/projects/list), I see id and numericId, but not projectId


/** Class for specifying project list options. */
class ProjectListOption extends Option {
private static final long serialVersionUID = 1L;

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this should be too impactful otherwise, but you can have intellij autogenerate a value for this?

* @param options options for listing projects
* @return a page of projects
*/
@InternalApi

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm, I think this is an offical BigQuery api (https://docs.cloud.google.com/bigquery/docs/reference/rest/v2/projects/list) and we probably don't need to add InternalApi here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants