Class IAMSettings (1.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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 IAMSettings.Builder iAMSettingsBuilder = IAMSettings.newBuilder();
 iAMSettingsBuilder
     .getServiceAccountSettings()
     .setRetrySettings(
         iAMSettingsBuilder
             .getServiceAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IAMSettings iAMSettings = iAMSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > IAMSettings

Static Methods

create(IAMStubSettings stub)

public static final IAMSettings create(IAMStubSettings stub)
Parameter
NameDescription
stubIAMStubSettings
Returns
TypeDescription
IAMSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static IAMSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
IAMSettings.Builder

newBuilder(ClientContext clientContext)

public static IAMSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
IAMSettings.Builder

Constructors

IAMSettings(IAMSettings.Builder settingsBuilder)

protected IAMSettings(IAMSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderIAMSettings.Builder

Methods

createRoleSettings()

public UnaryCallSettings<CreateRoleRequest,Role> createRoleSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateRoleRequest,Role>

createServiceAccountKeySettings()

public UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey> createServiceAccountKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey>

createServiceAccountSettings()

public UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount> createServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount>

deleteRoleSettings()

public UnaryCallSettings<DeleteRoleRequest,Role> deleteRoleSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteRoleRequest,Role>

deleteServiceAccountKeySettings()

public UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty> deleteServiceAccountKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty>

deleteServiceAccountSettings()

public UnaryCallSettings<DeleteServiceAccountRequest,Empty> deleteServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteServiceAccountRequest,Empty>

disableServiceAccountSettings()

public UnaryCallSettings<DisableServiceAccountRequest,Empty> disableServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<DisableServiceAccountRequest,Empty>

enableServiceAccountSettings()

public UnaryCallSettings<EnableServiceAccountRequest,Empty> enableServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<EnableServiceAccountRequest,Empty>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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.

Returns
TypeDescription
UnaryCallSettings<GetRoleRequest,Role>

getServiceAccountKeySettings()

public UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey> getServiceAccountKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey>

getServiceAccountSettings()

public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>

lintPolicySettings()

public UnaryCallSettings<LintPolicyRequest,LintPolicyResponse> lintPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<LintPolicyRequest,LintPolicyResponse>

listRolesSettings()

public PagedCallSettings<ListRolesRequest,ListRolesResponse,IAMClient.ListRolesPagedResponse> listRolesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListRolesRequest,ListRolesResponse,ListRolesPagedResponse>

listServiceAccountKeysSettings()

public UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse> listServiceAccountKeysSettings()

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

Returns
TypeDescription
UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse>

listServiceAccountsSettings()

public PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,IAMClient.ListServiceAccountsPagedResponse> listServiceAccountsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,ListServiceAccountsPagedResponse>

patchServiceAccountSettings()

public UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount> patchServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount>

queryAuditableServicesSettings()

public UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse> queryAuditableServicesSettings()

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

Returns
TypeDescription
UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse>

queryGrantableRolesSettings()

public PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,IAMClient.QueryGrantableRolesPagedResponse> queryGrantableRolesSettings()

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

Returns
TypeDescription
PagedCallSettings<QueryGrantableRolesRequest,QueryGrantableRolesResponse,QueryGrantableRolesPagedResponse>

queryTestablePermissionsSettings()

public PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,IAMClient.QueryTestablePermissionsPagedResponse> queryTestablePermissionsSettings()

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

Returns
TypeDescription
PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,QueryTestablePermissionsPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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.

Returns
TypeDescription
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.

Returns
TypeDescription
UnaryCallSettings<SignJwtRequest,SignJwtResponse>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns
TypeDescription
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.

Returns
TypeDescription
IAMSettings.Builder
Overrides

undeleteRoleSettings()

public UnaryCallSettings<UndeleteRoleRequest,Role> undeleteRoleSettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeleteRoleRequest,Role>

undeleteServiceAccountSettings()

public UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse> undeleteServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse>

updateRoleSettings()

public UnaryCallSettings<UpdateRoleRequest,Role> updateRoleSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateRoleRequest,Role>

updateServiceAccountSettings()

public UnaryCallSettings<ServiceAccount,ServiceAccount> updateServiceAccountSettings()

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

Returns
TypeDescription
UnaryCallSettings<ServiceAccount,ServiceAccount>

uploadServiceAccountKeySettings()

public UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey> uploadServiceAccountKeySettings()

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

Returns
TypeDescription
UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey>