Class GoogleCredentials (1.35.0) (original) (raw)

public class GoogleCredentials extends OAuth2Credentials implements QuotaProjectIdProvider

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

Inherited Members

Static Methods

create(AccessToken accessToken)

public static GoogleCredentials create(AccessToken accessToken)

Returns the credentials instance from the given access token.

create(String universeDomain, AccessToken accessToken)

public static GoogleCredentials create(String universeDomain, AccessToken accessToken)

Returns the credentials instance from the given access token and universe domain.

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.

Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to {@link documentation}.

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.

Important: If you accept a credential configuration (credential JSON/File/Stream) from an external source for authentication to Google Cloud Platform, you must validate it before providing it to any Google API or library. Providing an unvalidated credential configuration to Google APIs can compromise the security of your systems and data. For more information, refer to {@link documentation}.

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:

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

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:

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

newBuilder()

public static GoogleCredentials.Builder newBuilder()

Constructors

GoogleCredentials()

protected GoogleCredentials()

Default constructor.

GoogleCredentials(AccessToken accessToken)

public GoogleCredentials(AccessToken accessToken)

Constructor with explicit access token.

GoogleCredentials(AccessToken accessToken, String quotaProjectId)

protected GoogleCredentials(AccessToken accessToken, String quotaProjectId)

GoogleCredentials(AccessToken accessToken, Duration refreshMargin, Duration expirationMargin)

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

GoogleCredentials(GoogleCredentials.Builder builder)

protected GoogleCredentials(GoogleCredentials.Builder builder)

Constructor that relies on a Builder to provide all the necessary field values for initialization.

Fields

quotaProjectId

protected final String quotaProjectId

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.

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.

createScoped(Collection scopes)

public GoogleCredentials createScoped(Collection<String> scopes)

If the credentials support scopes, creates a copy of the identity with the specified scopes, invalidates the existing scoped access token; otherwise, return the same instance.

createScoped(Collection scopes, Collection 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.

createScopedRequired()

public boolean createScopedRequired()

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

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

createWithQuotaProject(String quotaProject)

public GoogleCredentials createWithQuotaProject(String quotaProject)

Creates a credential with the provided quota project.

equals(Object obj)

public boolean equals(Object obj)

Overrides

protected Map<String,List<String>> getAdditionalHeaders()

Provide additional headers to return as request metadata.

Overrides

getQuotaProjectId()

public String getQuotaProjectId()

getUniverseDomain()

public String getUniverseDomain()

Gets the universe domain for the credential.

Overrides

hashCode()

Overrides

isExplicitUniverseDomain()

protected boolean isExplicitUniverseDomain()

Gets the flag indicating whether universeDomain was explicitly set by the developer.

If subclass has a requirement to give priority to developer-set universeDomain, this property must be used to check if the universeDomain value was provided by the user. It could be a default otherwise.

toBuilder()

public GoogleCredentials.Builder toBuilder()

Overrides

toString()

Overrides

toStringHelper()

protected MoreObjects.ToStringHelper toStringHelper()

A helper for overriding the toString() method. This allows inheritance of super class fields. Extending classes can override this implementation and call super implementation and add more fields. Same cannot be done with overriding the toString() directly.