Class IdentityPoolCredentials (1.28.0)

public class IdentityPoolCredentials extends ExternalAccountCredentials

Url-sourced, file-sourced, or user provided supplier method-sourced external account credentials.

By default, attempts to exchange the external credential for a GCP access token.

Inheritance

java.lang.Object > Credentials > OAuth2Credentials > GoogleCredentials > ExternalAccountCredentials > IdentityPoolCredentials

Inherited Members

Credentials.blockingGetToCallback(URI,RequestMetadataCallback)

Credentials.getMetricsCredentialType()

Credentials.getRequestMetadata()

ExternalAccountCredentials.exchangeExternalCredentialForAccessToken(StsTokenExchangeRequest)

ExternalAccountCredentials.fromStream(InputStream)

ExternalAccountCredentials.fromStream(InputStream,HttpTransportFactory)

ExternalAccountCredentials.getAudience()

ExternalAccountCredentials.getClientId()

ExternalAccountCredentials.getClientSecret()

ExternalAccountCredentials.getCredentialSource()

ExternalAccountCredentials.getRequestMetadata(URI)

ExternalAccountCredentials.getRequestMetadata(URI,Executor,RequestMetadataCallback)

ExternalAccountCredentials.getScopes()

ExternalAccountCredentials.getServiceAccountEmail()

ExternalAccountCredentials.getServiceAccountImpersonationOptions()

ExternalAccountCredentials.getServiceAccountImpersonationUrl()

ExternalAccountCredentials.getSubjectTokenType()

ExternalAccountCredentials.getTokenInfoUrl()

ExternalAccountCredentials.getTokenUrl()

ExternalAccountCredentials.getUniverseDomain()

ExternalAccountCredentials.getWorkforcePoolUserProject()

ExternalAccountCredentials.isWorkforcePoolConfiguration()

ExternalAccountCredentials.retrieveSubjectToken()

GoogleCredentials.create(AccessToken)

GoogleCredentials.create(String,AccessToken)

GoogleCredentials.createDelegated(String)

GoogleCredentials.createScoped(String)

GoogleCredentials.createScoped(Collection<String>)

GoogleCredentials.createScoped(Collection<String>,Collection<String>)

GoogleCredentials.createScopedRequired()

GoogleCredentials.createWithCustomRetryStrategy(boolean)

GoogleCredentials.createWithQuotaProject(String)

GoogleCredentials.equals(Object)

GoogleCredentials.getAdditionalHeaders()

GoogleCredentials.getApplicationDefault()

GoogleCredentials.getApplicationDefault(HttpTransportFactory)

GoogleCredentials.getQuotaProjectId()

GoogleCredentials.hashCode()

GoogleCredentials.isExplicitUniverseDomain()

GoogleCredentials.newBuilder()

GoogleCredentials.toBuilder()

GoogleCredentials.toString()

GoogleCredentials.toStringHelper()

OAuth2Credentials.<T>getFromServiceLoader(Class<? extends T>,T)

OAuth2Credentials.<T>newInstance(String)

OAuth2Credentials.addChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.getAccessToken()

OAuth2Credentials.getAuthenticationType()

OAuth2Credentials.getRequestMetadataInternal()

OAuth2Credentials.hasRequestMetadata()

OAuth2Credentials.hasRequestMetadataOnly()

OAuth2Credentials.refresh()

OAuth2Credentials.refreshAccessToken()

OAuth2Credentials.refreshIfExpired()

OAuth2Credentials.removeChangeListener(OAuth2Credentials.CredentialsChangedListener)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

newBuilder()

public static IdentityPoolCredentials.Builder newBuilder()

Returns
Type	Description
`IdentityPoolCredentials.Builder`

newBuilder(IdentityPoolCredentials identityPoolCredentials)

public static IdentityPoolCredentials.Builder newBuilder(IdentityPoolCredentials identityPoolCredentials)

Parameter
Name	Description
`identityPoolCredentials`	`IdentityPoolCredentials`

Returns
Type	Description
`IdentityPoolCredentials.Builder`

Methods

createScoped(Collection<String> newScopes)

public IdentityPoolCredentials createScoped(Collection<String> newScopes)

Clones the IdentityPoolCredentials with the specified scopes.

Parameter
Name	Description
`newScopes`	`Collection<String>`

Returns
Type	Description
`IdentityPoolCredentials`

Overrides

GoogleCredentials.createScoped(Collection<String> scopes)

refreshAccessToken()

public AccessToken refreshAccessToken()

Method to refresh the access token according to the specific type of credentials.

Throws IllegalStateException if not overridden since direct use of OAuth2Credentials is only for temporary or non-refreshing access tokens.

Returns
Type	Description
`AccessToken`

Overrides

OAuth2Credentials.refreshAccessToken()

Exceptions
Type	Description
`IOException`

retrieveSubjectToken()

public String retrieveSubjectToken()

Retrieves the external subject token to be exchanged for a Google Cloud access token.

Must be implemented by subclasses as the retrieval method is dependent on the credential source.

Returns
Type	Description
`String`

Overrides

ExternalAccountCredentials.retrieveSubjectToken()

Exceptions
Type	Description
`IOException`