diff --git a/java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java b/java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java index f2de6cd0da05..c6f7035ee040 100644 --- a/java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java +++ b/java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java @@ -38,7 +38,18 @@ /** * An interface for Google Cloud BigQuery. * - * @see Google Cloud BigQuery + *

Provides synchronous operations to manage BigQuery resources ({@link Dataset}, {@link Table}, + * {@link Model}, {@link Routine}), run SQL queries ({@link #query(QueryJobConfiguration, + * JobOption...)}), submit and monitor asynchronous {@link Job}s, and ingest data ({@link #writer}, + * {@link #insertAll}). + * + *

Typically, create one {@code BigQuery} instance per application via {@link + * BigQueryOptions#getService()} and reuse it across threads. Call {@link #close()} on application + * shutdown to release cached background resources (such as Storage Read API clients used for query + * streaming). Operations on {@code BigQuery} are thread-safe, except for stateful helpers returned + * by this client such as {@link Connection} and {@link TableDataWriteChannel}. + * + * @see Google Cloud BigQuery */ public interface BigQuery extends Service, AutoCloseable {