public class MemorystoreSettings extends ClientSettings<MemorystoreSettings>Settings class to configure an instance of MemorystoreClient.
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 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
MemorystoreSettings.Builder memorystoreSettingsBuilder = MemorystoreSettings.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());
MemorystoreSettings memorystoreSettings = memorystoreSettingsBuilder.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
MemorystoreSettings.Builder memorystoreSettingsBuilder = MemorystoreSettings.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();
Static Methods
create(MemorystoreStubSettings stub)
public static final MemorystoreSettings create(MemorystoreStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
MemorystoreStubSettings |
| Returns | |
|---|---|
| Type | Description |
MemorystoreSettings |
|
| 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 |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default 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 MemorystoreSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
MemorystoreSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static MemorystoreSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
MemorystoreSettings.Builder |
|
Constructors
MemorystoreSettings(MemorystoreSettings.Builder settingsBuilder)
protected MemorystoreSettings(MemorystoreSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
MemorystoreSettings.Builder |
Methods
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> |
|
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> |
|
getCertificateAuthoritySettings()
public UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> getCertificateAuthoritySettings()Returns the object with the settings used for calls to getCertificateAuthority.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetCertificateAuthorityRequest,CertificateAuthority> |
|
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceRequest,Instance> |
|
getLocationSettings()
public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()Returns the object with the settings used for calls to getLocation.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location> |
|
listInstancesSettings()
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,MemorystoreClient.ListInstancesPagedResponse> listInstancesSettings()Returns the object with the settings used for calls to listInstances.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse> |
|
listLocationsSettings()
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,MemorystoreClient.ListLocationsPagedResponse> listLocationsSettings()Returns the object with the settings used for calls to listLocations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse> |
|
toBuilder()
public MemorystoreSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
MemorystoreSettings.Builder |
|
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> |
|