Class IamCredentialsSettings (2.0.15)

public class IamCredentialsSettings extends ClientSettings<IamCredentialsSettings>

Settings class to configure an instance of IamCredentialsClient.

The default instance has everything set to sensible defaults:

The default service address (iamcredentials.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of generateAccessToken to 30 seconds:


 IamCredentialsSettings.Builder iamCredentialsSettingsBuilder =
     IamCredentialsSettings.newBuilder();
 iamCredentialsSettingsBuilder
     .generateAccessTokenSettings()
     .setRetrySettings(
         iamCredentialsSettingsBuilder
             .generateAccessTokenSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IamCredentialsSettings iamCredentialsSettings = iamCredentialsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > IamCredentialsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create(IamCredentialsStubSettings stub)

public static final IamCredentialsSettings create(IamCredentialsStubSettings stub)

Parameter

Name	Description
stub	`IamCredentialsStubSettings`

Returns

Type	Description
IamCredentialsSettings

Exceptions

Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static IamCredentialsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
IamCredentialsSettings.Builder

newBuilder(ClientContext clientContext)

public static IamCredentialsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
IamCredentialsSettings.Builder

Constructors

IamCredentialsSettings(IamCredentialsSettings.Builder settingsBuilder)

protected IamCredentialsSettings(IamCredentialsSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`IamCredentialsSettings.Builder`

Methods

generateAccessTokenSettings()

public UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenSettings()

Returns the object with the settings used for calls to generateAccessToken.

Returns

Type	Description
UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse>

generateIdTokenSettings()

public UnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse> generateIdTokenSettings()

Returns the object with the settings used for calls to generateIdToken.

Returns

Type	Description
UnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse>

signBlobSettings()

public UnaryCallSettings<SignBlobRequest,SignBlobResponse> signBlobSettings()

Returns the object with the settings used for calls to signBlob.

Returns

Type	Description
UnaryCallSettings<SignBlobRequest,SignBlobResponse>

signJwtSettings()

public UnaryCallSettings<SignJwtRequest,SignJwtResponse> signJwtSettings()

Returns the object with the settings used for calls to signJwt.

Returns

Type	Description
UnaryCallSettings<SignJwtRequest,SignJwtResponse>

toBuilder()

public IamCredentialsSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns

Type	Description
IamCredentialsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()