Class IamCredentialsSettings (2.49.0)

publicclass IamCredentialsSettingsextendsClientSettings<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:


// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
IamCredentialsSettings.BuilderiamCredentialsSettingsBuilder=
IamCredentialsSettings.newBuilder();
iamCredentialsSettingsBuilder
.generateAccessTokenSettings()
.setRetrySettings(
iamCredentialsSettingsBuilder
.generateAccessTokenSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
IamCredentialsSettingsiamCredentialsSettings=iamCredentialsSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > IamCredentialsSettings

Inherited Members

Static Methods

create(IamCredentialsStubSettings stub)

publicstaticfinalIamCredentialsSettingscreate(IamCredentialsStubSettingsstub)
Parameter
Name Description
stub IamCredentialsStubSettings
Returns
Type Description
IamCredentialsSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

publicstaticIamCredentialsSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
IamCredentialsSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticIamCredentialsSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
IamCredentialsSettings.Builder

newHttpJsonBuilder()

publicstaticIamCredentialsSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
IamCredentialsSettings.Builder

Constructors

IamCredentialsSettings(IamCredentialsSettings.Builder settingsBuilder)

protectedIamCredentialsSettings(IamCredentialsSettings.BuildersettingsBuilder)
Parameter
Name Description
settingsBuilder IamCredentialsSettings.Builder

Methods

generateAccessTokenSettings()

publicUnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse>generateAccessTokenSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateAccessTokenRequest,GenerateAccessTokenResponse>

generateIdTokenSettings()

publicUnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse>generateIdTokenSettings()

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

Returns
Type Description
UnaryCallSettings<GenerateIdTokenRequest,GenerateIdTokenResponse>

signBlobSettings()

publicUnaryCallSettings<SignBlobRequest,SignBlobResponse>signBlobSettings()

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

Returns
Type Description
UnaryCallSettings<SignBlobRequest,SignBlobResponse>

signJwtSettings()

publicUnaryCallSettings<SignJwtRequest,SignJwtResponse>signJwtSettings()

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

Returns
Type Description
UnaryCallSettings<SignJwtRequest,SignJwtResponse>

toBuilder()

publicIamCredentialsSettings.BuildertoBuilder()

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

Returns
Type Description
IamCredentialsSettings.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.