public class SimulatorSettings extends ClientSettings<SimulatorSettings>Settings class to configure an instance of SimulatorClient.
The default instance has everything set to sensible defaults:
- The default service address (policysimulator.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 getReplay:
// 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
SimulatorSettings.Builder simulatorSettingsBuilder = SimulatorSettings.newBuilder();
simulatorSettingsBuilder
.getReplaySettings()
.setRetrySettings(
simulatorSettingsBuilder
.getReplaySettings()
.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());
SimulatorSettings simulatorSettings = simulatorSettingsBuilder.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 createReplay:
// 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
SimulatorSettings.Builder simulatorSettingsBuilder = SimulatorSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
simulatorSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(SimulatorStubSettings stub)
public static final SimulatorSettings create(SimulatorStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
SimulatorStubSettings |
| Returns | |
|---|---|
| Type | Description |
SimulatorSettings |
|
| 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 SimulatorSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
SimulatorSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static SimulatorSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
SimulatorSettings.Builder |
|
newHttpJsonBuilder()
public static SimulatorSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
SimulatorSettings.Builder |
|
Constructors
SimulatorSettings(SimulatorSettings.Builder settingsBuilder)
protected SimulatorSettings(SimulatorSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
SimulatorSettings.Builder |
Methods
createReplayOperationSettings()
public OperationCallSettings<CreateReplayRequest,Replay,ReplayOperationMetadata> createReplayOperationSettings()Returns the object with the settings used for calls to createReplay.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateReplayRequest,Replay,ReplayOperationMetadata> |
|
createReplaySettings()
public UnaryCallSettings<CreateReplayRequest,Operation> createReplaySettings()Returns the object with the settings used for calls to createReplay.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateReplayRequest,Operation> |
|
getReplaySettings()
public UnaryCallSettings<GetReplayRequest,Replay> getReplaySettings()Returns the object with the settings used for calls to getReplay.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetReplayRequest,Replay> |
|
listReplayResultsSettings()
public PagedCallSettings<ListReplayResultsRequest,ListReplayResultsResponse,SimulatorClient.ListReplayResultsPagedResponse> listReplayResultsSettings()Returns the object with the settings used for calls to listReplayResults.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListReplayResultsRequest,ListReplayResultsResponse,ListReplayResultsPagedResponse> |
|
toBuilder()
public SimulatorSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
SimulatorSettings.Builder |
|