Skip to content

Commit 3fe0ca5

Browse files
committed
docs: update GDCH audience getter javadocs
1 parent 0aa9ab9 commit 3fe0ca5

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

oauth2_http/java/com/google/auth/oauth2/GdchCredentials.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,18 +386,19 @@ public final URI getTokenServerUri() {
386386
/**
387387
* Returns the underlying audience string set for this credentials object.
388388
*
389-
* @return the audience string
389+
* @return the audience string, or null if no audience has been set.
390390
*/
391391
public final String getGdchAudience() {
392392
return apiAudience;
393393
}
394394

395395
/**
396-
* NOTE: This method is obsolete, please use getGdchAudience() instead. Returns a URI
396+
* NOTE: This method is obsolete, please use {@link #getGdchAudience()} instead. Returns a URI
397397
* representation of the underlying audience string set for this credentials object. This method
398398
* may fail if the underlying audience string does not conform to a URI format.
399399
*
400-
* @return a URI object representing the audience of the credentials
400+
* @return a URI object representing the audience of the credentials, or null if no audience has
401+
* been set or if the audience string is not a valid URI.
401402
*/
402403
@ObsoleteApi("Use getGdchAudience() instead.")
403404
public final URI getApiAudience() {

0 commit comments

Comments
 (0)