Class IAMStubSettings (3.7.0)

public class IAMStubSettings extends StubSettings<IAMStubSettings>

Settings class to configure an instance of IAMStub.

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
 IAMStubSettings.Builder iAMSettingsBuilder = IAMStubSettings.newBuilder();
 iAMSettingsBuilder
     .getServiceAccountSettings()
     .setRetrySettings(
         iAMSettingsBuilder
             .getServiceAccountSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 IAMStubSettings iAMSettings = iAMSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > IAMStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
`Builder`

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
`Builder`

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
`Builder`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
`Builder`

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
`TransportChannelProvider`

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
`String`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns

Type	Description
`String`

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
`List<String>`

newBuilder()

public static IAMStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
`IAMStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static IAMStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
`clientContext`	`ClientContext`

Returns

Type	Description
`IAMStubSettings.Builder`

Constructors

IAMStubSettings(IAMStubSettings.Builder settingsBuilder)

protected IAMStubSettings(IAMStubSettings.Builder settingsBuilder)

Parameter

Name	Description
`settingsBuilder`	`IAMStubSettings.Builder`

Methods

createRoleSettings()

public UnaryCallSettings<CreateRoleRequest,Role> createRoleSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateRoleRequest,Role>`

createServiceAccountKeySettings()

public UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey> createServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateServiceAccountKeyRequest,ServiceAccountKey>`

createServiceAccountSettings()

public UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount> createServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<CreateServiceAccountRequest,ServiceAccount>`

createStub()

public IAMStub createStub()

Returns

Type	Description
`IAMStub`

Exceptions

Type	Description
`IOException`

deleteRoleSettings()

public UnaryCallSettings<DeleteRoleRequest,Role> deleteRoleSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteRoleRequest,Role>`

deleteServiceAccountKeySettings()

public UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty> deleteServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteServiceAccountKeyRequest,Empty>`

deleteServiceAccountSettings()

public UnaryCallSettings<DeleteServiceAccountRequest,Empty> deleteServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<DeleteServiceAccountRequest,Empty>`

disableServiceAccountKeySettings()

public UnaryCallSettings<DisableServiceAccountKeyRequest,Empty> disableServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<DisableServiceAccountKeyRequest,Empty>`

disableServiceAccountSettings()

public UnaryCallSettings<DisableServiceAccountRequest,Empty> disableServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<DisableServiceAccountRequest,Empty>`

enableServiceAccountKeySettings()

public UnaryCallSettings<EnableServiceAccountKeyRequest,Empty> enableServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<EnableServiceAccountKeyRequest,Empty>`

enableServiceAccountSettings()

public UnaryCallSettings<EnableServiceAccountRequest,Empty> enableServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<EnableServiceAccountRequest,Empty>`

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns

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.

Returns

Type	Description
`UnaryCallSettings<GetRoleRequest,Role>`

getServiceAccountKeySettings()

public UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey> getServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<GetServiceAccountKeyRequest,ServiceAccountKey>`

getServiceAccountSettings()

public UnaryCallSettings<GetServiceAccountRequest,ServiceAccount> getServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<GetServiceAccountRequest,ServiceAccount>`

lintPolicySettings()

public UnaryCallSettings<LintPolicyRequest,LintPolicyResponse> lintPolicySettings()

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

Returns

Type	Description
`UnaryCallSettings<LintPolicyRequest,LintPolicyResponse>`

listRolesSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListRolesRequest,ListRolesResponse,ListRolesPagedResponse>`

listServiceAccountKeysSettings()

public UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse> listServiceAccountKeysSettings()

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

Returns

Type	Description
`UnaryCallSettings<ListServiceAccountKeysRequest,ListServiceAccountKeysResponse>`

listServiceAccountsSettings()

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

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

Returns

Type	Description
`PagedCallSettings<ListServiceAccountsRequest,ListServiceAccountsResponse,ListServiceAccountsPagedResponse>`

patchServiceAccountSettings()

public UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount> patchServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<PatchServiceAccountRequest,ServiceAccount>`

queryAuditableServicesSettings()

public UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse> queryAuditableServicesSettings()

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

Returns

Type	Description
`UnaryCallSettings<QueryAuditableServicesRequest,QueryAuditableServicesResponse>`

queryGrantableRolesSettings()

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

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

Returns

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.

Returns

Type	Description
`PagedCallSettings<QueryTestablePermissionsRequest,QueryTestablePermissionsResponse,QueryTestablePermissionsPagedResponse>`

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns

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.

Returns

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.

Returns

Type	Description
`UnaryCallSettings<SignJwtRequest,SignJwtResponse>`

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()

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

Returns

Type	Description
`UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`

toBuilder()

public IAMStubSettings.Builder toBuilder()

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

Returns

Type	Description
`IAMStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

undeleteRoleSettings()

public UnaryCallSettings<UndeleteRoleRequest,Role> undeleteRoleSettings()

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

Returns

Type	Description
`UnaryCallSettings<UndeleteRoleRequest,Role>`

undeleteServiceAccountSettings()

public UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse> undeleteServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<UndeleteServiceAccountRequest,UndeleteServiceAccountResponse>`

updateRoleSettings()

public UnaryCallSettings<UpdateRoleRequest,Role> updateRoleSettings()

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

Returns

Type	Description
`UnaryCallSettings<UpdateRoleRequest,Role>`

updateServiceAccountSettings()

public UnaryCallSettings<ServiceAccount,ServiceAccount> updateServiceAccountSettings()

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

Returns

Type	Description
`UnaryCallSettings<ServiceAccount,ServiceAccount>`

uploadServiceAccountKeySettings()

public UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey> uploadServiceAccountKeySettings()

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

Returns

Type	Description
`UnaryCallSettings<UploadServiceAccountKeyRequest,ServiceAccountKey>`