Class GoogleCredentialsProvider.Builder (2.53.0)

Version 2.53.0

• 2.55.0 (latest)
• 2.54.1
• 2.53.0
• 2.52.0
• 2.51.0
• 2.50.0
• 2.49.0
• 2.48.1
• 2.47.0
• 2.46.1
• 2.45.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.39.0
• 2.38.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.1
• 2.33.0
• 2.32.1
• 2.31.1
• 2.30.1
• 2.24.0
• 2.23.3
• 2.22.0
• 2.21.0
• 2.20.1
• 2.19.6
• 2.18.7
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.2
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.1
• 2.7.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

public abstract static class GoogleCredentialsProvider.Builder

Inheritance

java.lang.Object > GoogleCredentialsProvider.Builder

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

public Builder()

Methods

build()

public GoogleCredentialsProvider build()

Returns
Type	Description
GoogleCredentialsProvider

getJwtEnabledScopes()

public abstract List<String> getJwtEnabledScopes()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

The JWT enable scopes previously provided.

Returns
Type	Description
List<String>

getScopesToApply()

public abstract List<String> getScopesToApply()

The scopes previously provided.

Returns
Type	Description
List<String>

getUseJwtAccessWithScope()

public abstract boolean getUseJwtAccessWithScope()

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

The UseJwtAccessWithScope value previously provided.

Returns
Type	Description
boolean

setJwtEnabledScopes(List<String> val)

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

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

Parameter
Name	Description
val	List<String>

Returns
Type	Description
GoogleCredentialsProvider.Builder

setScopesToApply(List<String> val)

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.

Parameter
Name	Description
val	List<String>

Returns
Type	Description
GoogleCredentialsProvider.Builder

setUseJwtAccessWithScope(boolean val)

public abstract GoogleCredentialsProvider.Builder setUseJwtAccessWithScope(boolean val)

Beta

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Parameter
Name	Description
val	boolean

Returns
Type	Description
GoogleCredentialsProvider.Builder