Send feedback
Class ExternalAccountCredentials.Builder (1.3.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 1.3.0 keyboard_arrow_down
public abstract static class ExternalAccountCredentials . Builder extends GoogleCredentials . Builder
Base builder for external account credentials.
Constructors
Builder()
Builder(ExternalAccountCredentials credentials)
protected Builder ( ExternalAccountCredentials credentials )
Parameter
Fields
audience
protected String audience
Field Value
clientId
protected String clientId
Field Value
clientSecret
protected String clientSecret
Field Value
credentialSource
protected ExternalAccountCredentials . CredentialSource credentialSource
Field Value
Type Description com.google.auth.oauth2.ExternalAccountCredentials.CredentialSource
environmentProvider
protected EnvironmentProvider environmentProvider
Field Value
Type Description com.google.auth.oauth2.EnvironmentProvider
quotaProjectId
protected String quotaProjectId
Field Value
scopes
protected Collection<String> scopes
Field Value
serviceAccountImpersonationUrl
protected String serviceAccountImpersonationUrl
Field Value
subjectTokenType
protected String subjectTokenType
Field Value
tokenInfoUrl
protected String tokenInfoUrl
Field Value
tokenUrl
protected String tokenUrl
Field Value
transportFactory
protected HttpTransportFactory transportFactory
Field Value
workforcePoolUserProject
protected String workforcePoolUserProject
Field Value
Methods
build()
public abstract ExternalAccountCredentials build ()
Returns
Overrides
setAudience(String audience)
public ExternalAccountCredentials . Builder setAudience ( String audience )
Sets the STS audience which is usually the fully specified resource name of the
workload/workforce pool provider.
Parameter
Returns
setClientId(String clientId)
public ExternalAccountCredentials . Builder setClientId ( String clientId )
Sets the optional client ID of the service account from the console.
Parameter
Returns
setClientSecret(String clientSecret)
public ExternalAccountCredentials . Builder setClientSecret ( String clientSecret )
Sets the optional client secret of the service account from the console.
Parameter
Name Description clientSecret String
Returns
setCredentialSource(ExternalAccountCredentials.CredentialSource credentialSource)
public ExternalAccountCredentials . Builder setCredentialSource ( ExternalAccountCredentials . CredentialSource credentialSource )
Sets the external credential source.
Parameter
Name Description credentialSource com.google.auth.oauth2.ExternalAccountCredentials.CredentialSource
Returns
setHttpTransportFactory(HttpTransportFactory transportFactory)
public ExternalAccountCredentials . Builder setHttpTransportFactory ( HttpTransportFactory transportFactory )
Sets the HTTP transport factory, creates the transport used to get access tokens.
Parameter
Returns
setQuotaProjectId(String quotaProjectId)
public ExternalAccountCredentials . Builder setQuotaProjectId ( String quotaProjectId )
Sets the optional project used for quota and billing purposes.
Parameter
Name Description quotaProjectId String
Returns
setScopes(Collection<String> scopes)
public ExternalAccountCredentials . Builder setScopes ( Collection<String> scopes )
Sets the optional scopes to request during the authorization grant.
Parameter
Returns
setServiceAccountImpersonationUrl(String serviceAccountImpersonationUrl)
public ExternalAccountCredentials . Builder setServiceAccountImpersonationUrl ( String serviceAccountImpersonationUrl )
Sets the optional URL used for service account impersonation. This is only required when APIs
to be accessed have not integrated with UberMint. If this is not available, the STS returned
GCP access token is directly used.
Parameter
Name Description serviceAccountImpersonationUrl String
Returns
setSubjectTokenType(String subjectTokenType)
public ExternalAccountCredentials . Builder setSubjectTokenType ( String subjectTokenType )
Sets the STS 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
setTokenInfoUrl(String tokenInfoUrl)
public ExternalAccountCredentials . 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
setTokenUrl(String tokenUrl)
public ExternalAccountCredentials . Builder setTokenUrl ( String tokenUrl )
Sets the STS token exchange endpoint.
Parameter
Returns
setWorkforcePoolUserProject(String workforcePoolUserProject)
public ExternalAccountCredentials . 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
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-11 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-12-11 UTC."],[],[]]
