Class AlloyDBAdminStubSettings (0.1.0)

public class AlloyDBAdminStubSettings extends StubSettings<AlloyDBAdminStubSettings>

Settings class to configure an instance of AlloyDBAdminStub.

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 total timeout of getCluster 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
 AlloyDBAdminStubSettings.Builder alloyDBAdminSettingsBuilder =
     AlloyDBAdminStubSettings.newBuilder();
 alloyDBAdminSettingsBuilder
     .getClusterSettings()
     .setRetrySettings(
         alloyDBAdminSettingsBuilder
             .getClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AlloyDBAdminStubSettings alloyDBAdminSettings = alloyDBAdminSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > AlloyDBAdminStubSettings

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

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
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

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
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

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 AlloyDBAdminStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static AlloyDBAdminStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns

newHttpJsonBuilder()

public static AlloyDBAdminStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns

Constructors

AlloyDBAdminStubSettings(AlloyDBAdminStubSettings.Builder settingsBuilder)

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

Methods

batchCreateInstancesOperationSettings()

public OperationCallSettings<BatchCreateInstancesRequest,BatchCreateInstancesResponse,OperationMetadata> batchCreateInstancesOperationSettings()

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

Returns

batchCreateInstancesSettings()

public UnaryCallSettings<BatchCreateInstancesRequest,Operation> batchCreateInstancesSettings()

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

Returns

createBackupOperationSettings()

public OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationSettings()

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

Returns

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

Returns

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

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

Returns

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()

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

Returns

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns

createStub()

public AlloyDBAdminStub createStub()
Returns
Type Description
AlloyDBAdminStub
Exceptions
Type Description
IOException

deleteBackupOperationSettings()

public OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationSettings()

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

Returns

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()

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

Returns

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()

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

Returns

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns

deleteInstanceOperationSettings()

public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()

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

Returns

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns

failoverInstanceOperationSettings()

public OperationCallSettings<FailoverInstanceRequest,Instance,OperationMetadata> failoverInstanceOperationSettings()

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

Returns

failoverInstanceSettings()

public UnaryCallSettings<FailoverInstanceRequest,Operation> failoverInstanceSettings()

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

Returns

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns

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>

listBackupsSettings()

public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,AlloyDBAdminClient.ListBackupsPagedResponse> listBackupsSettings()

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

Returns

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,AlloyDBAdminClient.ListClustersPagedResponse> listClustersSettings()

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

Returns

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,AlloyDBAdminClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns

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

restartInstanceOperationSettings()

public OperationCallSettings<RestartInstanceRequest,Instance,OperationMetadata> restartInstanceOperationSettings()

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

Returns

restartInstanceSettings()

public UnaryCallSettings<RestartInstanceRequest,Operation> restartInstanceSettings()

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

Returns

restoreClusterOperationSettings()

public OperationCallSettings<RestoreClusterRequest,Cluster,OperationMetadata> restoreClusterOperationSettings()

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

Returns

restoreClusterSettings()

public UnaryCallSettings<RestoreClusterRequest,Operation> restoreClusterSettings()

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

Returns

toBuilder()

public AlloyDBAdminStubSettings.Builder toBuilder()

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

Returns Overrides

updateBackupOperationSettings()

public OperationCallSettings<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationSettings()

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

Returns

updateBackupSettings()

public UnaryCallSettings<UpdateBackupRequest,Operation> updateBackupSettings()

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

Returns

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

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

Returns

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

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

Returns

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns