Class BackupForGKEStubSettings (0.30.0)

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 total timeout of getBackupPlan 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
 BackupForGKEStubSettings.Builder backupForGKESettingsBuilder =
     BackupForGKEStubSettings.newBuilder();
 backupForGKESettingsBuilder
     .getBackupPlanSettings()
     .setRetrySettings(
         backupForGKESettingsBuilder
             .getBackupPlanSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BackupForGKEStubSettings backupForGKESettings = backupForGKESettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > BackupForGKEStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultGrpcApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultHttpJsonApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static BackupForGKEStubSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
BackupForGKEStubSettings.Builder

newBuilder(ClientContext clientContext)

public static BackupForGKEStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
BackupForGKEStubSettings.Builder

newHttpJsonBuilder()

public static BackupForGKEStubSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
BackupForGKEStubSettings.Builder

Constructors

BackupForGKEStubSettings(BackupForGKEStubSettings.Builder settingsBuilder)

protected BackupForGKEStubSettings(BackupForGKEStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderBackupForGKEStubSettings.Builder

Methods

createBackupOperationSettings()

public OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata> createBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateBackupRequest,Backup,OperationMetadata>

createBackupPlanOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<CreateBackupPlanRequest,BackupPlan,OperationMetadata>

createBackupPlanSettings()

public UnaryCallSettings<CreateBackupPlanRequest,Operation> createBackupPlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBackupPlanRequest,Operation>

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateBackupRequest,Operation>

createRestoreOperationSettings()

public OperationCallSettings<CreateRestoreRequest,Restore,OperationMetadata> createRestoreOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateRestoreRequest,Restore,OperationMetadata>

createRestorePlanOperationSettings()

public OperationCallSettings<CreateRestorePlanRequest,RestorePlan,OperationMetadata> createRestorePlanOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateRestorePlanRequest,RestorePlan,OperationMetadata>

createRestorePlanSettings()

public UnaryCallSettings<CreateRestorePlanRequest,Operation> createRestorePlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateRestorePlanRequest,Operation>

createRestoreSettings()

public UnaryCallSettings<CreateRestoreRequest,Operation> createRestoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateRestoreRequest,Operation>

createStub()

public BackupForGKEStub createStub()
Returns
TypeDescription
BackupForGKEStub
Exceptions
TypeDescription
IOException

deleteBackupOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteBackupRequest,Empty,OperationMetadata>

deleteBackupPlanOperationSettings()

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

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

Returns
TypeDescription
OperationCallSettings<DeleteBackupPlanRequest,Empty,OperationMetadata>

deleteBackupPlanSettings()

public UnaryCallSettings<DeleteBackupPlanRequest,Operation> deleteBackupPlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupPlanRequest,Operation>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteBackupRequest,Operation>

deleteRestoreOperationSettings()

public OperationCallSettings<DeleteRestoreRequest,Empty,OperationMetadata> deleteRestoreOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteRestoreRequest,Empty,OperationMetadata>

deleteRestorePlanOperationSettings()

public OperationCallSettings<DeleteRestorePlanRequest,Empty,OperationMetadata> deleteRestorePlanOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<DeleteRestorePlanRequest,Empty,OperationMetadata>

deleteRestorePlanSettings()

public UnaryCallSettings<DeleteRestorePlanRequest,Operation> deleteRestorePlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteRestorePlanRequest,Operation>

deleteRestoreSettings()

public UnaryCallSettings<DeleteRestoreRequest,Operation> deleteRestoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteRestoreRequest,Operation>

getBackupPlanSettings()

public UnaryCallSettings<GetBackupPlanRequest,BackupPlan> getBackupPlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupPlanRequest,BackupPlan>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetBackupRequest,Backup>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyRequest,Policy> getIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
UnaryCallSettings<GetRestorePlanRequest,RestorePlan>

getRestoreSettings()

public UnaryCallSettings<GetRestoreRequest,Restore> getRestoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetRestoreRequest,Restore>

getVolumeBackupSettings()

public UnaryCallSettings<GetVolumeBackupRequest,VolumeBackup> getVolumeBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetVolumeBackupRequest,VolumeBackup>

getVolumeRestoreSettings()

public UnaryCallSettings<GetVolumeRestoreRequest,VolumeRestore> getVolumeRestoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetVolumeRestoreRequest,VolumeRestore>

listBackupPlansSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBackupPlansRequest,ListBackupPlansResponse,ListBackupPlansPagedResponse>

listBackupsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,BackupForGKEClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
TypeDescription
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
TypeDescription
PagedCallSettings<ListRestorePlansRequest,ListRestorePlansResponse,ListRestorePlansPagedResponse>

listRestoresSettings()

public PagedCallSettings<ListRestoresRequest,ListRestoresResponse,BackupForGKEClient.ListRestoresPagedResponse> listRestoresSettings()

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

Returns
TypeDescription
PagedCallSettings<ListRestoresRequest,ListRestoresResponse,ListRestoresPagedResponse>

listVolumeBackupsSettings()

public PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse,BackupForGKEClient.ListVolumeBackupsPagedResponse> listVolumeBackupsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListVolumeBackupsRequest,ListVolumeBackupsResponse,ListVolumeBackupsPagedResponse>

listVolumeRestoresSettings()

public PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse,BackupForGKEClient.ListVolumeRestoresPagedResponse> listVolumeRestoresSettings()

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

Returns
TypeDescription
PagedCallSettings<ListVolumeRestoresRequest,ListVolumeRestoresResponse,ListVolumeRestoresPagedResponse>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyRequest,Policy> setIamPolicySettings()

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

Returns
TypeDescription
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
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

public BackupForGKEStubSettings.Builder toBuilder()

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

Returns
TypeDescription
BackupForGKEStubSettings.Builder
Overrides

updateBackupOperationSettings()

public OperationCallSettings<UpdateBackupRequest,Backup,OperationMetadata> updateBackupOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateBackupRequest,Backup,OperationMetadata>

updateBackupPlanOperationSettings()

public OperationCallSettings<UpdateBackupPlanRequest,BackupPlan,OperationMetadata> updateBackupPlanOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateBackupPlanRequest,BackupPlan,OperationMetadata>

updateBackupPlanSettings()

public UnaryCallSettings<UpdateBackupPlanRequest,Operation> updateBackupPlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBackupPlanRequest,Operation>

updateBackupSettings()

public UnaryCallSettings<UpdateBackupRequest,Operation> updateBackupSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateBackupRequest,Operation>

updateRestoreOperationSettings()

public OperationCallSettings<UpdateRestoreRequest,Restore,OperationMetadata> updateRestoreOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateRestoreRequest,Restore,OperationMetadata>

updateRestorePlanOperationSettings()

public OperationCallSettings<UpdateRestorePlanRequest,RestorePlan,OperationMetadata> updateRestorePlanOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateRestorePlanRequest,RestorePlan,OperationMetadata>

updateRestorePlanSettings()

public UnaryCallSettings<UpdateRestorePlanRequest,Operation> updateRestorePlanSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateRestorePlanRequest,Operation>

updateRestoreSettings()

public UnaryCallSettings<UpdateRestoreRequest,Operation> updateRestoreSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateRestoreRequest,Operation>