Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,12 @@ public BigQueryError(String reason, String location, String message) {
}

/**
* Returns short error code that summarizes the error.
* Returns a short error code that summarizes the error (for example, {@code rateLimitExceeded},
* {@code backendError}, or {@code notFound}).
*
* <p>Inspect this reason alongside the HTTP status code when classifying transient versus
* permanent failures, because distinct BigQuery errors can share an HTTP status code or occur
* asynchronously in job status without an HTTP status code.
*
* @see <a href="https://docs.cloud.google.com/bigquery/docs/errors">BigQuery API HTTP status and
* error codes</a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,17 @@
/**
* BigQuery service exception.
*
* <p>BigQuery often indicates whether a failure is transient or permanent through a structured
* error reason ({@link #getReason()}, {@link #getError()}, or {@link #getErrors()}) rather than the
* HTTP status code alone. For example, rate-limit errors may arrive with HTTP 403, and
* job-execution errors surfaced from job status have {@link #getCode()} equal to {@code 0}.
*
* <p>{@link #isRetryable()} classifies only HTTP 500, 502, 503, 504, and low-level transport {@link
* IOException} failures as retryable. When deciding whether to retry, inspect the structured error
* reason alongside the HTTP status code and consult the BigQuery error codes reference. Transient
* asynchronous job failures cannot be recovered by polling the failed job again. Resubmit the work
* as a new job with a new {@link JobId}.
*
* @see <a href="https://docs.cloud.google.com/bigquery/docs/errors">BigQuery API HTTP status and
* error codes</a>
* @see <a href="https://docs.cloud.google.com/bigquery/docs/error-messages">BigQuery client and
Expand Down
Loading