com.google.cloud.iam.credentials.v1

Class IamCredentialsSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<IamCredentialsSettings>

com.google.cloud.iam.credentials.v1.IamCredentialsSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class IamCredentialsSettings
extends com.google.api.gax.rpc.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().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 IamCredentialsSettings iamCredentialsSettings = iamCredentialsSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IamCredentialsSettings.Builder Builder for IamCredentialsSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	IamCredentialsSettings(IamCredentialsSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
static IamCredentialsSettings	create(IamCredentialsStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse>	generateAccessTokenSettings() Returns the object with the settings used for calls to generateAccessToken.
com.google.api.gax.rpc.UnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse>	generateIdTokenSettings() Returns the object with the settings used for calls to generateIdToken.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
static IamCredentialsSettings.Builder	newBuilder() Returns a new builder for this class.
static IamCredentialsSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<SignBlobRequest,SignBlobResponse>	signBlobSettings() Returns the object with the settings used for calls to signBlob.
com.google.api.gax.rpc.UnaryCallSettings<SignJwtRequest,SignJwtResponse>	signJwtSettings() Returns the object with the settings used for calls to signJwt.
IamCredentialsSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IamCredentialsSettings

protected IamCredentialsSettings(IamCredentialsSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

generateAccessTokenSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse> generateAccessTokenSettings()

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

generateIdTokenSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse> generateIdTokenSettings()

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

signBlobSettings

public com.google.api.gax.rpc.UnaryCallSettings<SignBlobRequest,SignBlobResponse> signBlobSettings()

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

signJwtSettings

public com.google.api.gax.rpc.UnaryCallSettings<SignJwtRequest,SignJwtResponse> signJwtSettings()

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

create

public static final IamCredentialsSettings create(IamCredentialsStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static IamCredentialsSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static IamCredentialsSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public IamCredentialsSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<IamCredentialsSettings>