Class PluggableAuthCredentials.Builder (1.27.0)

Version 1.27.0

• 1.28.0 (latest)
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.1
• 1.20.0
• 1.19.0
• 1.18.0
• 1.7.0
• 1.6.1
• 1.4.0
• 1.3.0

public static class PluggableAuthCredentials.Builder extends ExternalAccountCredentials.Builder

Inheritance

java.lang.Object > OAuth2Credentials.Builder > GoogleCredentials.Builder > ExternalAccountCredentials.Builder > PluggableAuthCredentials.Builder

Inherited Members

ExternalAccountCredentials.Builder.build()

ExternalAccountCredentials.Builder.setAudience(String)

ExternalAccountCredentials.Builder.setClientId(String)

ExternalAccountCredentials.Builder.setClientSecret(String)

ExternalAccountCredentials.Builder.setCredentialSource(ExternalAccountCredentials.CredentialSource)

ExternalAccountCredentials.Builder.setHttpTransportFactory(HttpTransportFactory)

ExternalAccountCredentials.Builder.setQuotaProjectId(String)

ExternalAccountCredentials.Builder.setScopes(Collection<String>)

ExternalAccountCredentials.Builder.setServiceAccountImpersonationOptions(Map<String,Object>)

ExternalAccountCredentials.Builder.setServiceAccountImpersonationUrl(String)

ExternalAccountCredentials.Builder.setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes)

ExternalAccountCredentials.Builder.setSubjectTokenType(String)

ExternalAccountCredentials.Builder.setTokenInfoUrl(String)

ExternalAccountCredentials.Builder.setTokenUrl(String)

ExternalAccountCredentials.Builder.setUniverseDomain(String)

ExternalAccountCredentials.Builder.setWorkforcePoolUserProject(String)

GoogleCredentials.Builder.getQuotaProjectId()

GoogleCredentials.Builder.getUniverseDomain()

GoogleCredentials.Builder.setAccessToken(AccessToken)

OAuth2Credentials.Builder.getAccessToken()

OAuth2Credentials.Builder.getExpirationMargin()

OAuth2Credentials.Builder.getRefreshMargin()

OAuth2Credentials.Builder.setExpirationMargin(Duration)

OAuth2Credentials.Builder.setRefreshMargin(Duration)

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)

Methods

build()

public PluggableAuthCredentials build()

Returns
Type	Description
PluggableAuthCredentials

Overrides

ExternalAccountCredentials.Builder.build()

setAudience(String audience)

public PluggableAuthCredentials.Builder setAudience(String audience)

Sets the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool provider.

Parameter
Name	Description
audience	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setAudience(String audience)

setClientId(String clientId)

public PluggableAuthCredentials.Builder setClientId(String clientId)

Sets the optional client ID of the service account from the console.

Parameter
Name	Description
clientId	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setClientId(String clientId)

setClientSecret(String clientSecret)

public PluggableAuthCredentials.Builder setClientSecret(String clientSecret)

Sets the optional client secret of the service account from the console.

Parameter
Name	Description
clientSecret	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setClientSecret(String clientSecret)

setCredentialSource(PluggableAuthCredentialSource credentialSource)

public PluggableAuthCredentials.Builder setCredentialSource(PluggableAuthCredentialSource credentialSource)

Parameter
Name	Description
credentialSource	PluggableAuthCredentialSource

Returns
Type	Description
PluggableAuthCredentials.Builder

setExecutableHandler(ExecutableHandler handler)

public PluggableAuthCredentials.Builder setExecutableHandler(ExecutableHandler handler)

Parameter
Name	Description
handler	com.google.auth.oauth2.ExecutableHandler

Returns
Type	Description
PluggableAuthCredentials.Builder

setHttpTransportFactory(HttpTransportFactory transportFactory)

public PluggableAuthCredentials.Builder setHttpTransportFactory(HttpTransportFactory transportFactory)

Sets the HTTP transport factory, creates the transport used to get access tokens.

Parameter
Name	Description
transportFactory	HttpTransportFactory

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setHttpTransportFactory(HttpTransportFactory transportFactory)

setQuotaProjectId(String quotaProjectId)

public PluggableAuthCredentials.Builder setQuotaProjectId(String quotaProjectId)

Sets the optional project used for quota and billing purposes.

Parameter
Name	Description
quotaProjectId	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setQuotaProjectId(String quotaProjectId)

setScopes(Collection<String> scopes)

public PluggableAuthCredentials.Builder setScopes(Collection<String> scopes)

Sets the optional scopes to request during the authorization grant.

Parameter
Name	Description
scopes	Collection<String>

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setScopes(Collection<String> scopes)

setServiceAccountImpersonationOptions(Map<String,Object> optionsMap)

public PluggableAuthCredentials.Builder setServiceAccountImpersonationOptions(Map<String,Object> optionsMap)

Sets the optional service account impersonation options.

Parameter
Name	Description
optionsMap	Map<String,Object>

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setServiceAccountImpersonationOptions(Map<String,Object> optionsMap)

setServiceAccountImpersonationUrl(String serviceAccountImpersonationUrl)

public PluggableAuthCredentials.Builder setServiceAccountImpersonationUrl(String serviceAccountImpersonationUrl)

Sets the optional URL used for service account impersonation, which is required for some APIs. If this URL is not available, the access token from the Security Token Service is used directly.

Parameter
Name	Description
serviceAccountImpersonationUrl	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setServiceAccountImpersonationUrl(String serviceAccountImpersonationUrl)

setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes subjectTokenType)

public PluggableAuthCredentials.Builder setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes subjectTokenType)

Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec. Indicates the type of the security token in the credential file.

Parameter
Name	Description
subjectTokenType	ExternalAccountCredentials.SubjectTokenTypes

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes subjectTokenType)

setSubjectTokenType(String subjectTokenType)

public PluggableAuthCredentials.Builder setSubjectTokenType(String subjectTokenType)

Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec. Indicates the type of the security token in the credential file.

Parameter
Name	Description
subjectTokenType	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setSubjectTokenType(String subjectTokenType)

setTokenInfoUrl(String tokenInfoUrl)

public PluggableAuthCredentials.Builder setTokenInfoUrl(String tokenInfoUrl)

Sets the optional endpoint used to retrieve account related information. Required for gCloud session account identification.

Parameter
Name	Description
tokenInfoUrl	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setTokenInfoUrl(String tokenInfoUrl)

setTokenUrl(String tokenUrl)

public PluggableAuthCredentials.Builder setTokenUrl(String tokenUrl)

Sets the Security Token Service token exchange endpoint.

Parameter
Name	Description
tokenUrl	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setTokenUrl(String tokenUrl)

setUniverseDomain(String universeDomain)

public PluggableAuthCredentials.Builder setUniverseDomain(String universeDomain)

Sets the optional universe domain.

Parameter
Name	Description
universeDomain	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setUniverseDomain(String universeDomain)

setWorkforcePoolUserProject(String workforcePoolUserProject)

public PluggableAuthCredentials.Builder setWorkforcePoolUserProject(String workforcePoolUserProject)

Sets the optional workforce pool user project number when the credential corresponds to a workforce pool and not a workload identity pool. The underlying principal must still have serviceusage.services.use IAM permission to use the project for billing/quota.

Parameter
Name	Description
workforcePoolUserProject	String

Returns
Type	Description
PluggableAuthCredentials.Builder

Overrides

ExternalAccountCredentials.Builder.setWorkforcePoolUserProject(String workforcePoolUserProject)