public class AlloyDBAdminSettings extends ClientSettings<AlloyDBAdminSettings>Settings class to configure an instance of AlloyDBAdminClient.
The default instance has everything set to sensible defaults:
- The default service address (alloydb.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 of getCluster:
// 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
AlloyDBAdminSettings.Builder alloyDBAdminSettingsBuilder = AlloyDBAdminSettings.newBuilder();
alloyDBAdminSettingsBuilder
.getClusterSettings()
.setRetrySettings(
alloyDBAdminSettingsBuilder
.getClusterSettings()
.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());
AlloyDBAdminSettings alloyDBAdminSettings = alloyDBAdminSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createCluster:
// 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
AlloyDBAdminSettings.Builder alloyDBAdminSettingsBuilder = AlloyDBAdminSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
alloyDBAdminSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(AlloyDBAdminStubSettings stub)
public static final AlloyDBAdminSettings create(AlloyDBAdminStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
AlloyDBAdminStubSettings |
| Returns | |
|---|---|
| Type | Description |
AlloyDBAdminSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST 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 |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static AlloyDBAdminSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
AlloyDBAdminSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static AlloyDBAdminSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
AlloyDBAdminSettings.Builder |
|
newHttpJsonBuilder()
public static AlloyDBAdminSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
AlloyDBAdminSettings.Builder |
|
Constructors
AlloyDBAdminSettings(AlloyDBAdminSettings.Builder settingsBuilder)
protected AlloyDBAdminSettings(AlloyDBAdminSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
AlloyDBAdminSettings.Builder |
Methods
batchCreateInstancesOperationSettings()
public OperationCallSettings<BatchCreateInstancesRequest,BatchCreateInstancesResponse,OperationMetadata> batchCreateInstancesOperationSettings()Returns the object with the settings used for calls to batchCreateInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<BatchCreateInstancesRequest,BatchCreateInstancesResponse,OperationMetadata> |
|
batchCreateInstancesSettings()
public UnaryCallSettings<BatchCreateInstancesRequest,Operation> batchCreateInstancesSettings()Returns the object with the settings used for calls to batchCreateInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<BatchCreateInstancesRequest,Operation> |
|
createBackupOperationSettings()
public OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationSettings()Returns the object with the settings used for calls to createBackup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> |
|
createBackupSettings()
public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()Returns the object with the settings used for calls to createBackup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateBackupRequest,Operation> |
|
createClusterOperationSettings()
public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()Returns the object with the settings used for calls to createCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> |
|
createClusterSettings()
public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()Returns the object with the settings used for calls to createCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateClusterRequest,Operation> |
|
createInstanceOperationSettings()
public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()Returns the object with the settings used for calls to createInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> |
|
createInstanceSettings()
public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()Returns the object with the settings used for calls to createInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstanceRequest,Operation> |
|
createSecondaryClusterOperationSettings()
public OperationCallSettings<CreateSecondaryClusterRequest,Cluster,OperationMetadata> createSecondaryClusterOperationSettings()Returns the object with the settings used for calls to createSecondaryCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSecondaryClusterRequest,Cluster,OperationMetadata> |
|
createSecondaryClusterSettings()
public UnaryCallSettings<CreateSecondaryClusterRequest,Operation> createSecondaryClusterSettings()Returns the object with the settings used for calls to createSecondaryCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSecondaryClusterRequest,Operation> |
|
createSecondaryInstanceOperationSettings()
public OperationCallSettings<CreateSecondaryInstanceRequest,Instance,OperationMetadata> createSecondaryInstanceOperationSettings()Returns the object with the settings used for calls to createSecondaryInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateSecondaryInstanceRequest,Instance,OperationMetadata> |
|
createSecondaryInstanceSettings()
public UnaryCallSettings<CreateSecondaryInstanceRequest,Operation> createSecondaryInstanceSettings()Returns the object with the settings used for calls to createSecondaryInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateSecondaryInstanceRequest,Operation> |
|
createUserSettings()
public UnaryCallSettings<CreateUserRequest,User> createUserSettings()Returns the object with the settings used for calls to createUser.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateUserRequest,User> |
|
deleteBackupOperationSettings()
public OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationSettings()Returns the object with the settings used for calls to deleteBackup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata> |
|
deleteBackupSettings()
public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()Returns the object with the settings used for calls to deleteBackup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteBackupRequest,Operation> |
|
deleteClusterOperationSettings()
public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()Returns the object with the settings used for calls to deleteCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> |
|
deleteClusterSettings()
public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()Returns the object with the settings used for calls to deleteCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteClusterRequest,Operation> |
|
deleteInstanceOperationSettings()
public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()Returns the object with the settings used for calls to deleteInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> |
|
deleteInstanceSettings()
public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()Returns the object with the settings used for calls to deleteInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstanceRequest,Operation> |
|
deleteUserSettings()
public UnaryCallSettings<DeleteUserRequest,Empty> deleteUserSettings()Returns the object with the settings used for calls to deleteUser.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteUserRequest,Empty> |
|
executeSqlSettings()
public UnaryCallSettings<ExecuteSqlRequest,ExecuteSqlResponse> executeSqlSettings()Returns the object with the settings used for calls to executeSql.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ExecuteSqlRequest,ExecuteSqlResponse> |
|
failoverInstanceOperationSettings()
public OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata> failoverInstanceOperationSettings()Returns the object with the settings used for calls to failoverInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata> |
|
failoverInstanceSettings()
public UnaryCallSettings<FailoverInstanceRequest,Operation> failoverInstanceSettings()Returns the object with the settings used for calls to failoverInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<FailoverInstanceRequest,Operation> |
|
generateClientCertificateSettings()
public UnaryCallSettings<GenerateClientCertificateRequest,GenerateClientCertificateResponse> generateClientCertificateSettings()Returns the object with the settings used for calls to generateClientCertificate.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GenerateClientCertificateRequest,GenerateClientCertificateResponse> |
|
getBackupSettings()
public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()Returns the object with the settings used for calls to getBackup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetBackupRequest,Backup> |
|
getClusterSettings()
public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()Returns the object with the settings used for calls to getCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetClusterRequest,Cluster> |
|
getConnectionInfoSettings()
public UnaryCallSettings<GetConnectionInfoRequest,ConnectionInfo> getConnectionInfoSettings()Returns the object with the settings used for calls to getConnectionInfo.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetConnectionInfoRequest,ConnectionInfo> |
|
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceRequest,Instance> |
|
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
getUserSettings()
public UnaryCallSettings<GetUserRequest,User> getUserSettings()Returns the object with the settings used for calls to getUser.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetUserRequest,User> |
|
injectFaultOperationSettings()
public OperationCallSettings<InjectFaultRequest,Instance,OperationMetadata> injectFaultOperationSettings()Returns the object with the settings used for calls to injectFault.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<InjectFaultRequest,Instance,OperationMetadata> |
|
injectFaultSettings()
public UnaryCallSettings<InjectFaultRequest,Operation> injectFaultSettings()Returns the object with the settings used for calls to injectFault.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<InjectFaultRequest,Operation> |
|
listBackupsSettings()
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,AlloyDBAdminClient.ListBackupsPagedResponse> listBackupsSettings()Returns the object with the settings used for calls to listBackups.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse> |
|
listClustersSettings()
public PagedCallSettings<ListClustersRequest,ListClustersResponse,AlloyDBAdminClient.ListClustersPagedResponse> listClustersSettings()Returns the object with the settings used for calls to listClusters.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse> |
|
listDatabasesSettings()
public PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,AlloyDBAdminClient.ListDatabasesPagedResponse> listDatabasesSettings()Returns the object with the settings used for calls to listDatabases.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListDatabasesRequest,ListDatabasesResponse,ListDatabasesPagedResponse> |
|
listInstancesSettings()
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,AlloyDBAdminClient.ListInstancesPagedResponse> listInstancesSettings()Returns the object with the settings used for calls to listInstances.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,AlloyDBAdminClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
|
listSupportedDatabaseFlagsSettings()
public PagedCallSettings<ListSupportedDatabaseFlagsRequest,ListSupportedDatabaseFlagsResponse,AlloyDBAdminClient.ListSupportedDatabaseFlagsPagedResponse> listSupportedDatabaseFlagsSettings()Returns the object with the settings used for calls to listSupportedDatabaseFlags.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListSupportedDatabaseFlagsRequest,ListSupportedDatabaseFlagsResponse,ListSupportedDatabaseFlagsPagedResponse> |
|
listUsersSettings()
public PagedCallSettings<ListUsersRequest,ListUsersResponse,AlloyDBAdminClient.ListUsersPagedResponse> listUsersSettings()Returns the object with the settings used for calls to listUsers.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListUsersRequest,ListUsersResponse,ListUsersPagedResponse> |
|
promoteClusterOperationSettings()
public OperationCallSettings<PromoteClusterRequest,Cluster,OperationMetadata> promoteClusterOperationSettings()Returns the object with the settings used for calls to promoteCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<PromoteClusterRequest,Cluster,OperationMetadata> |
|
promoteClusterSettings()
public UnaryCallSettings<PromoteClusterRequest,Operation> promoteClusterSettings()Returns the object with the settings used for calls to promoteCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PromoteClusterRequest,Operation> |
|
restartInstanceOperationSettings()
public OperationCallSettings<RestartInstanceRequest,Instance,OperationMetadata> restartInstanceOperationSettings()Returns the object with the settings used for calls to restartInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<RestartInstanceRequest,Instance,OperationMetadata> |
|
restartInstanceSettings()
public UnaryCallSettings<RestartInstanceRequest,Operation> restartInstanceSettings()Returns the object with the settings used for calls to restartInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RestartInstanceRequest,Operation> |
|
restoreClusterOperationSettings()
public OperationCallSettings<RestoreClusterRequest,Cluster,OperationMetadata> restoreClusterOperationSettings()Returns the object with the settings used for calls to restoreCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<RestoreClusterRequest,Cluster,OperationMetadata> |
|
restoreClusterSettings()
public UnaryCallSettings<RestoreClusterRequest,Operation> restoreClusterSettings()Returns the object with the settings used for calls to restoreCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RestoreClusterRequest,Operation> |
|
switchoverClusterOperationSettings()
public OperationCallSettings<SwitchoverClusterRequest,Cluster,OperationMetadata> switchoverClusterOperationSettings()Returns the object with the settings used for calls to switchoverCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SwitchoverClusterRequest,Cluster,OperationMetadata> |
|
switchoverClusterSettings()
public UnaryCallSettings<SwitchoverClusterRequest,Operation> switchoverClusterSettings()Returns the object with the settings used for calls to switchoverCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SwitchoverClusterRequest,Operation> |
|
toBuilder()
public AlloyDBAdminSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
AlloyDBAdminSettings.Builder |
|
updateBackupOperationSettings()
public OperationCallSettings<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationSettings()Returns the object with the settings used for calls to updateBackup.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateBackupRequest,Backup,OperationMetadata> |
|
updateBackupSettings()
public UnaryCallSettings<UpdateBackupRequest,Operation> updateBackupSettings()Returns the object with the settings used for calls to updateBackup.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateBackupRequest,Operation> |
|
updateClusterOperationSettings()
public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()Returns the object with the settings used for calls to updateCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> |
|
updateClusterSettings()
public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()Returns the object with the settings used for calls to updateCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateClusterRequest,Operation> |
|
updateInstanceOperationSettings()
public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()Returns the object with the settings used for calls to updateInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> |
|
updateInstanceSettings()
public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()Returns the object with the settings used for calls to updateInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateInstanceRequest,Operation> |
|
updateUserSettings()
public UnaryCallSettings<UpdateUserRequest,User> updateUserSettings()Returns the object with the settings used for calls to updateUser.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateUserRequest,User> |
|
upgradeClusterOperationSettings()
public OperationCallSettings<UpgradeClusterRequest,UpgradeClusterResponse,OperationMetadata> upgradeClusterOperationSettings()Returns the object with the settings used for calls to upgradeCluster.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpgradeClusterRequest,UpgradeClusterResponse,OperationMetadata> |
|
upgradeClusterSettings()
public UnaryCallSettings<UpgradeClusterRequest,Operation> upgradeClusterSettings()Returns the object with the settings used for calls to upgradeCluster.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpgradeClusterRequest,Operation> |
|