Class SqlInstancesServiceSettings (0.1.0) 

public class SqlInstancesServiceSettings extends ClientSettings<SqlInstancesServiceSettings>

Settings class to configure an instance of SqlInstancesServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (sqladmin.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 addServerCa:


 // 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
 SqlInstancesServiceSettings.Builder sqlInstancesServiceSettingsBuilder =
     SqlInstancesServiceSettings.newBuilder();
 sqlInstancesServiceSettingsBuilder
     .addServerCaSettings()
     .setRetrySettings(
         sqlInstancesServiceSettingsBuilder
             .addServerCaSettings()
             .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());
 SqlInstancesServiceSettings sqlInstancesServiceSettings =
     sqlInstancesServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > SqlInstancesServiceSettings

Static Methods

create(SqlInstancesServiceStubSettings stub)

public static final SqlInstancesServiceSettings create(SqlInstancesServiceStubSettings stub)
Parameter
Name Description
stub SqlInstancesServiceStubSettings
Returns
Type Description
SqlInstancesServiceSettings
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 SqlInstancesServiceSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
SqlInstancesServiceSettings.Builder

newBuilder(@Nullable ClientContext clientContext)

public static SqlInstancesServiceSettings.Builder newBuilder(@Nullable ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext @org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext
Returns
Type Description
SqlInstancesServiceSettings.Builder

newHttpJsonBuilder()

public static SqlInstancesServiceSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
SqlInstancesServiceSettings.Builder

Constructors

SqlInstancesServiceSettings(SqlInstancesServiceSettings.Builder settingsBuilder)

protected SqlInstancesServiceSettings(SqlInstancesServiceSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder SqlInstancesServiceSettings.Builder

Methods

acquireSsrsLeaseSettings()

public UnaryCallSettings<SqlInstancesAcquireSsrsLeaseRequest,SqlInstancesAcquireSsrsLeaseResponse> acquireSsrsLeaseSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesAcquireSsrsLeaseRequest,SqlInstancesAcquireSsrsLeaseResponse>

addEntraIdCertificateSettings()

public UnaryCallSettings<SqlInstancesAddEntraIdCertificateRequest,Operation> addEntraIdCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesAddEntraIdCertificateRequest,Operation>

addServerCaSettings()

public UnaryCallSettings<SqlInstancesAddServerCaRequest,Operation> addServerCaSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesAddServerCaRequest,Operation>

addServerCertificateSettings()

public UnaryCallSettings<SqlInstancesAddServerCertificateRequest,Operation> addServerCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesAddServerCertificateRequest,Operation>

cloneSettings()

public UnaryCallSettings<SqlInstancesCloneRequest,Operation> cloneSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesCloneRequest,Operation>

createEphemeralSettings()

public UnaryCallSettings<SqlInstancesCreateEphemeralCertRequest,SslCert> createEphemeralSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesCreateEphemeralCertRequest,SslCert>

deleteSettings()

public UnaryCallSettings<SqlInstancesDeleteRequest,Operation> deleteSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesDeleteRequest,Operation>

demoteMasterSettings()

public UnaryCallSettings<SqlInstancesDemoteMasterRequest,Operation> demoteMasterSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesDemoteMasterRequest,Operation>

demoteSettings()

public UnaryCallSettings<SqlInstancesDemoteRequest,Operation> demoteSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesDemoteRequest,Operation>

executeSqlSettings()

public UnaryCallSettings<SqlInstancesExecuteSqlRequest,SqlInstancesExecuteSqlResponse> executeSqlSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesExecuteSqlRequest,SqlInstancesExecuteSqlResponse>

exportSettings()

public UnaryCallSettings<SqlInstancesExportRequest,Operation> exportSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesExportRequest,Operation>

failoverSettings()

public UnaryCallSettings<SqlInstancesFailoverRequest,Operation> failoverSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesFailoverRequest,Operation>

getDiskShrinkConfigSettings()

public UnaryCallSettings<SqlInstancesGetDiskShrinkConfigRequest,SqlInstancesGetDiskShrinkConfigResponse> getDiskShrinkConfigSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesGetDiskShrinkConfigRequest,SqlInstancesGetDiskShrinkConfigResponse>

getLatestRecoveryTimeSettings()

public UnaryCallSettings<SqlInstancesGetLatestRecoveryTimeRequest,SqlInstancesGetLatestRecoveryTimeResponse> getLatestRecoveryTimeSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesGetLatestRecoveryTimeRequest,SqlInstancesGetLatestRecoveryTimeResponse>

getSettings()

public UnaryCallSettings<SqlInstancesGetRequest,DatabaseInstance> getSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesGetRequest,DatabaseInstance>

import_Settings()

public UnaryCallSettings<SqlInstancesImportRequest,Operation> import_Settings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesImportRequest,Operation>

insertSettings()

public UnaryCallSettings<SqlInstancesInsertRequest,Operation> insertSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesInsertRequest,Operation>

listEntraIdCertificatesSettings()

public UnaryCallSettings<SqlInstancesListEntraIdCertificatesRequest,InstancesListEntraIdCertificatesResponse> listEntraIdCertificatesSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesListEntraIdCertificatesRequest,InstancesListEntraIdCertificatesResponse>

listServerCasSettings()

public UnaryCallSettings<SqlInstancesListServerCasRequest,InstancesListServerCasResponse> listServerCasSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesListServerCasRequest,InstancesListServerCasResponse>

listServerCertificatesSettings()

public UnaryCallSettings<SqlInstancesListServerCertificatesRequest,InstancesListServerCertificatesResponse> listServerCertificatesSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesListServerCertificatesRequest,InstancesListServerCertificatesResponse>

listSettings()

public UnaryCallSettings<SqlInstancesListRequest,InstancesListResponse> listSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesListRequest,InstancesListResponse>

patchSettings()

public UnaryCallSettings<SqlInstancesPatchRequest,Operation> patchSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesPatchRequest,Operation>

performDiskShrinkSettings()

public UnaryCallSettings<SqlInstancesPerformDiskShrinkRequest,Operation> performDiskShrinkSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesPerformDiskShrinkRequest,Operation>

pointInTimeRestoreSettings()

public UnaryCallSettings<SqlInstancesPointInTimeRestoreRequest,Operation> pointInTimeRestoreSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesPointInTimeRestoreRequest,Operation>

preCheckMajorVersionUpgradeSettings()

public UnaryCallSettings<SqlInstancesPreCheckMajorVersionUpgradeRequest,Operation> preCheckMajorVersionUpgradeSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesPreCheckMajorVersionUpgradeRequest,Operation>

promoteReplicaSettings()

public UnaryCallSettings<SqlInstancesPromoteReplicaRequest,Operation> promoteReplicaSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesPromoteReplicaRequest,Operation>

reencryptSettings()

public UnaryCallSettings<SqlInstancesReencryptRequest,Operation> reencryptSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesReencryptRequest,Operation>

releaseSsrsLeaseSettings()

public UnaryCallSettings<SqlInstancesReleaseSsrsLeaseRequest,SqlInstancesReleaseSsrsLeaseResponse> releaseSsrsLeaseSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesReleaseSsrsLeaseRequest,SqlInstancesReleaseSsrsLeaseResponse>

rescheduleMaintenanceSettings()

public UnaryCallSettings<SqlInstancesRescheduleMaintenanceRequest,Operation> rescheduleMaintenanceSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRescheduleMaintenanceRequest,Operation>

resetReplicaSizeSettings()

public UnaryCallSettings<SqlInstancesResetReplicaSizeRequest,Operation> resetReplicaSizeSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesResetReplicaSizeRequest,Operation>

resetSslConfigSettings()

public UnaryCallSettings<SqlInstancesResetSslConfigRequest,Operation> resetSslConfigSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesResetSslConfigRequest,Operation>

restartSettings()

public UnaryCallSettings<SqlInstancesRestartRequest,Operation> restartSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRestartRequest,Operation>

restoreBackupSettings()

public UnaryCallSettings<SqlInstancesRestoreBackupRequest,Operation> restoreBackupSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRestoreBackupRequest,Operation>

rotateEntraIdCertificateSettings()

public UnaryCallSettings<SqlInstancesRotateEntraIdCertificateRequest,Operation> rotateEntraIdCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRotateEntraIdCertificateRequest,Operation>

rotateServerCaSettings()

public UnaryCallSettings<SqlInstancesRotateServerCaRequest,Operation> rotateServerCaSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRotateServerCaRequest,Operation>

rotateServerCertificateSettings()

public UnaryCallSettings<SqlInstancesRotateServerCertificateRequest,Operation> rotateServerCertificateSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesRotateServerCertificateRequest,Operation>

startExternalSyncSettings()

public UnaryCallSettings<SqlInstancesStartExternalSyncRequest,Operation> startExternalSyncSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesStartExternalSyncRequest,Operation>

startReplicaSettings()

public UnaryCallSettings<SqlInstancesStartReplicaRequest,Operation> startReplicaSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesStartReplicaRequest,Operation>

stopReplicaSettings()

public UnaryCallSettings<SqlInstancesStopReplicaRequest,Operation> stopReplicaSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesStopReplicaRequest,Operation>

switchoverSettings()

public UnaryCallSettings<SqlInstancesSwitchoverRequest,Operation> switchoverSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesSwitchoverRequest,Operation>

toBuilder()

public SqlInstancesServiceSettings.Builder toBuilder()

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

Returns
Type Description
SqlInstancesServiceSettings.Builder
Overrides

truncateLogSettings()

public UnaryCallSettings<SqlInstancesTruncateLogRequest,Operation> truncateLogSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesTruncateLogRequest,Operation>

updateSettings()

public UnaryCallSettings<SqlInstancesUpdateRequest,Operation> updateSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesUpdateRequest,Operation>

verifyExternalSyncSettingsSettings()

public UnaryCallSettings<SqlInstancesVerifyExternalSyncSettingsRequest,SqlInstancesVerifyExternalSyncSettingsResponse> verifyExternalSyncSettingsSettings()

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

Returns
Type Description
UnaryCallSettings<SqlInstancesVerifyExternalSyncSettingsRequest,SqlInstancesVerifyExternalSyncSettingsResponse>