Class BackupDRStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<BackupDRStubSettings>
com.google.cloud.backupdr.v1.stub.BackupDRStubSettings
@Generated("by gapic-generator-java")
public class BackupDRStubSettings
extends StubSettings<BackupDRStubSettings>
Settings class to configure an instance of
BackupDRStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
BackupDRStubSettings.Builder backupDRSettingsBuilder = BackupDRStubSettings.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());
BackupDRStubSettings backupDRSettings = backupDRSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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
BackupDRStubSettings.Builder backupDRSettingsBuilder = BackupDRStubSettings.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();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for BackupDRStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBackupDRStubSettings(BackupDRStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createBackupPlanAssociation.Returns the object with the settings used for calls to createBackupPlanAssociation.Returns the object with the settings used for calls to createBackupPlan.Returns the object with the settings used for calls to createBackupPlan.Returns the object with the settings used for calls to createBackupVault.Returns the object with the settings used for calls to createBackupVault.Returns the object with the settings used for calls to createManagementServer.Returns the object with the settings used for calls to createManagementServer.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderReturns the object with the settings used for calls to deleteBackup.OperationCallSettings<DeleteBackupPlanAssociationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackupPlanAssociation.Returns the object with the settings used for calls to deleteBackupPlanAssociation.OperationCallSettings<DeleteBackupPlanRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackupPlan.Returns the object with the settings used for calls to deleteBackupPlan.Returns the object with the settings used for calls to deleteBackup.OperationCallSettings<DeleteBackupVaultRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackupVault.Returns the object with the settings used for calls to deleteBackupVault.OperationCallSettings<DeleteManagementServerRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteManagementServer.Returns the object with the settings used for calls to deleteManagementServer.PagedCallSettings<FetchBackupPlanAssociationsForResourceTypeRequest,FetchBackupPlanAssociationsForResourceTypeResponse, BackupDRClient.FetchBackupPlanAssociationsForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchBackupPlanAssociationsForResourceType.PagedCallSettings<FetchBackupsForResourceTypeRequest,FetchBackupsForResourceTypeResponse, BackupDRClient.FetchBackupsForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchBackupsForResourceType.PagedCallSettings<FetchDataSourceReferencesForResourceTypeRequest,FetchDataSourceReferencesForResourceTypeResponse, BackupDRClient.FetchDataSourceReferencesForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchDataSourceReferencesForResourceType.PagedCallSettings<FetchUsableBackupVaultsRequest,FetchUsableBackupVaultsResponse, BackupDRClient.FetchUsableBackupVaultsPagedResponse> Returns the object with the settings used for calls to fetchUsableBackupVaults.Returns the object with the settings used for calls to getBackupPlanAssociation.Returns the object with the settings used for calls to getBackupPlanRevision.Returns the object with the settings used for calls to getBackupPlan.Returns the object with the settings used for calls to getBackup.Returns the object with the settings used for calls to getBackupVault.Returns the object with the settings used for calls to getDataSourceReference.Returns the object with the settings used for calls to getDataSource.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getManagementServer.Returns the default service name.Returns the object with the settings used for calls to initializeService.Returns the object with the settings used for calls to initializeService.PagedCallSettings<ListBackupPlanAssociationsRequest,ListBackupPlanAssociationsResponse, BackupDRClient.ListBackupPlanAssociationsPagedResponse> Returns the object with the settings used for calls to listBackupPlanAssociations.PagedCallSettings<ListBackupPlanRevisionsRequest,ListBackupPlanRevisionsResponse, BackupDRClient.ListBackupPlanRevisionsPagedResponse> Returns the object with the settings used for calls to listBackupPlanRevisions.PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse, BackupDRClient.ListBackupPlansPagedResponse> Returns the object with the settings used for calls to listBackupPlans.Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListBackupVaultsRequest,ListBackupVaultsResponse, BackupDRClient.ListBackupVaultsPagedResponse> Returns the object with the settings used for calls to listBackupVaults.PagedCallSettings<ListDataSourceReferencesRequest,ListDataSourceReferencesResponse, BackupDRClient.ListDataSourceReferencesPagedResponse> Returns the object with the settings used for calls to listDataSourceReferences.PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse, BackupDRClient.ListDataSourcesPagedResponse> Returns the object with the settings used for calls to listDataSources.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, BackupDRClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListManagementServersRequest,ListManagementServersResponse, BackupDRClient.ListManagementServersPagedResponse> Returns the object with the settings used for calls to listManagementServers.static BackupDRStubSettings.BuilderReturns a new gRPC builder for this class.static BackupDRStubSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static BackupDRStubSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to restoreBackup.Returns the object with the settings used for calls to restoreBackup.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to triggerBackup.Returns the object with the settings used for calls to triggerBackup.Returns the object with the settings used for calls to updateBackup.Returns the object with the settings used for calls to updateBackupPlanAssociation.Returns the object with the settings used for calls to updateBackupPlanAssociation.Returns the object with the settings used for calls to updateBackupPlan.Returns the object with the settings used for calls to updateBackupPlan.Returns the object with the settings used for calls to updateBackup.Returns the object with the settings used for calls to updateBackupVault.Returns the object with the settings used for calls to updateBackupVault.Returns the object with the settings used for calls to updateDataSource.Returns the object with the settings used for calls to updateDataSource.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
BackupDRStubSettings
- Throws:
IOException
-
-
Method Details
-
listManagementServersSettings
public PagedCallSettings<ListManagementServersRequest,ListManagementServersResponse, listManagementServersSettings()BackupDRClient.ListManagementServersPagedResponse> Returns the object with the settings used for calls to listManagementServers. -
getManagementServerSettings
Returns the object with the settings used for calls to getManagementServer. -
createManagementServerSettings
Returns the object with the settings used for calls to createManagementServer. -
createManagementServerOperationSettings
public OperationCallSettings<CreateManagementServerRequest,ManagementServer, createManagementServerOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createManagementServer. -
deleteManagementServerSettings
Returns the object with the settings used for calls to deleteManagementServer. -
deleteManagementServerOperationSettings
public OperationCallSettings<DeleteManagementServerRequest,com.google.protobuf.Empty, deleteManagementServerOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteManagementServer. -
createBackupVaultSettings
Returns the object with the settings used for calls to createBackupVault. -
createBackupVaultOperationSettings
public OperationCallSettings<CreateBackupVaultRequest,BackupVault, createBackupVaultOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createBackupVault. -
listBackupVaultsSettings
public PagedCallSettings<ListBackupVaultsRequest,ListBackupVaultsResponse, listBackupVaultsSettings()BackupDRClient.ListBackupVaultsPagedResponse> Returns the object with the settings used for calls to listBackupVaults. -
fetchUsableBackupVaultsSettings
public PagedCallSettings<FetchUsableBackupVaultsRequest,FetchUsableBackupVaultsResponse, fetchUsableBackupVaultsSettings()BackupDRClient.FetchUsableBackupVaultsPagedResponse> Returns the object with the settings used for calls to fetchUsableBackupVaults. -
getBackupVaultSettings
Returns the object with the settings used for calls to getBackupVault. -
updateBackupVaultSettings
Returns the object with the settings used for calls to updateBackupVault. -
updateBackupVaultOperationSettings
public OperationCallSettings<UpdateBackupVaultRequest,BackupVault, updateBackupVaultOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateBackupVault. -
deleteBackupVaultSettings
Returns the object with the settings used for calls to deleteBackupVault. -
deleteBackupVaultOperationSettings
public OperationCallSettings<DeleteBackupVaultRequest,com.google.protobuf.Empty, deleteBackupVaultOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackupVault. -
listDataSourcesSettings
public PagedCallSettings<ListDataSourcesRequest,ListDataSourcesResponse, listDataSourcesSettings()BackupDRClient.ListDataSourcesPagedResponse> Returns the object with the settings used for calls to listDataSources. -
getDataSourceSettings
Returns the object with the settings used for calls to getDataSource. -
updateDataSourceSettings
Returns the object with the settings used for calls to updateDataSource. -
updateDataSourceOperationSettings
public OperationCallSettings<UpdateDataSourceRequest,DataSource, updateDataSourceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDataSource. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()BackupDRClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
fetchBackupsForResourceTypeSettings
public PagedCallSettings<FetchBackupsForResourceTypeRequest,FetchBackupsForResourceTypeResponse, fetchBackupsForResourceTypeSettings()BackupDRClient.FetchBackupsForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchBackupsForResourceType. -
getBackupSettings
Returns the object with the settings used for calls to getBackup. -
updateBackupSettings
Returns the object with the settings used for calls to updateBackup. -
updateBackupOperationSettings
public OperationCallSettings<UpdateBackupRequest,Backup, updateBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateBackup. -
deleteBackupSettings
Returns the object with the settings used for calls to deleteBackup. -
deleteBackupOperationSettings
public OperationCallSettings<DeleteBackupRequest,Backup, deleteBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackup. -
restoreBackupSettings
Returns the object with the settings used for calls to restoreBackup. -
restoreBackupOperationSettings
public OperationCallSettings<RestoreBackupRequest,RestoreBackupResponse, restoreBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to restoreBackup. -
createBackupPlanSettings
Returns the object with the settings used for calls to createBackupPlan. -
createBackupPlanOperationSettings
public OperationCallSettings<CreateBackupPlanRequest,BackupPlan, createBackupPlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createBackupPlan. -
updateBackupPlanSettings
Returns the object with the settings used for calls to updateBackupPlan. -
updateBackupPlanOperationSettings
public OperationCallSettings<UpdateBackupPlanRequest,BackupPlan, updateBackupPlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateBackupPlan. -
getBackupPlanSettings
Returns the object with the settings used for calls to getBackupPlan. -
listBackupPlansSettings
public PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse, listBackupPlansSettings()BackupDRClient.ListBackupPlansPagedResponse> Returns the object with the settings used for calls to listBackupPlans. -
deleteBackupPlanSettings
Returns the object with the settings used for calls to deleteBackupPlan. -
deleteBackupPlanOperationSettings
public OperationCallSettings<DeleteBackupPlanRequest,com.google.protobuf.Empty, deleteBackupPlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackupPlan. -
getBackupPlanRevisionSettings
public UnaryCallSettings<GetBackupPlanRevisionRequest,BackupPlanRevision> getBackupPlanRevisionSettings()Returns the object with the settings used for calls to getBackupPlanRevision. -
listBackupPlanRevisionsSettings
public PagedCallSettings<ListBackupPlanRevisionsRequest,ListBackupPlanRevisionsResponse, listBackupPlanRevisionsSettings()BackupDRClient.ListBackupPlanRevisionsPagedResponse> Returns the object with the settings used for calls to listBackupPlanRevisions. -
createBackupPlanAssociationSettings
public UnaryCallSettings<CreateBackupPlanAssociationRequest,Operation> createBackupPlanAssociationSettings()Returns the object with the settings used for calls to createBackupPlanAssociation. -
createBackupPlanAssociationOperationSettings
public OperationCallSettings<CreateBackupPlanAssociationRequest,BackupPlanAssociation, createBackupPlanAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createBackupPlanAssociation. -
updateBackupPlanAssociationSettings
public UnaryCallSettings<UpdateBackupPlanAssociationRequest,Operation> updateBackupPlanAssociationSettings()Returns the object with the settings used for calls to updateBackupPlanAssociation. -
updateBackupPlanAssociationOperationSettings
public OperationCallSettings<UpdateBackupPlanAssociationRequest,BackupPlanAssociation, updateBackupPlanAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateBackupPlanAssociation. -
getBackupPlanAssociationSettings
public UnaryCallSettings<GetBackupPlanAssociationRequest,BackupPlanAssociation> getBackupPlanAssociationSettings()Returns the object with the settings used for calls to getBackupPlanAssociation. -
listBackupPlanAssociationsSettings
public PagedCallSettings<ListBackupPlanAssociationsRequest,ListBackupPlanAssociationsResponse, listBackupPlanAssociationsSettings()BackupDRClient.ListBackupPlanAssociationsPagedResponse> Returns the object with the settings used for calls to listBackupPlanAssociations. -
fetchBackupPlanAssociationsForResourceTypeSettings
public PagedCallSettings<FetchBackupPlanAssociationsForResourceTypeRequest,FetchBackupPlanAssociationsForResourceTypeResponse, fetchBackupPlanAssociationsForResourceTypeSettings()BackupDRClient.FetchBackupPlanAssociationsForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchBackupPlanAssociationsForResourceType. -
deleteBackupPlanAssociationSettings
public UnaryCallSettings<DeleteBackupPlanAssociationRequest,Operation> deleteBackupPlanAssociationSettings()Returns the object with the settings used for calls to deleteBackupPlanAssociation. -
deleteBackupPlanAssociationOperationSettings
public OperationCallSettings<DeleteBackupPlanAssociationRequest,com.google.protobuf.Empty, deleteBackupPlanAssociationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackupPlanAssociation. -
triggerBackupSettings
Returns the object with the settings used for calls to triggerBackup. -
triggerBackupOperationSettings
public OperationCallSettings<TriggerBackupRequest,BackupPlanAssociation, triggerBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to triggerBackup. -
getDataSourceReferenceSettings
public UnaryCallSettings<GetDataSourceReferenceRequest,DataSourceReference> getDataSourceReferenceSettings()Returns the object with the settings used for calls to getDataSourceReference. -
listDataSourceReferencesSettings
public PagedCallSettings<ListDataSourceReferencesRequest,ListDataSourceReferencesResponse, listDataSourceReferencesSettings()BackupDRClient.ListDataSourceReferencesPagedResponse> Returns the object with the settings used for calls to listDataSourceReferences. -
fetchDataSourceReferencesForResourceTypeSettings
public PagedCallSettings<FetchDataSourceReferencesForResourceTypeRequest,FetchDataSourceReferencesForResourceTypeResponse, fetchDataSourceReferencesForResourceTypeSettings()BackupDRClient.FetchDataSourceReferencesForResourceTypePagedResponse> Returns the object with the settings used for calls to fetchDataSourceReferencesForResourceType. -
initializeServiceSettings
Returns the object with the settings used for calls to initializeService. -
initializeServiceOperationSettings
public OperationCallSettings<InitializeServiceRequest,InitializeServiceResponse, initializeServiceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to initializeService. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()BackupDRClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<BackupDRStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classStubSettings<BackupDRStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<BackupDRStubSettings>
-