- 3.48.0 (latest)
- 3.47.0
- 3.44.0
- 3.43.0
- 3.42.0
- 3.41.0
- 3.40.0
- 3.39.0
- 3.38.0
- 3.37.0
- 3.36.0
- 3.35.0
- 3.34.0
- 3.32.0
- 3.31.0
- 3.30.0
- 3.29.0
- 3.28.0
- 3.27.0
- 3.26.0
- 3.25.0
- 3.24.0
- 3.23.0
- 3.22.0
- 3.19.0
- 3.18.0
- 3.17.0
- 3.16.0
- 3.15.0
- 3.14.0
- 3.13.0
- 3.12.0
- 3.11.0
- 3.10.0
- 3.9.0
- 3.8.0
- 3.7.0
- 3.6.0
- 3.4.0
- 3.3.0
- 3.2.0
- 3.1.0
- 3.0.0
- 2.0.0
- 1.2.5
- 1.1.8
- 0.2.0
public class IAMSettings extends 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 total timeout of getServiceAccount 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
IAMSettings.Builder iAMSettingsBuilder = IAMSettings.newBuilder();
iAMSettingsBuilder
.getServiceAccountSettings()
.setRetrySettings(
iAMSettingsBuilder.getServiceAccountSettings().getRetrySettings().toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
IAMSettings iAMSettings = iAMSettingsBuilder.build();
Static Methods
create(IAMStubSettings stub)
public static final IAMSettings create(IAMStubSettings stub)| Name | Description |
| stub | IAMStubSettings |
| Type | Description |
| IAMSettings |
| Type | Description |
| IOException |
defaultApiClientHeaderProviderBuilder()
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()| Type | Description |
| Builder |
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()Returns a builder for the default credentials for this service.
| Type | Description |
| Builder |
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service.
| Type | Description |
| Builder |
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()Returns a builder for the default ChannelProvider for this service.
| Type | Description |
| Builder |
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()| Type | Description |
| TransportChannelProvider |
getDefaultEndpoint()
public static String getDefaultEndpoint()Returns the default service endpoint.
| Type | Description |
| String |
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Type | Description |
| List<String> |
newBuilder()
public static IAMSettings.Builder newBuilder()Returns a new builder for this class.
| Type | Description |
| IAMSettings.Builder |
newBuilder(ClientContext clientContext)
public static IAMSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Name | Description |
| clientContext | ClientContext |
| Type | Description |
| IAMSettings.Builder |
Constructors
IAMSettings(IAMSettings.Builder settingsBuilder)
protected IAMSettings(IAMSettings.Builder settingsBuilder)| Name | Description |
| settingsBuilder | IAMSettings.Builder |
Methods
createRoleSettings()
public UnaryCallSettings<CreateRoleRequest,Role> createRoleSettings()Returns the object with the settings used for calls to createRole.
| Type | Description |
| UnaryCallSettings<CreateRoleRequest,Role> |
createServiceAccountKeySettings()
public UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey> createServiceAccountKeySettings()Returns the object with the settings used for calls to createServiceAccountKey.
| Type | Description |
| UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey> |
createServiceAccountSettings()
public UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount> createServiceAccountSettings()Returns the object with the settings used for calls to createServiceAccount.
| Type | Description |
| UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount> |
deleteRoleSettings()
public UnaryCallSettings<DeleteRoleRequest,Role> deleteRoleSettings()Returns the object with the settings used for calls to deleteRole.
| Type | Description |
| UnaryCallSettings<DeleteRoleRequest,Role> |
deleteServiceAccountKeySettings()
public UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty> deleteServiceAccountKeySettings()Returns the object with the settings used for calls to deleteServiceAccountKey.
| Type | Description |
| UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty> |
deleteServiceAccountSettings()
public UnaryCallSettings<DeleteServiceAccountRequest,Empty> deleteServiceAccountSettings()Returns the object with the settings used for calls to deleteServiceAccount.
| Type | Description |
| UnaryCallSettings<DeleteServiceAccountRequest,Empty> |
disableServiceAccountKeySettings()
public UnaryCallSettings<DisableServiceAccountKeyRequest,Empty> disableServiceAccountKeySettings()Returns the object with the settings used for calls to disableServiceAccountKey.
| Type | Description |
| UnaryCallSettings<DisableServiceAccountKeyRequest,Empty> |
disableServiceAccountSettings()
public UnaryCallSettings<DisableServiceAccountRequest,Empty> disableServiceAccountSettings()Returns the object with the settings used for calls to disableServiceAccount.
| Type | Description |
| UnaryCallSettings<DisableServiceAccountRequest,Empty> |
enableServiceAccountKeySettings()
public UnaryCallSettings<EnableServiceAccountKeyRequest,Empty> enableServiceAccountKeySettings()Returns the object with the settings used for calls to enableServiceAccountKey.
| Type | Description |
| UnaryCallSettings<EnableServiceAccountKeyRequest,Empty> |
enableServiceAccountSettings()
public UnaryCallSettings<EnableServiceAccountRequest,Empty> enableServiceAccountSettings()Returns the object with the settings used for calls to enableServiceAccount.
| Type | Description |
| UnaryCallSettings<EnableServiceAccountRequest,Empty> |
getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()Returns the object with the settings used for calls to getIamPolicy.
| Type | Description |
| UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> |
getRoleSettings()
public UnaryCallSettings<GetRoleRequest,Role> getRoleSettings()Returns the object with the settings used for calls to getRole.
| Type | Description |
| UnaryCallSettings<GetRoleRequest,Role> |
getServiceAccountKeySettings()
public UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey> getServiceAccountKeySettings()Returns the object with the settings used for calls to getServiceAccountKey.
| Type | Description |
| UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey> |
getServiceAccountSettings()
public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()Returns the object with the settings used for calls to getServiceAccount.
| Type | Description |
| UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> |
lintPolicySettings()
public UnaryCallSettings<LintPolicyRequest,LintPolicyResponse> lintPolicySettings()Returns the object with the settings used for calls to lintPolicy.
| Type | Description |
| UnaryCallSettings<LintPolicyRequest,LintPolicyResponse> |
listRolesSettings()
public PagedCallSettings<ListRolesRequest,ListRolesResponse,IAMClient.ListRolesPagedResponse> listRolesSettings()Returns the object with the settings used for calls to listRoles.
| Type | Description |
| PagedCallSettings<ListRolesRequest,ListRolesResponse,ListRolesPagedResponse> |
listServiceAccountKeysSettings()
public UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse> listServiceAccountKeysSettings()Returns the object with the settings used for calls to listServiceAccountKeys.
| Type | Description |
| UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse> |
listServiceAccountsSettings()
public PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,IAMClient.ListServiceAccountsPagedResponse> listServiceAccountsSettings()Returns the object with the settings used for calls to listServiceAccounts.
| Type | Description |
| PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,ListServiceAccountsPagedResponse> |
patchServiceAccountSettings()
public UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount> patchServiceAccountSettings()Returns the object with the settings used for calls to patchServiceAccount.
| Type | Description |
| UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount> |
queryAuditableServicesSettings()
public UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse> queryAuditableServicesSettings()Returns the object with the settings used for calls to queryAuditableServices.
| Type | Description |
| UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse> |
queryGrantableRolesSettings()
public PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,IAMClient.QueryGrantableRolesPagedResponse> queryGrantableRolesSettings()Returns the object with the settings used for calls to queryGrantableRoles.
| Type | Description |
| PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,QueryGrantableRolesPagedResponse> |
queryTestablePermissionsSettings()
public PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,IAMClient.QueryTestablePermissionsPagedResponse> queryTestablePermissionsSettings()Returns the object with the settings used for calls to queryTestablePermissions.
| Type | Description |
| PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,QueryTestablePermissionsPagedResponse> |
setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()Returns the object with the settings used for calls to setIamPolicy.
| Type | Description |
| UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> |
signBlobSettings() (deprecated)
public 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.
| Type | Description |
| UnaryCallSettings<SignBlobRequest,SignBlobResponse> |
signJwtSettings() (deprecated)
public 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.
| Type | Description |
| UnaryCallSettings<SignJwtRequest,SignJwtResponse> |
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions.
| Type | Description |
| UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> |
toBuilder()
public IAMSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Type | Description |
| IAMSettings.Builder |
undeleteRoleSettings()
public UnaryCallSettings<UndeleteRoleRequest,Role> undeleteRoleSettings()Returns the object with the settings used for calls to undeleteRole.
| Type | Description |
| UnaryCallSettings<UndeleteRoleRequest,Role> |
undeleteServiceAccountSettings()
public UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse> undeleteServiceAccountSettings()Returns the object with the settings used for calls to undeleteServiceAccount.
| Type | Description |
| UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse> |
updateRoleSettings()
public UnaryCallSettings<UpdateRoleRequest,Role> updateRoleSettings()Returns the object with the settings used for calls to updateRole.
| Type | Description |
| UnaryCallSettings<UpdateRoleRequest,Role> |
updateServiceAccountSettings()
public UnaryCallSettings<ServiceAccount,ServiceAccount> updateServiceAccountSettings()Returns the object with the settings used for calls to updateServiceAccount.
| Type | Description |
| UnaryCallSettings<ServiceAccount,ServiceAccount> |
uploadServiceAccountKeySettings()
public UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey> uploadServiceAccountKeySettings()Returns the object with the settings used for calls to uploadServiceAccountKey.
| Type | Description |
| UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey> |