Skip to content

docs: add documentation for Builder class in IdTokenCredentials #1840

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

Open
diegomarquezp wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: add documentation for Builder class in IdTokenCredentials #1840

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a78b5d8
docs: add documentation for Builder class in IdTokenCredentials
diegomarquezp Nov 6, 2025
95d6afb
chore: lint
diegomarquezp Nov 6, 2025
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
1 change: 1 addition & 0 deletions oauth2_http/java/com/google/auth/oauth2/IdTokenCredentials.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,7 @@ public static Builder newBuilder() {
return new Builder();
}

/** Builder of IdTokenCredentials. For usage and examples, see {@link IdTokenCredentials} */
Copy link
Member

@lqiu96 lqiu96 Dec 9, 2025

Choose a reason for hiding this comment

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

Hey sorry, I just noticed this PR. I don't think this change actually address the feedback from the ticket.

We should add javadocs for:

  1. setIdTokenProvider - This cannot be set to null
  2. setTargetAudience - should not be set for userCredentials as targetAudience cannot be set for UserCredentials. For other credentials, this cannot be null.

Additionally, it looks like setOptions can be null, though I think we probably should check for nullness here as well

public static class Builder extends OAuth2Credentials.Builder {

private IdTokenProvider idTokenProvider;
Expand Down