Class BackupForGKEStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<BackupForGKEStubSettings>
com.google.cloud.gkebackup.v1.stub.BackupForGKEStubSettings
@Generated("by gapic-generator-java")
public class BackupForGKEStubSettings
extends StubSettings<BackupForGKEStubSettings>
Settings class to configure an instance of
BackupForGKEStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
BackupForGKEStubSettings.Builder backupForGKESettingsBuilder =
BackupForGKEStubSettings.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());
BackupForGKEStubSettings backupForGKESettings = backupForGKESettingsBuilder.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 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
BackupForGKEStubSettings.Builder backupForGKESettingsBuilder =
BackupForGKEStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
backupForGKESettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for BackupForGKEStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedBackupForGKEStubSettings(BackupForGKEStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createBackupChannel.Returns the object with the settings used for calls to createBackupChannel.Returns the object with the settings used for calls to createBackup.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 createBackup.Returns the object with the settings used for calls to createRestoreChannel.Returns the object with the settings used for calls to createRestoreChannel.Returns the object with the settings used for calls to createRestore.Returns the object with the settings used for calls to createRestorePlan.Returns the object with the settings used for calls to createRestorePlan.Returns the object with the settings used for calls to createRestore.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 TransportChannelProviderOperationCallSettings<DeleteBackupChannelRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackupChannel.Returns the object with the settings used for calls to deleteBackupChannel.OperationCallSettings<DeleteBackupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackup.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<DeleteRestoreChannelRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRestoreChannel.Returns the object with the settings used for calls to deleteRestoreChannel.OperationCallSettings<DeleteRestoreRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRestore.OperationCallSettings<DeleteRestorePlanRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteRestorePlan.Returns the object with the settings used for calls to deleteRestorePlan.Returns the object with the settings used for calls to deleteRestore.Returns the object with the settings used for calls to getBackupChannel.Returns the object with the settings used for calls to getBackupIndexDownloadUrl.Returns the object with the settings used for calls to getBackupPlanBinding.Returns the object with the settings used for calls to getBackupPlan.Returns the object with the settings used for calls to getBackup.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 getRestoreChannel.Returns the object with the settings used for calls to getRestorePlanBinding.Returns the object with the settings used for calls to getRestorePlan.Returns the object with the settings used for calls to getRestore.Returns the default service name.Returns the object with the settings used for calls to getVolumeBackup.Returns the object with the settings used for calls to getVolumeRestore.PagedCallSettings<ListBackupChannelsRequest,ListBackupChannelsResponse, BackupForGKEClient.ListBackupChannelsPagedResponse> Returns the object with the settings used for calls to listBackupChannels.PagedCallSettings<ListBackupPlanBindingsRequest,ListBackupPlanBindingsResponse, BackupForGKEClient.ListBackupPlanBindingsPagedResponse> Returns the object with the settings used for calls to listBackupPlanBindings.PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse, BackupForGKEClient.ListBackupPlansPagedResponse> Returns the object with the settings used for calls to listBackupPlans.PagedCallSettings<ListBackupsRequest,ListBackupsResponse, BackupForGKEClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, BackupForGKEClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListRestoreChannelsRequest,ListRestoreChannelsResponse, BackupForGKEClient.ListRestoreChannelsPagedResponse> Returns the object with the settings used for calls to listRestoreChannels.PagedCallSettings<ListRestorePlanBindingsRequest,ListRestorePlanBindingsResponse, BackupForGKEClient.ListRestorePlanBindingsPagedResponse> Returns the object with the settings used for calls to listRestorePlanBindings.PagedCallSettings<ListRestorePlansRequest,ListRestorePlansResponse, BackupForGKEClient.ListRestorePlansPagedResponse> Returns the object with the settings used for calls to listRestorePlans.PagedCallSettings<ListRestoresRequest,ListRestoresResponse, BackupForGKEClient.ListRestoresPagedResponse> Returns the object with the settings used for calls to listRestores.PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse, BackupForGKEClient.ListVolumeBackupsPagedResponse> Returns the object with the settings used for calls to listVolumeBackups.PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse, BackupForGKEClient.ListVolumeRestoresPagedResponse> Returns the object with the settings used for calls to listVolumeRestores.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.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 updateBackupChannel.Returns the object with the settings used for calls to updateBackupChannel.Returns the object with the settings used for calls to updateBackup.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 updateRestoreChannel.Returns the object with the settings used for calls to updateRestoreChannel.Returns the object with the settings used for calls to updateRestore.Returns the object with the settings used for calls to updateRestorePlan.Returns the object with the settings used for calls to updateRestorePlan.Returns the object with the settings used for calls to updateRestore.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
-
BackupForGKEStubSettings
protected BackupForGKEStubSettings(BackupForGKEStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
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. -
listBackupPlansSettings
public PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse, listBackupPlansSettings()BackupForGKEClient.ListBackupPlansPagedResponse> Returns the object with the settings used for calls to listBackupPlans. -
getBackupPlanSettings
Returns the object with the settings used for calls to getBackupPlan. -
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. -
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. -
createBackupChannelSettings
Returns the object with the settings used for calls to createBackupChannel. -
createBackupChannelOperationSettings
public OperationCallSettings<CreateBackupChannelRequest,BackupChannel, createBackupChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createBackupChannel. -
listBackupChannelsSettings
public PagedCallSettings<ListBackupChannelsRequest,ListBackupChannelsResponse, listBackupChannelsSettings()BackupForGKEClient.ListBackupChannelsPagedResponse> Returns the object with the settings used for calls to listBackupChannels. -
getBackupChannelSettings
Returns the object with the settings used for calls to getBackupChannel. -
updateBackupChannelSettings
Returns the object with the settings used for calls to updateBackupChannel. -
updateBackupChannelOperationSettings
public OperationCallSettings<UpdateBackupChannelRequest,BackupChannel, updateBackupChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateBackupChannel. -
deleteBackupChannelSettings
Returns the object with the settings used for calls to deleteBackupChannel. -
deleteBackupChannelOperationSettings
public OperationCallSettings<DeleteBackupChannelRequest,com.google.protobuf.Empty, deleteBackupChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackupChannel. -
listBackupPlanBindingsSettings
public PagedCallSettings<ListBackupPlanBindingsRequest,ListBackupPlanBindingsResponse, listBackupPlanBindingsSettings()BackupForGKEClient.ListBackupPlanBindingsPagedResponse> Returns the object with the settings used for calls to listBackupPlanBindings. -
getBackupPlanBindingSettings
public UnaryCallSettings<GetBackupPlanBindingRequest,BackupPlanBinding> getBackupPlanBindingSettings()Returns the object with the settings used for calls to getBackupPlanBinding. -
createBackupSettings
Returns the object with the settings used for calls to createBackup. -
createBackupOperationSettings
public OperationCallSettings<CreateBackupRequest,Backup, createBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createBackup. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()BackupForGKEClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
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,com.google.protobuf.Empty, deleteBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteBackup. -
listVolumeBackupsSettings
public PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse, listVolumeBackupsSettings()BackupForGKEClient.ListVolumeBackupsPagedResponse> Returns the object with the settings used for calls to listVolumeBackups. -
getVolumeBackupSettings
Returns the object with the settings used for calls to getVolumeBackup. -
createRestorePlanSettings
Returns the object with the settings used for calls to createRestorePlan. -
createRestorePlanOperationSettings
public OperationCallSettings<CreateRestorePlanRequest,RestorePlan, createRestorePlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRestorePlan. -
listRestorePlansSettings
public PagedCallSettings<ListRestorePlansRequest,ListRestorePlansResponse, listRestorePlansSettings()BackupForGKEClient.ListRestorePlansPagedResponse> Returns the object with the settings used for calls to listRestorePlans. -
getRestorePlanSettings
Returns the object with the settings used for calls to getRestorePlan. -
updateRestorePlanSettings
Returns the object with the settings used for calls to updateRestorePlan. -
updateRestorePlanOperationSettings
public OperationCallSettings<UpdateRestorePlanRequest,RestorePlan, updateRestorePlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRestorePlan. -
deleteRestorePlanSettings
Returns the object with the settings used for calls to deleteRestorePlan. -
deleteRestorePlanOperationSettings
public OperationCallSettings<DeleteRestorePlanRequest,com.google.protobuf.Empty, deleteRestorePlanOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRestorePlan. -
createRestoreChannelSettings
Returns the object with the settings used for calls to createRestoreChannel. -
createRestoreChannelOperationSettings
public OperationCallSettings<CreateRestoreChannelRequest,RestoreChannel, createRestoreChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRestoreChannel. -
listRestoreChannelsSettings
public PagedCallSettings<ListRestoreChannelsRequest,ListRestoreChannelsResponse, listRestoreChannelsSettings()BackupForGKEClient.ListRestoreChannelsPagedResponse> Returns the object with the settings used for calls to listRestoreChannels. -
getRestoreChannelSettings
Returns the object with the settings used for calls to getRestoreChannel. -
updateRestoreChannelSettings
Returns the object with the settings used for calls to updateRestoreChannel. -
updateRestoreChannelOperationSettings
public OperationCallSettings<UpdateRestoreChannelRequest,RestoreChannel, updateRestoreChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRestoreChannel. -
deleteRestoreChannelSettings
Returns the object with the settings used for calls to deleteRestoreChannel. -
deleteRestoreChannelOperationSettings
public OperationCallSettings<DeleteRestoreChannelRequest,com.google.protobuf.Empty, deleteRestoreChannelOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRestoreChannel. -
listRestorePlanBindingsSettings
public PagedCallSettings<ListRestorePlanBindingsRequest,ListRestorePlanBindingsResponse, listRestorePlanBindingsSettings()BackupForGKEClient.ListRestorePlanBindingsPagedResponse> Returns the object with the settings used for calls to listRestorePlanBindings. -
getRestorePlanBindingSettings
public UnaryCallSettings<GetRestorePlanBindingRequest,RestorePlanBinding> getRestorePlanBindingSettings()Returns the object with the settings used for calls to getRestorePlanBinding. -
createRestoreSettings
Returns the object with the settings used for calls to createRestore. -
createRestoreOperationSettings
public OperationCallSettings<CreateRestoreRequest,Restore, createRestoreOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createRestore. -
listRestoresSettings
public PagedCallSettings<ListRestoresRequest,ListRestoresResponse, listRestoresSettings()BackupForGKEClient.ListRestoresPagedResponse> Returns the object with the settings used for calls to listRestores. -
getRestoreSettings
Returns the object with the settings used for calls to getRestore. -
updateRestoreSettings
Returns the object with the settings used for calls to updateRestore. -
updateRestoreOperationSettings
public OperationCallSettings<UpdateRestoreRequest,Restore, updateRestoreOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateRestore. -
deleteRestoreSettings
Returns the object with the settings used for calls to deleteRestore. -
deleteRestoreOperationSettings
public OperationCallSettings<DeleteRestoreRequest,com.google.protobuf.Empty, deleteRestoreOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteRestore. -
listVolumeRestoresSettings
public PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse, listVolumeRestoresSettings()BackupForGKEClient.ListVolumeRestoresPagedResponse> Returns the object with the settings used for calls to listVolumeRestores. -
getVolumeRestoreSettings
Returns the object with the settings used for calls to getVolumeRestore. -
getBackupIndexDownloadUrlSettings
public UnaryCallSettings<GetBackupIndexDownloadUrlRequest,GetBackupIndexDownloadUrlResponse> getBackupIndexDownloadUrlSettings()Returns the object with the settings used for calls to getBackupIndexDownloadUrl. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()BackupForGKEClient.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<BackupForGKEStubSettings>
-
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<BackupForGKEStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<BackupForGKEStubSettings>
-