Package com.google.auth.oauth2

Class ImpersonatedCredentials.Builder

java.lang.Object

com.google.auth.oauth2.OAuth2Credentials.Builder

com.google.auth.oauth2.GoogleCredentials.Builder

com.google.auth.oauth2.ImpersonatedCredentials.Builder

Enclosing class:

ImpersonatedCredentials

public static class ImpersonatedCredentials.Builder
extends GoogleCredentials.Builder

Field Summary

Fields inherited from class com.google.auth.oauth2.GoogleCredentials.Builder

quotaProjectId, universeDomain

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()
protected	Builder(GoogleCredentials sourceCredentials, String targetPrincipal)	Deprecated. Use Builder(ImpersonatedCredentials) instead.
protected	Builder(ImpersonatedCredentials credentials)

Method Summary

Modifier and Type	Method	Description
ImpersonatedCredentials	build()
@Nullable Calendar	getCalendar()	This method is marked obsolete.
@Nullable List<String>	getDelegates()
@Nullable HttpTransportFactory	getHttpTransportFactory()
@Nullable String	getIamEndpointOverride()
int	getLifetime()
@Nullable List<String>	getScopes()
@Nullable GoogleCredentials	getSourceCredentials()
@Nullable String	getTargetPrincipal()
ImpersonatedCredentials.Builder	setCalendar(@Nullable Calendar calendar)	This method is marked obsolete.
ImpersonatedCredentials.Builder	setDelegates(@Nullable List<String> delegates)
ImpersonatedCredentials.Builder	setHttpTransportFactory(@Nullable HttpTransportFactory transportFactory)
ImpersonatedCredentials.Builder	setIamEndpointOverride(@Nullable String iamEndpointOverride)
ImpersonatedCredentials.Builder	setLifetime(int lifetime)
ImpersonatedCredentials.Builder	setQuotaProjectId(@Nullable String quotaProjectId)
ImpersonatedCredentials.Builder	setScopes(List<String> scopes)	Set the scopes to be applied on the impersonated token and not on the source credential.
ImpersonatedCredentials.Builder	setSourceCredentials(GoogleCredentials sourceCredentials)
ImpersonatedCredentials.Builder	setTargetPrincipal(String targetPrincipal)

Methods inherited from class com.google.auth.oauth2.GoogleCredentials.Builder

getQuotaProjectId, getUniverseDomain, setAccessToken, setUniverseDomain

Methods inherited from class com.google.auth.oauth2.OAuth2Credentials.Builder

getAccessToken, getExpirationMargin, getRefreshMargin, setExpirationMargin, setRefreshMargin

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Builder

@Deprecated
protected Builder(GoogleCredentials sourceCredentials,
 String targetPrincipal)

Deprecated.

Use Builder(ImpersonatedCredentials) instead. This constructor will be removed in a future release.

Parameters:

sourceCredentials - The source credentials to use for impersonation.

targetPrincipal - The service account to impersonate.

Builder

protected Builder(ImpersonatedCredentials credentials)

Method Details

setSourceCredentials

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setSourceCredentials(GoogleCredentials sourceCredentials)

getSourceCredentials

public @Nullable GoogleCredentials getSourceCredentials()

setTargetPrincipal

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setTargetPrincipal(String targetPrincipal)

getTargetPrincipal

public @Nullable String getTargetPrincipal()

setDelegates

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setDelegates(@Nullable List<String> delegates)

getDelegates

public @Nullable List<String> getDelegates()

setScopes

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setScopes(List<String> scopes)

Set the scopes to be applied on the impersonated token and not on the source credential. This user configuration has precedence over the scopes listed in the source credential json file.

Parameters:

scopes - List of scopes to apply to the impersonated token

getScopes

public @Nullable List<String> getScopes()

Returns:

List of scopes to be applied to the impersonated token.

setLifetime

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setLifetime(int lifetime)

getLifetime

public int getLifetime()

setHttpTransportFactory

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setHttpTransportFactory(@Nullable HttpTransportFactory transportFactory)

getHttpTransportFactory

public @Nullable HttpTransportFactory getHttpTransportFactory()

setQuotaProjectId

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setQuotaProjectId(@Nullable String quotaProjectId)

Overrides:

setQuotaProjectId in class GoogleCredentials.Builder

setIamEndpointOverride

@CanIgnoreReturnValue
public ImpersonatedCredentials.Builder setIamEndpointOverride(@Nullable String iamEndpointOverride)

getIamEndpointOverride

public @Nullable String getIamEndpointOverride()

setCalendar

@CanIgnoreReturnValue
@ObsoleteApi("This method is obsolete and will be removed in a future release.")
public ImpersonatedCredentials.Builder setCalendar(@Nullable Calendar calendar)

This method is marked obsolete. There is no alternative to setting a custom calendar for the Credential.

Sets the calendar to be used for parsing the expiration time.

Parameters:

calendar - the calendar to use

Returns:

the builder

getCalendar

@ObsoleteApi("This method is obsolete and will be removed in a future release.")
public @Nullable Calendar getCalendar()

This method is marked obsolete. There is no alternative to getting a custom calendar for the Credential.

Returns the calendar to be used for parsing the expiration time.

Returns:

the calendar

build

public ImpersonatedCredentials build()

Overrides:

build in class GoogleCredentials.Builder