Package com.google.cloud.alloydb.v1

Class AlloyDBAdminSettings

  • @Generated("by gapic-generator-java")
public class AlloyDBAdminSettings
extends com.google.api.gax.rpc.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 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
 AlloyDBAdminSettings.Builder alloyDBAdminSettingsBuilder = AlloyDBAdminSettings.newBuilder();
 alloyDBAdminSettingsBuilder
     .getClusterSettings()
     .setRetrySettings(
         alloyDBAdminSettingsBuilder
             .getClusterSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 AlloyDBAdminSettings alloyDBAdminSettings = alloyDBAdminSettingsBuilder.build();

    • Method Detail

      • getClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetClusterRequest,​Cluster> getClusterSettings()
        Returns the object with the settings used for calls to getCluster.

      • createClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateClusterRequest,​com.google.longrunning.Operation> createClusterSettings()
        Returns the object with the settings used for calls to createCluster.

      • createClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateClusterRequest,​Cluster,​OperationMetadata> createClusterOperationSettings()
        Returns the object with the settings used for calls to createCluster.

      • updateClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateClusterRequest,​com.google.longrunning.Operation> updateClusterSettings()
        Returns the object with the settings used for calls to updateCluster.

      • updateClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateClusterRequest,​Cluster,​OperationMetadata> updateClusterOperationSettings()
        Returns the object with the settings used for calls to updateCluster.

      • deleteClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteClusterRequest,​com.google.longrunning.Operation> deleteClusterSettings()
        Returns the object with the settings used for calls to deleteCluster.

      • deleteClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteClusterRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteClusterOperationSettings()
        Returns the object with the settings used for calls to deleteCluster.

      • promoteClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<PromoteClusterRequest,​com.google.longrunning.Operation> promoteClusterSettings()
        Returns the object with the settings used for calls to promoteCluster.

      • promoteClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<PromoteClusterRequest,​Cluster,​OperationMetadata> promoteClusterOperationSettings()
        Returns the object with the settings used for calls to promoteCluster.

      • restoreClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<RestoreClusterRequest,​com.google.longrunning.Operation> restoreClusterSettings()
        Returns the object with the settings used for calls to restoreCluster.

      • restoreClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<RestoreClusterRequest,​Cluster,​OperationMetadata> restoreClusterOperationSettings()
        Returns the object with the settings used for calls to restoreCluster.

      • createSecondaryClusterSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateSecondaryClusterRequest,​com.google.longrunning.Operation> createSecondaryClusterSettings()
        Returns the object with the settings used for calls to createSecondaryCluster.

      • createSecondaryClusterOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateSecondaryClusterRequest,​Cluster,​OperationMetadata> createSecondaryClusterOperationSettings()
        Returns the object with the settings used for calls to createSecondaryCluster.

      • getInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceRequest,​Instance> getInstanceSettings()
        Returns the object with the settings used for calls to getInstance.

      • createInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateInstanceRequest,​com.google.longrunning.Operation> createInstanceSettings()
        Returns the object with the settings used for calls to createInstance.

      • createInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateInstanceRequest,​Instance,​OperationMetadata> createInstanceOperationSettings()
        Returns the object with the settings used for calls to createInstance.

      • createSecondaryInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateSecondaryInstanceRequest,​com.google.longrunning.Operation> createSecondaryInstanceSettings()
        Returns the object with the settings used for calls to createSecondaryInstance.

      • createSecondaryInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateSecondaryInstanceRequest,​Instance,​OperationMetadata> createSecondaryInstanceOperationSettings()
        Returns the object with the settings used for calls to createSecondaryInstance.

      • batchCreateInstancesSettings

        public com.google.api.gax.rpc.UnaryCallSettings<BatchCreateInstancesRequest,​com.google.longrunning.Operation> batchCreateInstancesSettings()
        Returns the object with the settings used for calls to batchCreateInstances.

      • updateInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateInstanceRequest,​com.google.longrunning.Operation> updateInstanceSettings()
        Returns the object with the settings used for calls to updateInstance.

      • updateInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateInstanceRequest,​Instance,​OperationMetadata> updateInstanceOperationSettings()
        Returns the object with the settings used for calls to updateInstance.

      • deleteInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceRequest,​com.google.longrunning.Operation> deleteInstanceSettings()
        Returns the object with the settings used for calls to deleteInstance.

      • deleteInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteInstanceRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteInstanceOperationSettings()
        Returns the object with the settings used for calls to deleteInstance.

      • failoverInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<FailoverInstanceRequest,​com.google.longrunning.Operation> failoverInstanceSettings()
        Returns the object with the settings used for calls to failoverInstance.

      • failoverInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<FailoverInstanceRequest,​Instance,​OperationMetadata> failoverInstanceOperationSettings()
        Returns the object with the settings used for calls to failoverInstance.

      • injectFaultSettings

        public com.google.api.gax.rpc.UnaryCallSettings<InjectFaultRequest,​com.google.longrunning.Operation> injectFaultSettings()
        Returns the object with the settings used for calls to injectFault.

      • injectFaultOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<InjectFaultRequest,​Instance,​OperationMetadata> injectFaultOperationSettings()
        Returns the object with the settings used for calls to injectFault.

      • restartInstanceSettings

        public com.google.api.gax.rpc.UnaryCallSettings<RestartInstanceRequest,​com.google.longrunning.Operation> restartInstanceSettings()
        Returns the object with the settings used for calls to restartInstance.

      • restartInstanceOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<RestartInstanceRequest,​Instance,​OperationMetadata> restartInstanceOperationSettings()
        Returns the object with the settings used for calls to restartInstance.

      • getBackupSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetBackupRequest,​Backup> getBackupSettings()
        Returns the object with the settings used for calls to getBackup.

      • createBackupSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateBackupRequest,​com.google.longrunning.Operation> createBackupSettings()
        Returns the object with the settings used for calls to createBackup.

      • createBackupOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<CreateBackupRequest,​Backup,​OperationMetadata> createBackupOperationSettings()
        Returns the object with the settings used for calls to createBackup.

      • updateBackupSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateBackupRequest,​com.google.longrunning.Operation> updateBackupSettings()
        Returns the object with the settings used for calls to updateBackup.

      • updateBackupOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<UpdateBackupRequest,​Backup,​OperationMetadata> updateBackupOperationSettings()
        Returns the object with the settings used for calls to updateBackup.

      • deleteBackupSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteBackupRequest,​com.google.longrunning.Operation> deleteBackupSettings()
        Returns the object with the settings used for calls to deleteBackup.

      • deleteBackupOperationSettings

        public com.google.api.gax.rpc.OperationCallSettings<DeleteBackupRequest,​com.google.protobuf.Empty,​OperationMetadata> deleteBackupOperationSettings()
        Returns the object with the settings used for calls to deleteBackup.

      • getUserSettings

        public com.google.api.gax.rpc.UnaryCallSettings<GetUserRequest,​User> getUserSettings()
        Returns the object with the settings used for calls to getUser.

      • createUserSettings

        public com.google.api.gax.rpc.UnaryCallSettings<CreateUserRequest,​User> createUserSettings()
        Returns the object with the settings used for calls to createUser.

      • updateUserSettings

        public com.google.api.gax.rpc.UnaryCallSettings<UpdateUserRequest,​User> updateUserSettings()
        Returns the object with the settings used for calls to updateUser.

      • deleteUserSettings

        public com.google.api.gax.rpc.UnaryCallSettings<DeleteUserRequest,​com.google.protobuf.Empty> deleteUserSettings()
        Returns the object with the settings used for calls to deleteUser.

      • listLocationsSettings

        public com.google.api.gax.rpc.PagedCallSettings<com.google.cloud.location.ListLocationsRequest,​com.google.cloud.location.ListLocationsResponse,​AlloyDBAdminClient.ListLocationsPagedResponse> listLocationsSettings()
        Returns the object with the settings used for calls to listLocations.

      • getLocationSettings

        public com.google.api.gax.rpc.UnaryCallSettings<com.google.cloud.location.GetLocationRequest,​com.google.cloud.location.Location> getLocationSettings()
        Returns the object with the settings used for calls to getLocation.

      • defaultExecutorProviderBuilder

        public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
        Returns a builder for the default ExecutorProvider for this service.

      • getDefaultEndpoint

        public static String getDefaultEndpoint()
        Returns the default service endpoint.

      • getDefaultServiceScopes

        public static List<String> getDefaultServiceScopes()
        Returns the default service scopes.

      • defaultCredentialsProviderBuilder

        public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
        Returns a builder for the default credentials for this service.

      • defaultGrpcTransportProviderBuilder

        public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
        Returns a builder for the default gRPC ChannelProvider for this service.

      • defaultHttpJsonTransportProviderBuilder

        @BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
        Returns a builder for the default REST ChannelProvider for this service.

      • defaultTransportChannelProvider

        public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

      • defaultApiClientHeaderProviderBuilder

        @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

      • newBuilder

        public static AlloyDBAdminSettings.Builder newBuilder​(com.google.api.gax.rpc.ClientContext clientContext)
        Returns a new builder for this class.