Class GoogleCredentials (1.6.0)

public class GoogleCredentials extends OAuth2Credentials

Base type for credentials for authorizing calls to Google APIs using OAuth2.

Inheritance

java.lang.Object > Credentials > OAuth2Credentials > GoogleCredentials

Inherited Members

Credentials.blockingGetToCallback(URI,RequestMetadataCallback)

Credentials.getRequestMetadata()

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

OAuth2Credentials.<T>newInstance(String)

OAuth2Credentials.addChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.create(AccessToken)

OAuth2Credentials.equals(Object)

OAuth2Credentials.getAccessToken()

OAuth2Credentials.getAdditionalHeaders()

OAuth2Credentials.getAuthenticationType()

OAuth2Credentials.getRequestMetadata(URI)

OAuth2Credentials.getRequestMetadata(URI,Executor,RequestMetadataCallback)

OAuth2Credentials.getRequestMetadataInternal()

OAuth2Credentials.hasRequestMetadata()

OAuth2Credentials.hasRequestMetadataOnly()

OAuth2Credentials.hashCode()

OAuth2Credentials.newBuilder()

OAuth2Credentials.refresh()

OAuth2Credentials.refreshAccessToken()

OAuth2Credentials.refreshIfExpired()

OAuth2Credentials.removeChangeListener(OAuth2Credentials.CredentialsChangedListener)

OAuth2Credentials.toBuilder()

OAuth2Credentials.toString()

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(AccessToken accessToken)

public static GoogleCredentials create(AccessToken accessToken)

Returns the credentials instance from the given access token.

Parameter

Name	Description
accessToken	`AccessToken` the access token

Returns

Type	Description
GoogleCredentials	the credentials instance

fromStream(InputStream credentialsStream)

public static GoogleCredentials fromStream(InputStream credentialsStream)

Returns credentials defined by a JSON file stream.

The stream can contain a Service Account key file in JSON format from the Google Developers Console or a stored user credential using the format supported by the Cloud SDK.

Parameter

Name	Description
credentialsStream	`InputStream` the stream with the credential definition.

Returns

Type	Description
GoogleCredentials	the credential defined by the credentialsStream.

Exceptions

Type	Description
IOException	if the credential cannot be created from the stream.

fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory)

public static GoogleCredentials fromStream(InputStream credentialsStream, HttpTransportFactory transportFactory)

Returns credentials defined by a JSON file stream.

The stream can contain a Service Account key file in JSON format from the Google Developers Console or a stored user credential using the format supported by the Cloud SDK.

Parameters

Name	Description
credentialsStream	`InputStream` the stream with the credential definition.
transportFactory	`HttpTransportFactory` HTTP transport factory, creates the transport used to get access tokens.

Returns

Type	Description
GoogleCredentials	the credential defined by the credentialsStream.

Exceptions

Type	Description
IOException	if the credential cannot be created from the stream.

getApplicationDefault()

public static GoogleCredentials getApplicationDefault()

Returns the Application Default Credentials.

Returns the Application Default Credentials which are used to identify and authorize the whole application. The following are searched (in order) to find the Application Default Credentials:

Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
Credentials provided by the Google Cloud SDK.
1. gcloud auth application-default login for user account credentials.
2. gcloud auth application-default login --impersonate-service-account for impersonated service account credentials.

Google App Engine built-in credentials

Google Cloud Shell built-in credentials

Google Compute Engine built-in credentials

Returns

Type	Description
GoogleCredentials	the credentials instance.

Exceptions

Type	Description
IOException	if the credentials cannot be created in the current environment.

getApplicationDefault(HttpTransportFactory transportFactory)

public static GoogleCredentials getApplicationDefault(HttpTransportFactory transportFactory)

Returns the Application Default Credentials.

Returns the Application Default Credentials which are used to identify and authorize the whole application. The following are searched (in order) to find the Application Default Credentials:

Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
Credentials provided by the Google Cloud SDK gcloud auth application-default login command
Google App Engine built-in credentials
Google Cloud Shell built-in credentials
Google Compute Engine built-in credentials

Parameter

Name	Description
transportFactory	`HttpTransportFactory` HTTP transport factory, creates the transport used to get access tokens.

Returns

Type	Description
GoogleCredentials	the credentials instance.

Exceptions

Type	Description
IOException	if the credentials cannot be created in the current environment.

newBuilder()

public static GoogleCredentials.Builder newBuilder()

Returns

Type	Description
GoogleCredentials.Builder

Constructors

GoogleCredentials()

protected GoogleCredentials()

Default constructor.

GoogleCredentials(AccessToken accessToken)

public GoogleCredentials(AccessToken accessToken)

Constructor with explicit access token.

Parameter

Name	Description
accessToken	`AccessToken` initial or temporary access token

GoogleCredentials(AccessToken accessToken, Duration refreshMargin, Duration expirationMargin)

protected GoogleCredentials(AccessToken accessToken, Duration refreshMargin, Duration expirationMargin)

Constructor with explicit access token and refresh times

Parameters

Name	Description
accessToken	`AccessToken` initial or temporary access token
refreshMargin	`Duration`
expirationMargin	`Duration`

Methods

createDelegated(String user)

public GoogleCredentials createDelegated(String user)

If the credentials support domain-wide delegation, creates a copy of the identity so that it impersonates the specified user; otherwise, returns the same instance.

Parameter

Name	Description
user	`String` User to impersonate.

Returns

Type	Description
GoogleCredentials	GoogleCredentials with a delegated user.

createScoped(String[] scopes)

public GoogleCredentials createScoped(String[] scopes)

If the credentials support scopes, creates a copy of the identity with the specified scopes; otherwise, returns the same instance.

Parameter

Name	Description
scopes	`String[]` Collection of scopes to request.

Returns

Type	Description
GoogleCredentials	GoogleCredentials with requested scopes.

createScoped(Collection<String> scopes)

public GoogleCredentials createScoped(Collection<String> scopes)

If the credentials support scopes, creates a copy of the identity with the specified scopes; otherwise, returns the same instance.

Parameter

Name	Description
scopes	`Collection<String>` Collection of scopes to request.

Returns

Type	Description
GoogleCredentials	GoogleCredentials with requested scopes.

createScoped(Collection<String> scopes, Collection<String> defaultScopes)

public GoogleCredentials createScoped(Collection<String> scopes, Collection<String> defaultScopes)

If the credentials support scopes, creates a copy of the identity with the specified scopes and default scopes; otherwise, returns the same instance. This is mainly used by client libraries.

Parameters

Name	Description
scopes	`Collection<String>` Collection of scopes to request.
defaultScopes	`Collection<String>` Collection of default scopes to request.

Returns

Type	Description
GoogleCredentials	GoogleCredentials with requested scopes.

createScopedRequired()

public boolean createScopedRequired()

Indicates whether the credentials require scopes to be specified via a call to GoogleCredentials#createScoped before use.

Returns

Type	Description
boolean	Whether the credentials require scopes to be specified.

createWithCustomRetryStrategy(boolean defaultRetriesEnabled)

public GoogleCredentials createWithCustomRetryStrategy(boolean defaultRetriesEnabled)

If the credentials support automatic retries, creates a copy of the identity with the provided retry strategy

Parameter

Name	Description
defaultRetriesEnabled	`boolean` a flag enabling or disabling default retries

Returns

Type	Description
GoogleCredentials	GoogleCredentials with the new default retries configuration.

toBuilder()

public GoogleCredentials.Builder toBuilder()

Returns

Type	Description
GoogleCredentials.Builder

Overrides

OAuth2Credentials.toBuilder()