Class ServiceAccountCredentials.Builder (1.54.0)

1.54.0 (latest) 1.50.0 1.49.0 1.48.0 1.46.0 1.43.0 1.42.1 1.41.0 1.40.0 1.39.1 1.38.0 1.37.1 1.36.0 1.35.0 1.34.0 1.33.1 1.32.1 1.31.0 1.30.1 1.29.1-SNAPSHOT 1.28.0 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 ServiceAccountCredentials.Builder extends GoogleCredentials.Builder

Inheritance

java.lang.Object > OAuth2Credentials.Builder > GoogleCredentials.Builder > ServiceAccountCredentials.Builder

Inherited Members

GoogleCredentials.Builder.build()

GoogleCredentials.Builder.getQuotaProjectId()

GoogleCredentials.Builder.getUniverseDomain()

GoogleCredentials.Builder.setAccessToken(@Nullable AccessToken)

GoogleCredentials.Builder.setQuotaProjectId(@Nullable String)

GoogleCredentials.Builder.setUniverseDomain(String)

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)

Constructors

Builder()

protected Builder()

Builder(ServiceAccountCredentials credentials)

protected Builder(ServiceAccountCredentials credentials)

Parameter
Name	Description
credentials	ServiceAccountCredentials

Methods

build()

public ServiceAccountCredentials build()

Returns
Type	Description
ServiceAccountCredentials

Overrides

GoogleCredentials.Builder.build()

getClientEmail()

public @Nullable String getClientEmail()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getClientId()

public @Nullable String getClientId()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getDefaultScopes()

public @Nullable Collection<String> getDefaultScopes()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.util.Collection<String>

getHttpTransportFactory()

public @Nullable HttpTransportFactory getHttpTransportFactory()

Returns
Type	Description
@org.jspecify.annotations.Nullable com.google.auth.http.HttpTransportFactory

getLifetime()

public int getLifetime()

Returns
Type	Description
int

getPrivateKey()

public @Nullable PrivateKey getPrivateKey()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.security.PrivateKey

getPrivateKeyId()

public @Nullable String getPrivateKeyId()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getProjectId()

public @Nullable String getProjectId()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getScopes()

public @Nullable Collection<String> getScopes()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.util.Collection<String>

getServiceAccountUser()

public @Nullable String getServiceAccountUser()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.lang.String

getTokenServerUri()

public @Nullable URI getTokenServerUri()

Returns
Type	Description
@org.jspecify.annotations.Nullable java.net.URI

getUseJwtAccessWithScope()

public boolean getUseJwtAccessWithScope()

Returns
Type	Description
boolean

isDefaultRetriesEnabled()

public boolean isDefaultRetriesEnabled()

Returns
Type	Description
boolean

setClientEmail(String clientEmail)

public ServiceAccountCredentials.Builder setClientEmail(String clientEmail)

Parameter
Name	Description
clientEmail	String

Returns
Type	Description
ServiceAccountCredentials.Builder

setClientId(String clientId)

public ServiceAccountCredentials.Builder setClientId(String clientId)

Parameter
Name	Description
clientId	String

Returns
Type	Description
ServiceAccountCredentials.Builder

setDefaultRetriesEnabled(boolean defaultRetriesEnabled)

public ServiceAccountCredentials.Builder setDefaultRetriesEnabled(boolean defaultRetriesEnabled)

Parameter
Name	Description
defaultRetriesEnabled	boolean

Returns
Type	Description
ServiceAccountCredentials.Builder

setHttpTransportFactory(HttpTransportFactory transportFactory)

public ServiceAccountCredentials.Builder setHttpTransportFactory(HttpTransportFactory transportFactory)

Parameter
Name	Description
transportFactory	HttpTransportFactory

Returns
Type	Description
ServiceAccountCredentials.Builder

setLifetime(int lifetime)

public ServiceAccountCredentials.Builder setLifetime(int lifetime)

Parameter
Name	Description
lifetime	int

Returns
Type	Description
ServiceAccountCredentials.Builder

setPrivateKey(PrivateKey privateKey)

public ServiceAccountCredentials.Builder setPrivateKey(PrivateKey privateKey)

Parameter
Name	Description
privateKey	PrivateKey

Returns
Type	Description
ServiceAccountCredentials.Builder

setPrivateKeyId(String privateKeyId)

public ServiceAccountCredentials.Builder setPrivateKeyId(String privateKeyId)

Parameter
Name	Description
privateKeyId	String

Returns
Type	Description
ServiceAccountCredentials.Builder

setPrivateKeyString(String privateKeyPkcs8)

public ServiceAccountCredentials.Builder setPrivateKeyString(String privateKeyPkcs8)

Parameter
Name	Description
privateKeyPkcs8	String

Returns
Type	Description
ServiceAccountCredentials.Builder

Exceptions
Type	Description
IOException

setProjectId(String projectId)

public ServiceAccountCredentials.Builder setProjectId(String projectId)

Parameter
Name	Description
projectId	String

Returns
Type	Description
ServiceAccountCredentials.Builder

setQuotaProjectId(@Nullable String quotaProjectId)

public ServiceAccountCredentials.Builder setQuotaProjectId(@Nullable String quotaProjectId)

Parameter
Name	Description
quotaProjectId	@org.jspecify.annotations.Nullable java.lang.String

Returns
Type	Description
ServiceAccountCredentials.Builder

Overrides

GoogleCredentials.Builder.setQuotaProjectId(@Nullable String quotaProjectId)

setScopes(Collection<String> scopes)

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

Parameter
Name	Description
scopes	Collection<String>

Returns
Type	Description
ServiceAccountCredentials.Builder

setScopes(Collection<String> scopes, Collection<String> defaultScopes)

public ServiceAccountCredentials.Builder setScopes(Collection<String> scopes, Collection<String> defaultScopes)

Parameters
Name	Description
scopes	Collection<String>
defaultScopes	Collection<String>

Returns
Type	Description
ServiceAccountCredentials.Builder

setServiceAccountUser(String serviceAccountUser)

public ServiceAccountCredentials.Builder setServiceAccountUser(String serviceAccountUser)

Parameter
Name	Description
serviceAccountUser	String

Returns
Type	Description
ServiceAccountCredentials.Builder

setTokenServerUri(@Nullable URI tokenServerUri)

public ServiceAccountCredentials.Builder setTokenServerUri(@Nullable URI tokenServerUri)

Parameter
Name	Description
tokenServerUri	@org.jspecify.annotations.Nullable java.net.URI

Returns
Type	Description
ServiceAccountCredentials.Builder

setUniverseDomain(String universeDomain)

public ServiceAccountCredentials.Builder setUniverseDomain(String universeDomain)

Parameter
Name	Description
universeDomain	String

Returns
Type	Description
ServiceAccountCredentials.Builder

Overrides

GoogleCredentials.Builder.setUniverseDomain(String universeDomain)

setUseJwtAccessWithScope(boolean useJwtAccessWithScope)

public ServiceAccountCredentials.Builder setUseJwtAccessWithScope(boolean useJwtAccessWithScope)

Sets the useJwtAccessWithScope flag. This flag will be ignored if universeDomain field is different from Credentials#GOOGLE_DEFAULT_UNIVERSE.

Parameter
Name	Description
useJwtAccessWithScope	boolean

Returns
Type	Description
ServiceAccountCredentials.Builder