Class GoogleCredentials (1.6.1) 

publicclass GoogleCredentialsextendsOAuth2Credentials

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

Inheritance

java.lang.Object > Credentials > OAuth2Credentials > GoogleCredentials

Inherited Members

Static Methods

create(AccessToken accessToken)

publicstaticGoogleCredentialscreate(AccessTokenaccessToken)

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)

publicstaticGoogleCredentialsfromStream(InputStreamcredentialsStream)

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)

publicstaticGoogleCredentialsfromStream(InputStreamcredentialsStream,HttpTransportFactorytransportFactory)

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()

publicstaticGoogleCredentialsgetApplicationDefault()

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:

  1. Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
  2. 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.
  3. Google App Engine built-in credentials
  4. Google Cloud Shell built-in credentials
  5. 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)

publicstaticGoogleCredentialsgetApplicationDefault(HttpTransportFactorytransportFactory)

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:

  1. Credentials file pointed to by the GOOGLE_APPLICATION_CREDENTIALS environment variable
  2. Credentials provided by the Google Cloud SDK gcloud auth application-default login command
  3. Google App Engine built-in credentials
  4. Google Cloud Shell built-in credentials
  5. 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()

publicstaticGoogleCredentials.BuildernewBuilder()
Returns
Type Description
GoogleCredentials.Builder

Constructors

GoogleCredentials()

protectedGoogleCredentials()

Default constructor.

GoogleCredentials(AccessToken accessToken)

publicGoogleCredentials(AccessTokenaccessToken)

Constructor with explicit access token.

Parameter
Name Description
accessToken AccessToken

initial or temporary access token

GoogleCredentials(AccessToken accessToken, Duration refreshMargin, Duration expirationMargin)

protectedGoogleCredentials(AccessTokenaccessToken,DurationrefreshMargin,DurationexpirationMargin)

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)

publicGoogleCredentialscreateDelegated(Stringuser)

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)

publicGoogleCredentialscreateScoped(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)

publicGoogleCredentialscreateScoped(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)

publicGoogleCredentialscreateScoped(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()

publicbooleancreateScopedRequired()

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)

publicGoogleCredentialscreateWithCustomRetryStrategy(booleandefaultRetriesEnabled)

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()

publicGoogleCredentials.BuildertoBuilder()
Returns
Type Description
GoogleCredentials.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.