Class GoogleCredentials (1.36.0)

publicclass GoogleCredentialsextendsOAuth2CredentialsimplementsQuotaProjectIdProvider

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

Inheritance

Object > Credentials > OAuth2Credentials > GoogleCredentials

Implements

QuotaProjectIdProvider

Inherited Members

publicstaticGoogleCredentialscreate(AccessTokenaccessToken)

Returns the credentials instance from the given access token.

publicstaticGoogleCredentialscreate(StringuniverseDomain,AccessTokenaccessToken)

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

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.

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}.

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.

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}.

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

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

publicstaticGoogleCredentials.BuildernewBuilder()

protectedGoogleCredentials()

Default constructor.

publicGoogleCredentials(AccessTokenaccessToken)

Constructor with explicit access token.

protectedGoogleCredentials(AccessTokenaccessToken,StringquotaProjectId)

Constructor with an explicit access token and quotaProjectId.

Deprecated, please use the GoogleCredentials#GoogleCredentials(Builder) constructor whenever possible.

protectedGoogleCredentials(AccessTokenaccessToken,DurationrefreshMargin,DurationexpirationMargin)

Constructor with explicit access token and refresh margins.

Deprecated, please use the GoogleCredentials#GoogleCredentials(Builder) constructor whenever possible.

protectedGoogleCredentials(GoogleCredentials.Builderbuilder)

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

protectedfinalStringquotaProjectId

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.

publicGoogleCredentialscreateScoped(String[]scopes)

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

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

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.

publicbooleancreateScopedRequired()

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

publicGoogleCredentialscreateWithCustomRetryStrategy(booleandefaultRetriesEnabled)

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

publicGoogleCredentialscreateWithQuotaProject(StringquotaProject)

Creates a credential with the provided quota project.

publicbooleanequals(Objectobj)

OAuth2Credentials.equals(Object obj)

protectedMap<String,List<String>>getAdditionalHeaders()

Provide additional headers to return as request metadata.

OAuth2Credentials.getAdditionalHeaders()

publicStringgetQuotaProjectId()

publicStringgetUniverseDomain()

Gets the universe domain for the credential.

Credentials.getUniverseDomain()

publicinthashCode()

OAuth2Credentials.hashCode()

protectedbooleanisExplicitUniverseDomain()

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.

publicGoogleCredentials.BuildertoBuilder()

OAuth2Credentials.toBuilder()

publicStringtoString()

OAuth2Credentials.toString()

protectedMoreObjects.ToStringHelpertoStringHelper()

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.