Package com.google.api.gax.core

Class GoogleCredentialsProvider.Builder

java.lang.Object

com.google.api.gax.core.GoogleCredentialsProvider.Builder

Enclosing class:

GoogleCredentialsProvider

@BetaApi
public abstract static class GoogleCredentialsProvider.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GoogleCredentialsProvider	build()
abstract List<String>	getJwtEnabledScopes()	The JWT enable scopes previously provided.
abstract List<String>	getScopesToApply()	The scopes previously provided.
abstract boolean	getUseJwtAccessWithScope()	The UseJwtAccessWithScope value previously provided.
abstract GoogleCredentialsProvider.Builder	setJwtEnabledScopes(List<String> val)	Sets the scopes that are compatible with JWT tokens.
abstract GoogleCredentialsProvider.Builder	setScopesToApply(List<String> val)	Sets the scopes to apply to the credentials that are acquired from Application Default Credentials, before the credentials are sent to the service.
abstract GoogleCredentialsProvider.Builder	setUseJwtAccessWithScope(boolean val)	Whether self signed JWT with scopes should be used for service account credentials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

setScopesToApply

public abstract GoogleCredentialsProvider.Builder setScopesToApply(List<String> val)

Sets the scopes to apply to the credentials that are acquired from Application Default Credentials, before the credentials are sent to the service.

getScopesToApply

public abstract List<String> getScopesToApply()

The scopes previously provided.

setJwtEnabledScopes

@BetaApi
public abstract GoogleCredentialsProvider.Builder setJwtEnabledScopes(List<String> val)

Sets the scopes that are compatible with JWT tokens.

JWT Tokens don't support scopes, they only support audiences. Audiences allow access to the entire service as opposed some subset (ie. access can't be restricted to use the scope https://www.googleapis.com/auth/bigtable.data.readonly). A service client can opt-in to using JWT tokens by specifying which scopes encompass the entire service. If any of those scopes are present when the client is using ServiceAccountCredentials, then JWT tokens will be used for authentication.

getJwtEnabledScopes

@BetaApi
public abstract List<String> getJwtEnabledScopes()

The JWT enable scopes previously provided.

setUseJwtAccessWithScope

@BetaApi
public abstract GoogleCredentialsProvider.Builder setUseJwtAccessWithScope(boolean val)

Whether self signed JWT with scopes should be used for service account credentials.

getUseJwtAccessWithScope

@BetaApi
public abstract boolean getUseJwtAccessWithScope()

The UseJwtAccessWithScope value previously provided.

build

public GoogleCredentialsProvider build()