Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix BigQuery documentation formating #3565

Merged
merged 2 commits into from
Nov 4, 2024
Merged

docs: fix BigQuery documentation formating #3565

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d35393d
fix parentheses and use @see to link direct link
PhongChuong Oct 31, 2024
2b6efea
more doc fix
PhongChuong Nov 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 10 additions & 13 deletions google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuery.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,8 +244,9 @@ private DatasetListOption(BigQueryRpc.Option option, Object value) {
}

/**
* Returns an option to specify a label filter. See
* https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels
* Returns an option to specify a label filter. @see <a href=
* "https://cloud.google.com/bigquery/docs/adding-using-labels#filtering_datasets_using_labels">Filtering
* using labels</a>
*
* @param labelFilter In the form "labels.key:value"
*/
Expand Down Expand Up @@ -280,7 +281,7 @@ private DatasetOption(BigQueryRpc.Option option, Object value) {

/**
* Returns an option to specify the dataset's fields to be returned by the RPC call. If this
* option is not provided all dataset's fields are returned. { code DatasetOption.fields} can be
* option is not provided all dataset's fields are returned. {@code DatasetOption.fields} can be
* used to specify only the fields of interest. {@link Dataset#getDatasetId()} is always
* returned, even if not specified.
*/
Expand Down Expand Up @@ -864,8 +865,7 @@ public int hashCode() {
/**
* Lists the project's datasets. This method returns partial information on each dataset: ({@link
* Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link
* Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,
* DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.
* Dataset#getGeneratedId()}). To get complete information use {@link #getDataset}.
*
* <p>Example of listing datasets, specifying the page size.
*
Expand All @@ -884,8 +884,7 @@ public int hashCode() {
/**
* Lists the datasets in the provided project. This method returns partial information on each
* dataset: ({@link Dataset#getDatasetId()}, {@link Dataset#getFriendlyName()} and {@link
* Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset(String,
* DatasetOption...)} or {@link #getDataset(DatasetId, DatasetOption...)}.
* Dataset#getGeneratedId()}). To get complete information use either {@link #getDataset}.
*
* <p>Example of listing datasets in a project, specifying the page size.
*
Expand Down Expand Up @@ -1205,7 +1204,7 @@ public int hashCode() {
* Lists the tables in the dataset. This method returns partial information on each table: ({@link
* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
* which is part of {@link Table#getDefinition()}). To get complete information use either {@link
* #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.
* #getTable}.
*
* <p>Example of listing the tables in a dataset, specifying the page size.
*
Expand All @@ -1225,7 +1224,7 @@ public int hashCode() {
* Lists the tables in the dataset. This method returns partial information on each table: ({@link
* Table#getTableId()}, {@link Table#getFriendlyName()}, {@link Table#getGeneratedId()} and type,
* which is part of {@link Table#getDefinition()}). To get complete information use either {@link
* #getTable(TableId, TableOption...)} or {@link #getTable(String, String, TableOption...)}.
* #getTable}.
*
* <p>Example of listing the tables in a dataset.
*
Expand Down Expand Up @@ -1429,8 +1428,7 @@ TableResult listTableData(

/**
* Sends a job cancel request. This call will return immediately. The job status can then be
* checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,
* JobOption...)}).
* checked by using {@link #getJob}.
*
* <p>If the location of the job is not "US" or "EU", {@link #cancel(JobId)} must be used instead.
*
Expand All @@ -1454,8 +1452,7 @@ TableResult listTableData(

/**
* Sends a job cancel request. This call will return immediately. The job status can then be
* checked using either {@link #getJob(JobId, JobOption...)} or {@link #getJob(String,
* JobOption...)}).
* checked using {@link #getJob}.
*
* <p>If the location of the job is not "US" or "EU", the {@code jobId} must specify the job
* location.
Expand Down
Loading