Skip to content

doc: Add Javadocs for setters in IdTokenCredentials.Builder #1909

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

Merged
lqiu96 merged 2 commits into from
Mar 26, 2026
+25 −5
Merged

doc: Add Javadocs for setters in IdTokenCredentials.Builder #1909

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a13caf2
chore(oauth2_http): Improve IdTokenCredentials quality and docs
lqiu96 Mar 26, 2026
5d5a3a2
chore: Fix lint issues
lqiu96 Mar 26, 2026
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
30 changes: 25 additions & 5 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 @@ -105,9 +105,9 @@ public class IdTokenCredentials extends OAuth2Credentials {

private static final long serialVersionUID = -2133257318957588431L;

private IdTokenProvider idTokenProvider;
private final IdTokenProvider idTokenProvider;
private final List<IdTokenProvider.Option> options;
private String targetAudience;
private List<IdTokenProvider.Option> options;

private IdTokenCredentials(Builder builder) {
this.idTokenProvider = Preconditions.checkNotNull(builder.getIdTokenProvider());
Expand All @@ -131,7 +131,7 @@ public IdToken getIdToken() {

@Override
public int hashCode() {
return Objects.hash(options, targetAudience);
return Objects.hash(idTokenProvider, options, targetAudience);
}

@Override
Expand All @@ -146,7 +146,8 @@ public boolean equals(Object obj) {
}
IdTokenCredentials other = (IdTokenCredentials) obj;
return Objects.equals(this.idTokenProvider, other.idTokenProvider)
&& Objects.equals(this.targetAudience, other.targetAudience);
&& Objects.equals(this.targetAudience, other.targetAudience)
&& Objects.equals(this.options, other.options);
}

@Override
Expand All @@ -169,16 +170,29 @@ public static class Builder extends OAuth2Credentials.Builder {

protected Builder() {}

/**
* Sets the provider for the ID token.
*
* @param idTokenProvider the provider for the ID token, cannot be null
* @return the builder object
*/
@CanIgnoreReturnValue
public Builder setIdTokenProvider(IdTokenProvider idTokenProvider) {
this.idTokenProvider = idTokenProvider;
this.idTokenProvider = Preconditions.checkNotNull(idTokenProvider);
return this;
}

public IdTokenProvider getIdTokenProvider() {
return this.idTokenProvider;
}

/**
* Sets the target audience for the ID token.
*
* @param targetAudience the target audience, cannot be null for non-UserCredentials. If set for
* UserCredentials, the value will be ignored.
* @return the builder object
*/
@CanIgnoreReturnValue
public Builder setTargetAudience(String targetAudience) {
this.targetAudience = targetAudience;
Expand All @@ -189,6 +203,12 @@ public String getTargetAudience() {
return this.targetAudience;
}

/**
* Sets the options for the ID token.
*
* @param options list of options, can be null or empty if no options are needed.
* @return the builder object
*/
@CanIgnoreReturnValue
public Builder setOptions(List<IdTokenProvider.Option> options) {
this.options = options;
Expand Down
Loading