Class IdTokenCredentials.Builder (1.54.0)

1.54.0 (latest) 1.50.0 1.49.0 1.48.0 1.46.0 1.43.0 1.42.1 1.41.0 1.40.0 1.39.1 1.38.0 1.37.1 1.36.0 1.35.0 1.34.0 1.33.1 1.32.1 1.31.0 1.30.1 1.29.1-SNAPSHOT 1.28.0 1.27.0 1.26.0 1.25.0 1.24.1 1.20.0 1.19.0 1.18.0 1.7.0 1.6.1 1.4.0 1.3.0

public static class IdTokenCredentials.Builder extends OAuth2Credentials.Builder

Inheritance

java.lang.Object > OAuth2Credentials.Builder > IdTokenCredentials.Builder

Inherited Members

OAuth2Credentials.Builder.build()

OAuth2Credentials.Builder.getAccessToken()

OAuth2Credentials.Builder.getExpirationMargin()

OAuth2Credentials.Builder.getRefreshMargin()

OAuth2Credentials.Builder.setAccessToken(@Nullable AccessToken)

OAuth2Credentials.Builder.setExpirationMargin(Duration)

OAuth2Credentials.Builder.setRefreshMargin(Duration)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

protected Builder()

Methods

build()

public IdTokenCredentials build()

Returns
Type	Description
IdTokenCredentials

Overrides

OAuth2Credentials.Builder.build()

getIdTokenProvider()

public @Nullable IdTokenProvider getIdTokenProvider()

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.auth.oauth2.IdTokenProvider

getOptions()

public @Nullable List<IdTokenProvider.Option> getOptions()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.util.List<Option>

getTargetAudience()

public @Nullable String getTargetAudience()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

setIdTokenProvider(IdTokenProvider idTokenProvider)

public IdTokenCredentials.Builder setIdTokenProvider(IdTokenProvider idTokenProvider)

Sets the provider for the ID token.

Parameter
Name	Description
idTokenProvider	IdTokenProvider the provider for the ID token, cannot be null

Returns
Type	Description
IdTokenCredentials.Builder	the builder object

setOptions(@Nullable List<IdTokenProvider.Option> options)

public IdTokenCredentials.Builder setOptions(@Nullable List<IdTokenProvider.Option> options)

Sets the options for the ID token.

Parameter
Name	Description
options	@org.jspecify.annotations.Nullable java.util.List<Option> list of options, can be null or empty if no options are needed.

Returns
Type	Description
IdTokenCredentials.Builder	the builder object

setTargetAudience(@Nullable String targetAudience)

public IdTokenCredentials.Builder setTargetAudience(@Nullable String targetAudience)

Sets the target audience for the ID token.

Parameter
Name	Description
targetAudience	@org.jspecify.annotations.Nullable java.lang.String the target audience, cannot be null for non-UserCredentials. If set for UserCredentials, the value will be ignored.

Returns
Type	Description
IdTokenCredentials.Builder	the builder object