Class CloudFilestoreManagerStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<CloudFilestoreManagerStubSettings>
com.google.cloud.filestore.v1.stub.CloudFilestoreManagerStubSettings
@Generated("by gapic-generator-java")
public class CloudFilestoreManagerStubSettings
extends StubSettings<CloudFilestoreManagerStubSettings>
Settings class to configure an instance of
CloudFilestoreManagerStub.
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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.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
CloudFilestoreManagerStubSettings.Builder cloudFilestoreManagerSettingsBuilder =
CloudFilestoreManagerStubSettings.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());
CloudFilestoreManagerStubSettings cloudFilestoreManagerSettings =
cloudFilestoreManagerSettingsBuilder.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 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
CloudFilestoreManagerStubSettings.Builder cloudFilestoreManagerSettingsBuilder =
CloudFilestoreManagerStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
cloudFilestoreManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CloudFilestoreManagerStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to createBackup.Returns the object with the settings used for calls to createBackup.Returns the object with the settings used for calls to createInstance.Returns the object with the settings used for calls to createInstance.Returns the object with the settings used for calls to createSnapshot.Returns the object with the settings used for calls to createSnapshot.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<DeleteBackupRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteBackup.Returns the object with the settings used for calls to deleteBackup.OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteInstance.Returns the object with the settings used for calls to deleteInstance.OperationCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteSnapshot.Returns the object with the settings used for calls to deleteSnapshot.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 getInstance.protected LibraryMetadataReturns the default service name.Returns the object with the settings used for calls to getSnapshot.PagedCallSettings<ListBackupsRequest,ListBackupsResponse, CloudFilestoreManagerClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, CloudFilestoreManagerClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse, CloudFilestoreManagerClient.ListSnapshotsPagedResponse> Returns the object with the settings used for calls to listSnapshots.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 promoteReplica.Returns the object with the settings used for calls to promoteReplica.Returns the object with the settings used for calls to restoreInstance.Returns the object with the settings used for calls to restoreInstance.Returns the object with the settings used for calls to revertInstance.Returns the object with the settings used for calls to revertInstance.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateBackup.Returns the object with the settings used for calls to updateBackup.Returns the object with the settings used for calls to updateInstance.Returns the object with the settings used for calls to updateInstance.Returns the object with the settings used for calls to updateSnapshot.Returns the object with the settings used for calls to updateSnapshot.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
-
CloudFilestoreManagerStubSettings
protected CloudFilestoreManagerStubSettings(CloudFilestoreManagerStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()CloudFilestoreManagerClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances. -
getInstanceSettings
Returns the object with the settings used for calls to getInstance. -
createInstanceSettings
Returns the object with the settings used for calls to createInstance. -
createInstanceOperationSettings
public OperationCallSettings<CreateInstanceRequest,Instance, createInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createInstance. -
updateInstanceSettings
Returns the object with the settings used for calls to updateInstance. -
updateInstanceOperationSettings
public OperationCallSettings<UpdateInstanceRequest,Instance, updateInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateInstance. -
restoreInstanceSettings
Returns the object with the settings used for calls to restoreInstance. -
restoreInstanceOperationSettings
public OperationCallSettings<RestoreInstanceRequest,Instance, restoreInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to restoreInstance. -
revertInstanceSettings
Returns the object with the settings used for calls to revertInstance. -
revertInstanceOperationSettings
public OperationCallSettings<RevertInstanceRequest,Instance, revertInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to revertInstance. -
deleteInstanceSettings
Returns the object with the settings used for calls to deleteInstance. -
deleteInstanceOperationSettings
public OperationCallSettings<DeleteInstanceRequest,com.google.protobuf.Empty, deleteInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteInstance. -
listSnapshotsSettings
public PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse, listSnapshotsSettings()CloudFilestoreManagerClient.ListSnapshotsPagedResponse> Returns the object with the settings used for calls to listSnapshots. -
getSnapshotSettings
Returns the object with the settings used for calls to getSnapshot. -
createSnapshotSettings
Returns the object with the settings used for calls to createSnapshot. -
createSnapshotOperationSettings
public OperationCallSettings<CreateSnapshotRequest,Snapshot, createSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createSnapshot. -
deleteSnapshotSettings
Returns the object with the settings used for calls to deleteSnapshot. -
deleteSnapshotOperationSettings
public OperationCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty, deleteSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteSnapshot. -
updateSnapshotSettings
Returns the object with the settings used for calls to updateSnapshot. -
updateSnapshotOperationSettings
public OperationCallSettings<UpdateSnapshotRequest,Snapshot, updateSnapshotOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateSnapshot. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()CloudFilestoreManagerClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
getBackupSettings
Returns the object with the settings used for calls to getBackup. -
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. -
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. -
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. -
promoteReplicaSettings
Returns the object with the settings used for calls to promoteReplica. -
promoteReplicaOperationSettings
public OperationCallSettings<PromoteReplicaRequest,Instance, promoteReplicaOperationSettings()OperationMetadata> Returns the object with the settings used for calls to promoteReplica. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<CloudFilestoreManagerStubSettings>
-
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<CloudFilestoreManagerStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<CloudFilestoreManagerStubSettings>
-