Class CloudFilestoreManagerSettings (1.53.0) 

public class CloudFilestoreManagerSettings extends ClientSettings<CloudFilestoreManagerSettings>

Settings class to configure an instance of CloudFilestoreManagerClient.

The default instance has everything set to sensible defaults:

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


 // 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
 CloudFilestoreManagerSettings.Builder cloudFilestoreManagerSettingsBuilder =
     CloudFilestoreManagerSettings.newBuilder();
 cloudFilestoreManagerSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         cloudFilestoreManagerSettingsBuilder
             .getInstanceSettings()
             .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());
 CloudFilestoreManagerSettings cloudFilestoreManagerSettings =
     cloudFilestoreManagerSettingsBuilder.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 createInstance:


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

Inheritance

java.lang.Object > ClientSettings > CloudFilestoreManagerSettings

Static Methods

create(CloudFilestoreManagerStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
CloudFilestoreManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static CloudFilestoreManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
CloudFilestoreManagerSettings.Builder

newHttpJsonBuilder()

public static CloudFilestoreManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
CloudFilestoreManagerSettings.Builder

Constructors

CloudFilestoreManagerSettings(CloudFilestoreManagerSettings.Builder settingsBuilder)

protected CloudFilestoreManagerSettings(CloudFilestoreManagerSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder CloudFilestoreManagerSettings.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>

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

Returns
Type Description
UnaryCallSettings<CreateBackupRequest,Operation>

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata> createInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateInstanceRequest,Instance,OperationMetadata>

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<CreateInstanceRequest,Operation>

createShareOperationSettings()

public OperationCallSettings<CreateShareRequest,Share,OperationMetadata> createShareOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateShareRequest,Share,OperationMetadata>

createShareSettings()

public UnaryCallSettings<CreateShareRequest,Operation> createShareSettings()

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

Returns
Type Description
UnaryCallSettings<CreateShareRequest,Operation>

createSnapshotOperationSettings()

public OperationCallSettings<CreateSnapshotRequest,Snapshot,OperationMetadata> createSnapshotOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateSnapshotRequest,Snapshot,OperationMetadata>

createSnapshotSettings()

public UnaryCallSettings<CreateSnapshotRequest,Operation> createSnapshotSettings()

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

Returns
Type Description
UnaryCallSettings<CreateSnapshotRequest,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>

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Operation> deleteBackupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteBackupRequest,Operation>

deleteInstanceOperationSettings()

public OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata> deleteInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteInstanceRequest,Empty,OperationMetadata>

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteInstanceRequest,Operation>

deleteShareOperationSettings()

public OperationCallSettings<DeleteShareRequest,Empty,OperationMetadata> deleteShareOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteShareRequest,Empty,OperationMetadata>

deleteShareSettings()

public UnaryCallSettings<DeleteShareRequest,Operation> deleteShareSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteShareRequest,Operation>

deleteSnapshotOperationSettings()

public OperationCallSettings<DeleteSnapshotRequest,Empty,OperationMetadata> deleteSnapshotOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteSnapshotRequest,Empty,OperationMetadata>

deleteSnapshotSettings()

public UnaryCallSettings<DeleteSnapshotRequest,Operation> deleteSnapshotSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteSnapshotRequest,Operation>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
Type Description
UnaryCallSettings<GetBackupRequest,Backup>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<GetInstanceRequest,Instance>

getShareSettings()

public UnaryCallSettings<GetShareRequest,Share> getShareSettings()

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

Returns
Type Description
UnaryCallSettings<GetShareRequest,Share>

getSnapshotSettings()

public UnaryCallSettings<GetSnapshotRequest,Snapshot> getSnapshotSettings()

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

Returns
Type Description
UnaryCallSettings<GetSnapshotRequest,Snapshot>

listBackupsSettings()

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

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

Returns
Type Description
PagedCallSettings<ListBackupsRequest,ListBackupsResponse,ListBackupsPagedResponse>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,CloudFilestoreManagerClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
Type Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listSharesSettings()

public PagedCallSettings<ListSharesRequest,ListSharesResponse,CloudFilestoreManagerClient.ListSharesPagedResponse> listSharesSettings()

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

Returns
Type Description
PagedCallSettings<ListSharesRequest,ListSharesResponse,ListSharesPagedResponse>

listSnapshotsSettings()

public PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,CloudFilestoreManagerClient.ListSnapshotsPagedResponse> listSnapshotsSettings()

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

Returns
Type Description
PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,ListSnapshotsPagedResponse>

restoreInstanceOperationSettings()

public OperationCallSettings<RestoreInstanceRequest,Instance,OperationMetadata> restoreInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<RestoreInstanceRequest,Instance,OperationMetadata>

restoreInstanceSettings()

public UnaryCallSettings<RestoreInstanceRequest,Operation> restoreInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<RestoreInstanceRequest,Operation>

revertInstanceOperationSettings()

public OperationCallSettings<RevertInstanceRequest,Instance,OperationMetadata> revertInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<RevertInstanceRequest,Instance,OperationMetadata>

revertInstanceSettings()

public UnaryCallSettings<RevertInstanceRequest,Operation> revertInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<RevertInstanceRequest,Operation>

toBuilder()

public CloudFilestoreManagerSettings.Builder toBuilder()

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

Returns
Type Description
CloudFilestoreManagerSettings.Builder
Overrides

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>

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata> updateInstanceOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateInstanceRequest,Instance,OperationMetadata>

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateInstanceRequest,Operation>

updateShareOperationSettings()

public OperationCallSettings<UpdateShareRequest,Share,OperationMetadata> updateShareOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateShareRequest,Share,OperationMetadata>

updateShareSettings()

public UnaryCallSettings<UpdateShareRequest,Operation> updateShareSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateShareRequest,Operation>

updateSnapshotOperationSettings()

public OperationCallSettings<UpdateSnapshotRequest,Snapshot,OperationMetadata> updateSnapshotOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateSnapshotRequest,Snapshot,OperationMetadata>

updateSnapshotSettings()

public UnaryCallSettings<UpdateSnapshotRequest,Operation> updateSnapshotSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateSnapshotRequest,Operation>