Package com.google.cloud.memcache.v1
Class CloudMemcacheSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<CloudMemcacheSettings>
com.google.cloud.memcache.v1.CloudMemcacheSettings
@Generated("by gapic-generator-java")
public class CloudMemcacheSettings
extends ClientSettings<CloudMemcacheSettings>
Settings class to configure an instance of
CloudMemcacheClient.
The default instance has everything set to sensible defaults:
- The default service address (memcache.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
CloudMemcacheSettings.Builder cloudMemcacheSettingsBuilder = CloudMemcacheSettings.newBuilder();
cloudMemcacheSettingsBuilder
.getInstanceSettings()
.setRetrySettings(
cloudMemcacheSettingsBuilder
.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());
CloudMemcacheSettings cloudMemcacheSettings = cloudMemcacheSettingsBuilder.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
CloudMemcacheSettings.Builder cloudMemcacheSettingsBuilder = CloudMemcacheSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
cloudMemcacheSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for CloudMemcacheSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedCloudMemcacheSettings(CloudMemcacheSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to applyParameters.Returns the object with the settings used for calls to applyParameters.static final CloudMemcacheSettingsReturns 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<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.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getInstance.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, CloudMemcacheClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, CloudMemcacheClient.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.Returns the object with the settings used for calls to updateParameters.Returns the object with the settings used for calls to updateParameters.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
CloudMemcacheSettings
- Throws:
IOException
-
-
Method Details
-
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()CloudMemcacheClient.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. -
updateParametersSettings
Returns the object with the settings used for calls to updateParameters. -
updateParametersOperationSettings
public OperationCallSettings<UpdateParametersRequest,Instance, updateParametersOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateParameters. -
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. -
applyParametersSettings
Returns the object with the settings used for calls to applyParameters. -
applyParametersOperationSettings
public OperationCallSettings<ApplyParametersRequest,Instance, applyParametersOperationSettings()OperationMetadata> Returns the object with the settings used for calls to applyParameters. -
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. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()CloudMemcacheClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default 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
-
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 classClientSettings<CloudMemcacheSettings>
-