com.google.cloud.iam.admin.v1

Class IAMSettings

java.lang.Object

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

com.google.cloud.iam.admin.v1.IAMSettings

@Generated(value="by gapic-generator-java")
public class IAMSettings
extends com.google.api.gax.rpc.ClientSettings<IAMSettings>

Settings class to configure an instance of IAMClient.

The default instance has everything set to sensible defaults:

• The default service address (iam.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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of getServiceAccount:

 // 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
 IAMSettings.Builder iAMSettingsBuilder = IAMSettings.newBuilder();
 iAMSettingsBuilder
     .getServiceAccountSettings()
     .setRetrySettings(
         iAMSettingsBuilder
             .getServiceAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 IAMSettings iAMSettings = iAMSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static IAMSettings	create(IAMStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateRoleRequest,Role>	createRoleSettings() Returns the object with the settings used for calls to createRole.
com.google.api.gax.rpc.UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey>	createServiceAccountKeySettings() Returns the object with the settings used for calls to createServiceAccountKey.
com.google.api.gax.rpc.UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount>	createServiceAccountSettings() Returns the object with the settings used for calls to createServiceAccount.
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<DeleteRoleRequest,Role>	deleteRoleSettings() Returns the object with the settings used for calls to deleteRole.
com.google.api.gax.rpc.UnaryCallSettings<DeleteServiceAccountKeyRequest,com.google.protobuf.Empty>	deleteServiceAccountKeySettings() Returns the object with the settings used for calls to deleteServiceAccountKey.
com.google.api.gax.rpc.UnaryCallSettings<DeleteServiceAccountRequest,com.google.protobuf.Empty>	deleteServiceAccountSettings() Returns the object with the settings used for calls to deleteServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<DisableServiceAccountKeyRequest,com.google.protobuf.Empty>	disableServiceAccountKeySettings() Returns the object with the settings used for calls to disableServiceAccountKey.
com.google.api.gax.rpc.UnaryCallSettings<DisableServiceAccountRequest,com.google.protobuf.Empty>	disableServiceAccountSettings() Returns the object with the settings used for calls to disableServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<EnableServiceAccountKeyRequest,com.google.protobuf.Empty>	enableServiceAccountKeySettings() Returns the object with the settings used for calls to enableServiceAccountKey.
com.google.api.gax.rpc.UnaryCallSettings<EnableServiceAccountRequest,com.google.protobuf.Empty>	enableServiceAccountSettings() Returns the object with the settings used for calls to enableServiceAccount.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetRoleRequest,Role>	getRoleSettings() Returns the object with the settings used for calls to getRole.
com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey>	getServiceAccountKeySettings() Returns the object with the settings used for calls to getServiceAccountKey.
com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>	getServiceAccountSettings() Returns the object with the settings used for calls to getServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<LintPolicyRequest,LintPolicyResponse>	lintPolicySettings() Returns the object with the settings used for calls to lintPolicy.
com.google.api.gax.rpc.PagedCallSettings<ListRolesRequest,ListRolesResponse,IAMClient.ListRolesPagedResponse>	listRolesSettings() Returns the object with the settings used for calls to listRoles.
com.google.api.gax.rpc.UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse>	listServiceAccountKeysSettings() Returns the object with the settings used for calls to listServiceAccountKeys.
com.google.api.gax.rpc.PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,IAMClient.ListServiceAccountsPagedResponse>	listServiceAccountsSettings() Returns the object with the settings used for calls to listServiceAccounts.
static IAMSettings.Builder	newBuilder() Returns a new builder for this class.
static IAMSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount>	patchServiceAccountSettings() Returns the object with the settings used for calls to patchServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse>	queryAuditableServicesSettings() Returns the object with the settings used for calls to queryAuditableServices.
com.google.api.gax.rpc.PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,IAMClient.QueryGrantableRolesPagedResponse>	queryGrantableRolesSettings() Returns the object with the settings used for calls to queryGrantableRoles.
com.google.api.gax.rpc.PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,IAMClient.QueryTestablePermissionsPagedResponse>	queryTestablePermissionsSettings() Returns the object with the settings used for calls to queryTestablePermissions.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<SignBlobRequest,SignBlobResponse>	signBlobSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.UnaryCallSettings<SignJwtRequest,SignJwtResponse>	signJwtSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
IAMSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteRoleRequest,Role>	undeleteRoleSettings() Returns the object with the settings used for calls to undeleteRole.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse>	undeleteServiceAccountSettings() Returns the object with the settings used for calls to undeleteServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<UpdateRoleRequest,Role>	updateRoleSettings() Returns the object with the settings used for calls to updateRole.
com.google.api.gax.rpc.UnaryCallSettings<ServiceAccount,ServiceAccount>	updateServiceAccountSettings() Returns the object with the settings used for calls to updateServiceAccount.
com.google.api.gax.rpc.UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey>	uploadServiceAccountKeySettings() Returns the object with the settings used for calls to uploadServiceAccountKey.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

IAMSettings

protected IAMSettings(IAMSettings.Builder settingsBuilder)
               throws IOException

Throws:

IOException

Method Detail

listServiceAccountsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,IAMClient.ListServiceAccountsPagedResponse> listServiceAccountsSettings()

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

getServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

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

createServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount> createServiceAccountSettings()

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

updateServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<ServiceAccount,ServiceAccount> updateServiceAccountSettings()

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

patchServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount> patchServiceAccountSettings()

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

deleteServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteServiceAccountRequest,com.google.protobuf.Empty> deleteServiceAccountSettings()

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

undeleteServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse> undeleteServiceAccountSettings()

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

enableServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableServiceAccountRequest,com.google.protobuf.Empty> enableServiceAccountSettings()

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

disableServiceAccountSettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableServiceAccountRequest,com.google.protobuf.Empty> disableServiceAccountSettings()

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

listServiceAccountKeysSettings

public com.google.api.gax.rpc.UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse> listServiceAccountKeysSettings()

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

getServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey> getServiceAccountKeySettings()

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

createServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey> createServiceAccountKeySettings()

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

uploadServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey> uploadServiceAccountKeySettings()

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

deleteServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteServiceAccountKeyRequest,com.google.protobuf.Empty> deleteServiceAccountKeySettings()

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

disableServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<DisableServiceAccountKeyRequest,com.google.protobuf.Empty> disableServiceAccountKeySettings()

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

enableServiceAccountKeySettings

public com.google.api.gax.rpc.UnaryCallSettings<EnableServiceAccountKeyRequest,com.google.protobuf.Empty> enableServiceAccountKeySettings()

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

signBlobSettings

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

Deprecated. This method is deprecated and will be removed in the next major version update.

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

signJwtSettings

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

Deprecated. This method is deprecated and will be removed in the next major version update.

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

getIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

setIamPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

testIamPermissionsSettings

public com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

queryGrantableRolesSettings

public com.google.api.gax.rpc.PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,IAMClient.QueryGrantableRolesPagedResponse> queryGrantableRolesSettings()

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

listRolesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListRolesRequest,ListRolesResponse,IAMClient.ListRolesPagedResponse> listRolesSettings()

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

getRoleSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetRoleRequest,Role> getRoleSettings()

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

createRoleSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateRoleRequest,Role> createRoleSettings()

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

updateRoleSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateRoleRequest,Role> updateRoleSettings()

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

deleteRoleSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteRoleRequest,Role> deleteRoleSettings()

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

undeleteRoleSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteRoleRequest,Role> undeleteRoleSettings()

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

queryTestablePermissionsSettings

public com.google.api.gax.rpc.PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,IAMClient.QueryTestablePermissionsPagedResponse> queryTestablePermissionsSettings()

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

queryAuditableServicesSettings

public com.google.api.gax.rpc.UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse> queryAuditableServicesSettings()

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

lintPolicySettings

public com.google.api.gax.rpc.UnaryCallSettings<LintPolicyRequest,LintPolicyResponse> lintPolicySettings()

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

create

public static final IAMSettings create(IAMStubSettings 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

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static IAMSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public IAMSettings.Builder toBuilder()

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

Specified by:

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