-
Notifications
You must be signed in to change notification settings - Fork 129
docs(sample): add custom retry algo samples #3948
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.
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
Open
whuffman36
wants to merge
6
commits into
main
Choose a base branch
from
retry-sample
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f21e292
feat(bigquery): implement custom retry algo samples
whuffman36 7cae8c7
change test to IT in file and class names
whuffman36 9a4218a
add imports
whuffman36 317dc35
add assertNotNull import
whuffman36 321026f
replace custom interceptor with BaseService interceptor
whuffman36 c465953
consolidate todo comments into one place
whuffman36 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
67 changes: 67 additions & 0 deletions
67
samples/snippets/src/main/java/com/example/bigquery/SetCustomRetryAlgorithm.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| * Copyright 2025 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.bigquery; | ||
|
|
||
| // [START bigquery_set_custom_retry_algorithm] | ||
| import com.google.api.gax.retrying.ResultRetryAlgorithm; | ||
| import com.google.cloud.ExceptionHandler; | ||
| import com.google.cloud.bigquery.BigQuery; | ||
| import com.google.cloud.bigquery.BigQueryOptions; | ||
| import java.util.concurrent.TimeoutException; | ||
|
|
||
| public class SetCustomRetryAlgorithm { | ||
| // In order to use a custom retry algorithm, you must implement a custom | ||
| // Interceptor that implements the ExceptionHandler.Interceptor interface. | ||
| public static final ExceptionHandler.Interceptor EXCEPTION_HANDLER_INTERCEPTOR = | ||
| new ExceptionHandler.Interceptor() { | ||
| public ExceptionHandler.Interceptor.RetryResult afterEval( | ||
| Exception exception, ExceptionHandler.Interceptor.RetryResult retryResult) { | ||
| return RetryResult.CONTINUE_EVALUATION; | ||
| } | ||
|
|
||
| public ExceptionHandler.Interceptor.RetryResult beforeEval(Exception exception) { | ||
| return RetryResult.CONTINUE_EVALUATION; | ||
| } | ||
| }; | ||
|
|
||
| public static void main(String... args) { | ||
| // TODO(developer): Replace projectId and exception classes before running | ||
whuffman36 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| // the sample. | ||
| String projectId = "project-id"; | ||
| ResultRetryAlgorithm<?> retryAlgorithm = | ||
| ExceptionHandler.newBuilder() | ||
| .abortOn(RuntimeException.class) | ||
| .retryOn(TimeoutException.class) | ||
whuffman36 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| .addInterceptors(EXCEPTION_HANDLER_INTERCEPTOR) | ||
| .build(); | ||
| setCustomRetryAlgorithm(projectId, retryAlgorithm); | ||
| } | ||
|
|
||
| public static void setCustomRetryAlgorithm( | ||
| String projectId, ResultRetryAlgorithm<?> retryAlgorithm) { | ||
| BigQueryOptions options = | ||
| BigQueryOptions.newBuilder() | ||
| .setProjectId(projectId) | ||
| .setResultRetryAlgorithm(retryAlgorithm) | ||
| .build(); | ||
|
|
||
| BigQuery bigquery = options.getService(); | ||
|
|
||
| System.out.println(bigquery.getOptions().getResultRetryAlgorithm()); | ||
| } | ||
| } | ||
| // [END bigquery_set_custom_retry_algorithm] | ||
76 changes: 76 additions & 0 deletions
76
samples/snippets/src/test/java/com/example/bigquery/SetCustomRetryAlgorithmIT.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| /* | ||
| * Copyright 2025 Google LLC | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package com.example.bigquery; | ||
|
|
||
| import static com.google.common.truth.Truth.assertThat; | ||
| import static junit.framework.TestCase.assertNotNull; | ||
|
|
||
| import com.google.api.gax.retrying.ResultRetryAlgorithm; | ||
| import com.google.cloud.ExceptionHandler; | ||
| import java.io.ByteArrayOutputStream; | ||
| import java.io.PrintStream; | ||
| import java.util.concurrent.TimeoutException; | ||
| import java.util.logging.Level; | ||
| import java.util.logging.Logger; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
|
|
||
| public class SetCustomRetryAlgorithmIT { | ||
| private final Logger log = Logger.getLogger(this.getClass().getName()); | ||
| private ByteArrayOutputStream bout; | ||
| private PrintStream out; | ||
| private PrintStream originalPrintStream; | ||
|
|
||
| private static final String PROJECT_ID = requireEnvVar("GOOGLE_CLOUD_PROJECT"); | ||
|
|
||
| private static String requireEnvVar(String varName) { | ||
| String value = System.getenv(varName); | ||
| assertNotNull( | ||
| "Environment variable " + varName + " is required to perform these tests.", | ||
| System.getenv(varName)); | ||
| return value; | ||
| } | ||
|
|
||
| @Before | ||
| public void setUp() throws Exception { | ||
| bout = new ByteArrayOutputStream(); | ||
| out = new PrintStream(bout); | ||
| originalPrintStream = System.out; | ||
| System.setOut(out); | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| System.out.flush(); | ||
| System.setOut(originalPrintStream); | ||
| log.log(Level.INFO, "\n" + bout.toString()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testSetCustomRetryAlgorithm() { | ||
| ResultRetryAlgorithm<?> retryAlgorithm = | ||
| ExceptionHandler.newBuilder() | ||
| .abortOn(RuntimeException.class) | ||
| .retryOn(TimeoutException.class) | ||
| .addInterceptors(SetCustomRetryAlgorithm.EXCEPTION_HANDLER_INTERCEPTOR) | ||
| .build(); | ||
|
|
||
| SetCustomRetryAlgorithm.setCustomRetryAlgorithm(PROJECT_ID, retryAlgorithm); | ||
| assertThat(bout.toString().contains("com.google.cloud.ExceptionHandler")); | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we can simplify this by using the publicly available one at:
https://github.com/googleapis/sdk-platform-java/blob/f18318660c05d0d8466e3ead7127f0747fac2e2e/java-core/google-cloud-core/src/main/java/com/google/cloud/BaseService.java#L30
Just mentions that they can optionally implement their own.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ah didn't know about this one, thanks! I put in a comment explaining how to implement your own.