Class MemorystoreStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<MemorystoreStubSettings>
com.google.cloud.memorystore.v1.stub.MemorystoreStubSettings
@Generated("by gapic-generator-java")
public class MemorystoreStubSettings
extends StubSettings<MemorystoreStubSettings>
Settings class to configure an instance of
MemorystoreStub.
The default instance has everything set to sensible defaults:
- The default service address (memorystore.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
MemorystoreStubSettings.Builder memorystoreSettingsBuilder =
MemorystoreStubSettings.newBuilder();
memorystoreSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
memorystoreSettingsBuilder
.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());
MemorystoreStubSettings memorystoreSettings = memorystoreSettingsBuilder.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
MemorystoreStubSettings.Builder memorystoreSettingsBuilder =
MemorystoreStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
memorystoreSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for MemorystoreStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedMemorystoreStubSettings(MemorystoreStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to backupInstance.Returns the object with the settings used for calls to backupInstance.Returns the object with the settings used for calls to createInstance.Returns the object with the settings used for calls to createInstance.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.Returns the object with the settings used for calls to exportBackup.Returns the object with the settings used for calls to exportBackup.Returns the object with the settings used for calls to getBackupCollection.Returns the object with the settings used for calls to getBackup.Returns the object with the settings used for calls to getCertificateAuthority.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 object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to getSharedRegionalCertificateAuthority.PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse, MemorystoreClient.ListBackupCollectionsPagedResponse> Returns the object with the settings used for calls to listBackupCollections.PagedCallSettings<ListBackupsRequest,ListBackupsResponse, MemorystoreClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, MemorystoreClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, MemorystoreClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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 rescheduleMaintenance.Returns the object with the settings used for calls to rescheduleMaintenance.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateInstance.Returns the object with the settings used for calls to updateInstance.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
-
MemorystoreStubSettings
protected MemorystoreStubSettings(MemorystoreStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()MemorystoreClient.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. -
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. -
getCertificateAuthoritySettings
public UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()Returns the object with the settings used for calls to getCertificateAuthority. -
rescheduleMaintenanceSettings
Returns the object with the settings used for calls to rescheduleMaintenance. -
rescheduleMaintenanceOperationSettings
public OperationCallSettings<RescheduleMaintenanceRequest,Instance, rescheduleMaintenanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to rescheduleMaintenance. -
listBackupCollectionsSettings
public PagedCallSettings<ListBackupCollectionsRequest,ListBackupCollectionsResponse, listBackupCollectionsSettings()MemorystoreClient.ListBackupCollectionsPagedResponse> Returns the object with the settings used for calls to listBackupCollections. -
getBackupCollectionSettings
Returns the object with the settings used for calls to getBackupCollection. -
listBackupsSettings
public PagedCallSettings<ListBackupsRequest,ListBackupsResponse, listBackupsSettings()MemorystoreClient.ListBackupsPagedResponse> Returns the object with the settings used for calls to listBackups. -
getBackupSettings
Returns the object with the settings used for calls to getBackup. -
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. -
exportBackupSettings
Returns the object with the settings used for calls to exportBackup. -
exportBackupOperationSettings
public OperationCallSettings<ExportBackupRequest,Backup, exportBackupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to exportBackup. -
backupInstanceSettings
Returns the object with the settings used for calls to backupInstance. -
backupInstanceOperationSettings
public OperationCallSettings<BackupInstanceRequest,Instance, backupInstanceOperationSettings()OperationMetadata> Returns the object with the settings used for calls to backupInstance. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()MemorystoreClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<MemorystoreStubSettings>
-
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<MemorystoreStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<MemorystoreStubSettings>
-