- 0.53.0 (latest)
- 0.52.0
- 0.51.0
- 0.50.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.6
- 0.1.0
public class BackupForGKESettings extends ClientSettings<BackupForGKESettings>
Settings class to configure an instance of BackupForGKEClient.
The default instance has everything set to sensible defaults:
- The default service address (gkebackup.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 getBackupPlan:
// 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
BackupForGKESettings.Builder backupForGKESettingsBuilder = BackupForGKESettings.newBuilder();
backupForGKESettingsBuilder
.getBackupPlanSettings()
.setRetrySettings(
backupForGKESettingsBuilder
.getBackupPlanSettings()
.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());
BackupForGKESettings backupForGKESettings = backupForGKESettingsBuilder.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 createBackupPlan:
// 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
BackupForGKESettings.Builder backupForGKESettingsBuilder = BackupForGKESettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
backupForGKESettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(BackupForGKEStubSettings stub)
public static final BackupForGKESettings create(BackupForGKEStubSettings stub)
Parameter | |
---|---|
Name | Description |
stub |
BackupForGKEStubSettings |
Returns | |
---|---|
Type | Description |
BackupForGKESettings |
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 BackupForGKESettings.Builder newBuilder()
Returns a new gRPC builder for this class.
Returns | |
---|---|
Type | Description |
BackupForGKESettings.Builder |
newBuilder(ClientContext clientContext)
public static BackupForGKESettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter | |
---|---|
Name | Description |
clientContext |
ClientContext |
Returns | |
---|---|
Type | Description |
BackupForGKESettings.Builder |
newHttpJsonBuilder()
public static BackupForGKESettings.Builder newHttpJsonBuilder()
Returns a new REST builder for this class.
Returns | |
---|---|
Type | Description |
BackupForGKESettings.Builder |
Constructors
BackupForGKESettings(BackupForGKESettings.Builder settingsBuilder)
protected BackupForGKESettings(BackupForGKESettings.Builder settingsBuilder)
Parameter | |
---|---|
Name | Description |
settingsBuilder |
BackupForGKESettings.Builder |
Methods
createBackupOperationSettings()
public OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationSettings()
Returns the object with the settings used for calls to createBackup.
Returns | |
---|---|
Type | Description |
OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> |
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> |
createBackupSettings()
public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()
Returns the object with the settings used for calls to createBackup.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateBackupRequest,Operation> |
createRestoreOperationSettings()
public OperationCallSettings<CreateRestoreRequest,Restore,OperationMetadata> createRestoreOperationSettings()
Returns the object with the settings used for calls to createRestore.
Returns | |
---|---|
Type | Description |
OperationCallSettings<CreateRestoreRequest,Restore,OperationMetadata> |
createRestorePlanOperationSettings()
public OperationCallSettings<CreateRestorePlanRequest,RestorePlan,OperationMetadata> createRestorePlanOperationSettings()
Returns the object with the settings used for calls to createRestorePlan.
Returns | |
---|---|
Type | Description |
OperationCallSettings<CreateRestorePlanRequest,RestorePlan,OperationMetadata> |
createRestorePlanSettings()
public UnaryCallSettings<CreateRestorePlanRequest,Operation> createRestorePlanSettings()
Returns the object with the settings used for calls to createRestorePlan.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateRestorePlanRequest,Operation> |
createRestoreSettings()
public UnaryCallSettings<CreateRestoreRequest,Operation> createRestoreSettings()
Returns the object with the settings used for calls to createRestore.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<CreateRestoreRequest,Operation> |
deleteBackupOperationSettings()
public OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata> deleteBackupOperationSettings()
Returns the object with the settings used for calls to deleteBackup.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata> |
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> |
deleteRestoreOperationSettings()
public OperationCallSettings<DeleteRestoreRequest,Empty,OperationMetadata> deleteRestoreOperationSettings()
Returns the object with the settings used for calls to deleteRestore.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeleteRestoreRequest,Empty,OperationMetadata> |
deleteRestorePlanOperationSettings()
public OperationCallSettings<DeleteRestorePlanRequest,Empty,OperationMetadata> deleteRestorePlanOperationSettings()
Returns the object with the settings used for calls to deleteRestorePlan.
Returns | |
---|---|
Type | Description |
OperationCallSettings<DeleteRestorePlanRequest,Empty,OperationMetadata> |
deleteRestorePlanSettings()
public UnaryCallSettings<DeleteRestorePlanRequest,Operation> deleteRestorePlanSettings()
Returns the object with the settings used for calls to deleteRestorePlan.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteRestorePlanRequest,Operation> |
deleteRestoreSettings()
public UnaryCallSettings<DeleteRestoreRequest,Operation> deleteRestoreSettings()
Returns the object with the settings used for calls to deleteRestore.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<DeleteRestoreRequest,Operation> |
getBackupIndexDownloadUrlSettings()
public UnaryCallSettings<GetBackupIndexDownloadUrlRequest,GetBackupIndexDownloadUrlResponse> getBackupIndexDownloadUrlSettings()
Returns the object with the settings used for calls to getBackupIndexDownloadUrl.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetBackupIndexDownloadUrlRequest,GetBackupIndexDownloadUrlResponse> |
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> |
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> |
getRestorePlanSettings()
public UnaryCallSettings<GetRestorePlanRequest,RestorePlan> getRestorePlanSettings()
Returns the object with the settings used for calls to getRestorePlan.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetRestorePlanRequest,RestorePlan> |
getRestoreSettings()
public UnaryCallSettings<GetRestoreRequest,Restore> getRestoreSettings()
Returns the object with the settings used for calls to getRestore.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetRestoreRequest,Restore> |
getVolumeBackupSettings()
public UnaryCallSettings<GetVolumeBackupRequest,VolumeBackup> getVolumeBackupSettings()
Returns the object with the settings used for calls to getVolumeBackup.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetVolumeBackupRequest,VolumeBackup> |
getVolumeRestoreSettings()
public UnaryCallSettings<GetVolumeRestoreRequest,VolumeRestore> getVolumeRestoreSettings()
Returns the object with the settings used for calls to getVolumeRestore.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<GetVolumeRestoreRequest,VolumeRestore> |
listBackupPlansSettings()
public PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse,BackupForGKEClient.ListBackupPlansPagedResponse> listBackupPlansSettings()
Returns the object with the settings used for calls to listBackupPlans.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse,ListBackupPlansPagedResponse> |
listBackupsSettings()
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,BackupForGKEClient.ListBackupsPagedResponse> listBackupsSettings()
Returns the object with the settings used for calls to listBackups.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse> |
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,BackupForGKEClient.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> |
listRestorePlansSettings()
public PagedCallSettings<ListRestorePlansRequest,ListRestorePlansResponse,BackupForGKEClient.ListRestorePlansPagedResponse> listRestorePlansSettings()
Returns the object with the settings used for calls to listRestorePlans.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListRestorePlansRequest,ListRestorePlansResponse,ListRestorePlansPagedResponse> |
listRestoresSettings()
public PagedCallSettings<ListRestoresRequest,ListRestoresResponse,BackupForGKEClient.ListRestoresPagedResponse> listRestoresSettings()
Returns the object with the settings used for calls to listRestores.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListRestoresRequest,ListRestoresResponse,ListRestoresPagedResponse> |
listVolumeBackupsSettings()
public PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse,BackupForGKEClient.ListVolumeBackupsPagedResponse> listVolumeBackupsSettings()
Returns the object with the settings used for calls to listVolumeBackups.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse,ListVolumeBackupsPagedResponse> |
listVolumeRestoresSettings()
public PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse,BackupForGKEClient.ListVolumeRestoresPagedResponse> listVolumeRestoresSettings()
Returns the object with the settings used for calls to listVolumeRestores.
Returns | |
---|---|
Type | Description |
PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse,ListVolumeRestoresPagedResponse> |
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 BackupForGKESettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns | |
---|---|
Type | Description |
BackupForGKESettings.Builder |
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> |
updateBackupPlanOperationSettings()
public OperationCallSettings<UpdateBackupPlanRequest,BackupPlan,OperationMetadata> updateBackupPlanOperationSettings()
Returns the object with the settings used for calls to updateBackupPlan.
Returns | |
---|---|
Type | Description |
OperationCallSettings<UpdateBackupPlanRequest,BackupPlan,OperationMetadata> |
updateBackupPlanSettings()
public UnaryCallSettings<UpdateBackupPlanRequest,Operation> updateBackupPlanSettings()
Returns the object with the settings used for calls to updateBackupPlan.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateBackupPlanRequest,Operation> |
updateBackupSettings()
public UnaryCallSettings<UpdateBackupRequest,Operation> updateBackupSettings()
Returns the object with the settings used for calls to updateBackup.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateBackupRequest,Operation> |
updateRestoreOperationSettings()
public OperationCallSettings<UpdateRestoreRequest,Restore,OperationMetadata> updateRestoreOperationSettings()
Returns the object with the settings used for calls to updateRestore.
Returns | |
---|---|
Type | Description |
OperationCallSettings<UpdateRestoreRequest,Restore,OperationMetadata> |
updateRestorePlanOperationSettings()
public OperationCallSettings<UpdateRestorePlanRequest,RestorePlan,OperationMetadata> updateRestorePlanOperationSettings()
Returns the object with the settings used for calls to updateRestorePlan.
Returns | |
---|---|
Type | Description |
OperationCallSettings<UpdateRestorePlanRequest,RestorePlan,OperationMetadata> |
updateRestorePlanSettings()
public UnaryCallSettings<UpdateRestorePlanRequest,Operation> updateRestorePlanSettings()
Returns the object with the settings used for calls to updateRestorePlan.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateRestorePlanRequest,Operation> |
updateRestoreSettings()
public UnaryCallSettings<UpdateRestoreRequest,Operation> updateRestoreSettings()
Returns the object with the settings used for calls to updateRestore.
Returns | |
---|---|
Type | Description |
UnaryCallSettings<UpdateRestoreRequest,Operation> |