Class BackupDRSettings (0.14.0) 

public class BackupDRSettings extends ClientSettings<BackupDRSettings>

Settings class to configure an instance of BackupDRClient.

The default instance has everything set to sensible defaults:

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


 // 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
 BackupDRSettings.Builder backupDRSettingsBuilder = BackupDRSettings.newBuilder();
 backupDRSettingsBuilder
     .getManagementServerSettings()
     .setRetrySettings(
         backupDRSettingsBuilder
             .getManagementServerSettings()
             .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());
 BackupDRSettings backupDRSettings = backupDRSettingsBuilder.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 createManagementServer:


 // 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
 BackupDRSettings.Builder backupDRSettingsBuilder = BackupDRSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 backupDRSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > BackupDRSettings

Static Methods

create(BackupDRStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
BackupDRSettings.Builder

newBuilder(ClientContext clientContext)

public static BackupDRSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BackupDRSettings.Builder

newHttpJsonBuilder()

public static BackupDRSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
BackupDRSettings.Builder

Constructors

BackupDRSettings(BackupDRSettings.Builder settingsBuilder)

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

Methods

createBackupPlanAssociationOperationSettings()

public OperationCallSettings<CreateBackupPlanAssociationRequest,BackupPlanAssociation,OperationMetadata> createBackupPlanAssociationOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateBackupPlanAssociationRequest,BackupPlanAssociation,OperationMetadata>

createBackupPlanAssociationSettings()

public UnaryCallSettings<CreateBackupPlanAssociationRequest,Operation> createBackupPlanAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupPlanAssociationRequest,Operation>

createBackupPlanOperationSettings()

public OperationCallSettings<CreateBackupPlanRequest,BackupPlan,OperationMetadata> createBackupPlanOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateBackupPlanRequest,BackupPlan,OperationMetadata>

createBackupPlanSettings()

public UnaryCallSettings<CreateBackupPlanRequest,Operation> createBackupPlanSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupPlanRequest,Operation>

createBackupVaultOperationSettings()

public OperationCallSettings<CreateBackupVaultRequest,BackupVault,OperationMetadata> createBackupVaultOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateBackupVaultRequest,BackupVault,OperationMetadata>

createBackupVaultSettings()

public UnaryCallSettings<CreateBackupVaultRequest,Operation> createBackupVaultSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupVaultRequest,Operation>

createManagementServerOperationSettings()

public OperationCallSettings<CreateManagementServerRequest,ManagementServer,OperationMetadata> createManagementServerOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateManagementServerRequest,ManagementServer,OperationMetadata>

createManagementServerSettings()

public UnaryCallSettings<CreateManagementServerRequest,Operation> createManagementServerSettings()

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

Returns
Type Description
UnaryCallSettings<CreateManagementServerRequest,Operation>

deleteBackupOperationSettings()

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

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

Returns
Type Description
OperationCallSettings<DeleteBackupRequest,Backup,OperationMetadata>

deleteBackupPlanAssociationOperationSettings()

public OperationCallSettings<DeleteBackupPlanAssociationRequest,Empty,OperationMetadata> deleteBackupPlanAssociationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteBackupPlanAssociationRequest,Empty,OperationMetadata>

deleteBackupPlanAssociationSettings()

public UnaryCallSettings<DeleteBackupPlanAssociationRequest,Operation> deleteBackupPlanAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupPlanAssociationRequest,Operation>

deleteBackupPlanOperationSettings()

public OperationCallSettings<DeleteBackupPlanRequest,Empty,OperationMetadata> deleteBackupPlanOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteBackupPlanRequest,Empty,OperationMetadata>

deleteBackupPlanSettings()

public UnaryCallSettings<DeleteBackupPlanRequest,Operation> deleteBackupPlanSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupPlanRequest,Operation>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupRequest,Operation>

deleteBackupVaultOperationSettings()

public OperationCallSettings<DeleteBackupVaultRequest,Empty,OperationMetadata> deleteBackupVaultOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteBackupVaultRequest,Empty,OperationMetadata>

deleteBackupVaultSettings()

public UnaryCallSettings<DeleteBackupVaultRequest,Operation> deleteBackupVaultSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupVaultRequest,Operation>

deleteManagementServerOperationSettings()

public OperationCallSettings<DeleteManagementServerRequest,Empty,OperationMetadata> deleteManagementServerOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteManagementServerRequest,Empty,OperationMetadata>

deleteManagementServerSettings()

public UnaryCallSettings<DeleteManagementServerRequest,Operation> deleteManagementServerSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteManagementServerRequest,Operation>

fetchUsableBackupVaultsSettings()

public PagedCallSettings<FetchUsableBackupVaultsRequest,FetchUsableBackupVaultsResponse,BackupDRClient.FetchUsableBackupVaultsPagedResponse> fetchUsableBackupVaultsSettings()

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

Returns
Type Description
PagedCallSettings<FetchUsableBackupVaultsRequest,FetchUsableBackupVaultsResponse,FetchUsableBackupVaultsPagedResponse>

getBackupPlanAssociationSettings()

public UnaryCallSettings<GetBackupPlanAssociationRequest,BackupPlanAssociation> getBackupPlanAssociationSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupPlanAssociationRequest,BackupPlanAssociation>

getBackupPlanSettings()

public UnaryCallSettings<GetBackupPlanRequest,BackupPlan> getBackupPlanSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupPlanRequest,BackupPlan>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupRequest,Backup>

getBackupVaultSettings()

public UnaryCallSettings<GetBackupVaultRequest,BackupVault> getBackupVaultSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupVaultRequest,BackupVault>

getDataSourceSettings()

public UnaryCallSettings<GetDataSourceRequest,DataSource> getDataSourceSettings()

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

Returns
Type Description
UnaryCallSettings<GetDataSourceRequest,DataSource>

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>

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>

getManagementServerSettings()

public UnaryCallSettings<GetManagementServerRequest,ManagementServer> getManagementServerSettings()

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

Returns
Type Description
UnaryCallSettings<GetManagementServerRequest,ManagementServer>

listBackupPlanAssociationsSettings()

public PagedCallSettings<ListBackupPlanAssociationsRequest,ListBackupPlanAssociationsResponse,BackupDRClient.ListBackupPlanAssociationsPagedResponse> listBackupPlanAssociationsSettings()

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

Returns
Type Description
PagedCallSettings<ListBackupPlanAssociationsRequest,ListBackupPlanAssociationsResponse,ListBackupPlanAssociationsPagedResponse>

listBackupPlansSettings()

public PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse,BackupDRClient.ListBackupPlansPagedResponse> listBackupPlansSettings()

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

Returns
Type Description
PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse,ListBackupPlansPagedResponse>

listBackupVaultsSettings()

public PagedCallSettings<ListBackupVaultsRequest,ListBackupVaultsResponse,BackupDRClient.ListBackupVaultsPagedResponse> listBackupVaultsSettings()

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

Returns
Type Description
PagedCallSettings<ListBackupVaultsRequest,ListBackupVaultsResponse,ListBackupVaultsPagedResponse>

listBackupsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listDataSourcesSettings()

public PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,BackupDRClient.ListDataSourcesPagedResponse> listDataSourcesSettings()

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

Returns
Type Description
PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse,ListDataSourcesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,BackupDRClient.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>

listManagementServersSettings()

public PagedCallSettings<ListManagementServersRequest,ListManagementServersResponse,BackupDRClient.ListManagementServersPagedResponse> listManagementServersSettings()

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

Returns
Type Description
PagedCallSettings<ListManagementServersRequest,ListManagementServersResponse,ListManagementServersPagedResponse>

restoreBackupOperationSettings()

public OperationCallSettings<RestoreBackupRequest,RestoreBackupResponse,OperationMetadata> restoreBackupOperationSettings()

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

Returns
Type Description
OperationCallSettings<RestoreBackupRequest,RestoreBackupResponse,OperationMetadata>

restoreBackupSettings()

public UnaryCallSettings<RestoreBackupRequest,Operation> restoreBackupSettings()

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

Returns
Type Description
UnaryCallSettings<RestoreBackupRequest,Operation>

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>

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 BackupDRSettings.Builder toBuilder()

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

Returns
Type Description
BackupDRSettings.Builder
Overrides

triggerBackupOperationSettings()

public OperationCallSettings<TriggerBackupRequest,BackupPlanAssociation,OperationMetadata> triggerBackupOperationSettings()

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

Returns
Type Description
OperationCallSettings<TriggerBackupRequest,BackupPlanAssociation,OperationMetadata>

triggerBackupSettings()

public UnaryCallSettings<TriggerBackupRequest,Operation> triggerBackupSettings()

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

Returns
Type Description
UnaryCallSettings<TriggerBackupRequest,Operation>

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>

updateBackupVaultOperationSettings()

public OperationCallSettings<UpdateBackupVaultRequest,BackupVault,OperationMetadata> updateBackupVaultOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateBackupVaultRequest,BackupVault,OperationMetadata>

updateBackupVaultSettings()

public UnaryCallSettings<UpdateBackupVaultRequest,Operation> updateBackupVaultSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateBackupVaultRequest,Operation>

updateDataSourceOperationSettings()

public OperationCallSettings<UpdateDataSourceRequest,DataSource,OperationMetadata> updateDataSourceOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateDataSourceRequest,DataSource,OperationMetadata>

updateDataSourceSettings()

public UnaryCallSettings<UpdateDataSourceRequest,Operation> updateDataSourceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateDataSourceRequest,Operation>