Package com.google.auth.oauth2
Class AwsCredentials.Builder
java.lang.Object
com.google.auth.oauth2.OAuth2Credentials.Builder
com.google.auth.oauth2.GoogleCredentials.Builder
com.google.auth.oauth2.ExternalAccountCredentials.Builder
com.google.auth.oauth2.AwsCredentials.Builder
- Enclosing class:
AwsCredentials
-
Field Summary
FieldsFields inherited from class com.google.auth.oauth2.ExternalAccountCredentials.Builder
audience, clientId, clientSecret, credentialSource, environmentProvider, metricsHandler, scopes, serviceAccountImpersonationOptions, serviceAccountImpersonationUrl, subjectTokenType, tokenInfoUrl, tokenUrl, transportFactory, universeDomain, workforcePoolUserProject
Fields inherited from class com.google.auth.oauth2.GoogleCredentials.Builder
quotaProjectId
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
setAudience
(String audience) Sets the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool provider.setAwsSecurityCredentialsSupplier
(AwsSecurityCredentialsSupplier awsSecurityCredentialsSupplier) Sets the AWS security credentials supplier.setClientId
(String clientId) Sets the optional client ID of the service account from the console.setClientSecret
(String clientSecret) Sets the optional client secret of the service account from the console.setCredentialSource
(AwsCredentialSource credentialSource) (package private) AwsCredentials.Builder
setEnvironmentProvider
(EnvironmentProvider environmentProvider) Sets the optional Environment Provider.setHttpTransportFactory
(HttpTransportFactory transportFactory) Sets the HTTP transport factory, creates the transport used to get access tokens.setQuotaProjectId
(String quotaProjectId) Sets the optional project used for quota and billing purposes.setRegionalCredentialVerificationUrlOverride
(String regionalCredentialVerificationUrlOverride) Sets the AWS regional credential verification URL.setScopes
(Collection<String> scopes) Sets the optional scopes to request during the authorization grant.setServiceAccountImpersonationOptions
(Map<String, Object> optionsMap) Sets the optional service account impersonation options.setServiceAccountImpersonationUrl
(String serviceAccountImpersonationUrl) Sets the optional URL used for service account impersonation, which is required for some APIs.setSubjectTokenType
(ExternalAccountCredentials.SubjectTokenTypes subjectTokenType) Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec.setSubjectTokenType
(String subjectTokenType) Sets the Security Token Service subject token type based on the OAuth 2.0 token exchange spec.setTokenInfoUrl
(String tokenInfoUrl) Sets the optional endpoint used to retrieve account related information.setTokenUrl
(String tokenUrl) Sets the Security Token Service token exchange endpoint.setUniverseDomain
(String universeDomain) Sets the optional universe domain.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.Methods inherited from class com.google.auth.oauth2.ExternalAccountCredentials.Builder
setCredentialSource
Methods inherited from class com.google.auth.oauth2.GoogleCredentials.Builder
getQuotaProjectId, getUniverseDomain, setAccessToken
Methods inherited from class com.google.auth.oauth2.OAuth2Credentials.Builder
getAccessToken, getExpirationMargin, getRefreshMargin, setExpirationMargin, setRefreshMargin
-
Field Details
-
awsSecurityCredentialsSupplier
-
regionalCredentialVerificationUrlOverride
-
-
Constructor Details
-
Builder
Builder() -
Builder
Builder(AwsCredentials credentials)
-
-
Method Details
-
setAwsSecurityCredentialsSupplier
@CanIgnoreReturnValue public AwsCredentials.Builder setAwsSecurityCredentialsSupplier(AwsSecurityCredentialsSupplier awsSecurityCredentialsSupplier) Sets the AWS security credentials supplier. The supplier should return a validAwsSecurityCredentials
object and a valid AWS region.- Parameters:
awsSecurityCredentialsSupplier
- the supplier to use.- Returns:
- this
Builder
object
-
setRegionalCredentialVerificationUrlOverride
@CanIgnoreReturnValue public AwsCredentials.Builder setRegionalCredentialVerificationUrlOverride(String regionalCredentialVerificationUrlOverride) Sets the AWS regional credential verification URL. If set, will override any credential verification URL provided in the credential source. If not set, the credential verification URL will default toinvalid input: '<'a href=https://sts.{region}.amazonaws.com?Action=GetCallerIdentityinvalid input: '&Version'=2011-06-15>
- Parameters:
regionalCredentialVerificationUrlOverride
- the AWS credential verification url to set.- Returns:
- this
Builder
object
-
setHttpTransportFactory
@CanIgnoreReturnValue public AwsCredentials.Builder setHttpTransportFactory(HttpTransportFactory transportFactory) Description copied from class:ExternalAccountCredentials.Builder
Sets the HTTP transport factory, creates the transport used to get access tokens.- Overrides:
setHttpTransportFactory
in classExternalAccountCredentials.Builder
- Parameters:
transportFactory
- theHttpTransportFactory
to set- Returns:
- this
Builder
object
-
setAudience
Description copied from class:ExternalAccountCredentials.Builder
Sets the Security Token Service audience, which is usually the fully specified resource name of the workload/workforce pool provider.- Overrides:
setAudience
in classExternalAccountCredentials.Builder
- Parameters:
audience
- the Security Token Service audience to set- Returns:
- this
Builder
object
-
setSubjectTokenType
Description copied from class:ExternalAccountCredentials.Builder
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.- Overrides:
setSubjectTokenType
in classExternalAccountCredentials.Builder
- Parameters:
subjectTokenType
- the Security Token Service subject token type to set- Returns:
- this
Builder
object
-
setSubjectTokenType
@CanIgnoreReturnValue public AwsCredentials.Builder setSubjectTokenType(ExternalAccountCredentials.SubjectTokenTypes subjectTokenType) Description copied from class:ExternalAccountCredentials.Builder
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.- Overrides:
setSubjectTokenType
in classExternalAccountCredentials.Builder
- Parameters:
subjectTokenType
- theSubjectTokenType
to set- Returns:
- this
Builder
object
-
setTokenUrl
Description copied from class:ExternalAccountCredentials.Builder
Sets the Security Token Service token exchange endpoint.- Overrides:
setTokenUrl
in classExternalAccountCredentials.Builder
- Parameters:
tokenUrl
- the Security Token Service token exchange url to set- Returns:
- this
Builder
object
-
setCredentialSource
@CanIgnoreReturnValue public AwsCredentials.Builder setCredentialSource(AwsCredentialSource credentialSource) -
setServiceAccountImpersonationUrl
@CanIgnoreReturnValue public AwsCredentials.Builder setServiceAccountImpersonationUrl(String serviceAccountImpersonationUrl) Description copied from class:ExternalAccountCredentials.Builder
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.- Overrides:
setServiceAccountImpersonationUrl
in classExternalAccountCredentials.Builder
- Parameters:
serviceAccountImpersonationUrl
- the service account impersonation url to set- Returns:
- this
Builder
object
-
setTokenInfoUrl
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional endpoint used to retrieve account related information. Required for gCloud session account identification.- Overrides:
setTokenInfoUrl
in classExternalAccountCredentials.Builder
- Parameters:
tokenInfoUrl
- the token info url to set- Returns:
- this
Builder
object
-
setQuotaProjectId
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional project used for quota and billing purposes.- Overrides:
setQuotaProjectId
in classExternalAccountCredentials.Builder
- Parameters:
quotaProjectId
- the quota and billing project id to set- Returns:
- this
Builder
object
-
setClientId
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional client ID of the service account from the console.- Overrides:
setClientId
in classExternalAccountCredentials.Builder
- Parameters:
clientId
- the service account client id to set- Returns:
- this
Builder
object
-
setClientSecret
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional client secret of the service account from the console.- Overrides:
setClientSecret
in classExternalAccountCredentials.Builder
- Parameters:
clientSecret
- the service account client secret to set- Returns:
- this
Builder
object
-
setScopes
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional scopes to request during the authorization grant.- Overrides:
setScopes
in classExternalAccountCredentials.Builder
- Parameters:
scopes
- the request scopes to set- Returns:
- this
Builder
object
-
setWorkforcePoolUserProject
@CanIgnoreReturnValue public AwsCredentials.Builder setWorkforcePoolUserProject(String workforcePoolUserProject) Description copied from class:ExternalAccountCredentials.Builder
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.- Overrides:
setWorkforcePoolUserProject
in classExternalAccountCredentials.Builder
- Parameters:
workforcePoolUserProject
- the workforce pool user project number to set- Returns:
- this
Builder
object
-
setServiceAccountImpersonationOptions
@CanIgnoreReturnValue public AwsCredentials.Builder setServiceAccountImpersonationOptions(Map<String, Object> optionsMap) Description copied from class:ExternalAccountCredentials.Builder
Sets the optional service account impersonation options.- Overrides:
setServiceAccountImpersonationOptions
in classExternalAccountCredentials.Builder
- Parameters:
optionsMap
- the service account impersonation options to set- Returns:
- this
Builder
object
-
setUniverseDomain
Description copied from class:ExternalAccountCredentials.Builder
Sets the optional universe domain.- Overrides:
setUniverseDomain
in classExternalAccountCredentials.Builder
- Parameters:
universeDomain
- the universe domain to set- Returns:
- this
Builder
object
-
setEnvironmentProvider
@CanIgnoreReturnValue AwsCredentials.Builder setEnvironmentProvider(EnvironmentProvider environmentProvider) Description copied from class:ExternalAccountCredentials.Builder
Sets the optional Environment Provider.- Overrides:
setEnvironmentProvider
in classExternalAccountCredentials.Builder
- Parameters:
environmentProvider
- theEnvironmentProvider
to set- Returns:
- this
Builder
object
-
build
- Specified by:
build
in classExternalAccountCredentials.Builder
-