- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class InstanceSettingsServiceSettings extends ClientSettings<InstanceSettingsServiceSettings>Settings class to configure an instance of InstanceSettingsServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (compute.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 get:
// 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
InstanceSettingsServiceSettings.Builder instanceSettingsServiceSettingsBuilder =
InstanceSettingsServiceSettings.newBuilder();
instanceSettingsServiceSettingsBuilder
.getSettings()
.setRetrySettings(
instanceSettingsServiceSettingsBuilder
.getSettings()
.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());
InstanceSettingsServiceSettings instanceSettingsServiceSettings =
instanceSettingsServiceSettingsBuilder.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 patch:
// 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
InstanceSettingsServiceSettings.Builder instanceSettingsServiceSettingsBuilder =
InstanceSettingsServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
instanceSettingsServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(InstanceSettingsServiceStubSettings stub)
public static final InstanceSettingsServiceSettings create(InstanceSettingsServiceStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
InstanceSettingsServiceStubSettings |
| Returns | |
|---|---|
| Type | Description |
InstanceSettingsServiceSettings |
|
| 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 InstanceSettingsServiceSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
InstanceSettingsServiceSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static InstanceSettingsServiceSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
InstanceSettingsServiceSettings.Builder |
|
Constructors
InstanceSettingsServiceSettings(InstanceSettingsServiceSettings.Builder settingsBuilder)
protected InstanceSettingsServiceSettings(InstanceSettingsServiceSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
InstanceSettingsServiceSettings.Builder |
Methods
getSettings()
public UnaryCallSettings<GetInstanceSettingRequest,InstanceSettings> getSettings()Returns the object with the settings used for calls to get.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceSettingRequest,InstanceSettings> |
|
patchOperationSettings()
public OperationCallSettings<PatchInstanceSettingRequest,Operation,Operation> patchOperationSettings()Returns the object with the settings used for calls to patch.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<PatchInstanceSettingRequest,Operation,Operation> |
|
patchSettings()
public UnaryCallSettings<PatchInstanceSettingRequest,Operation> patchSettings()Returns the object with the settings used for calls to patch.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PatchInstanceSettingRequest,Operation> |
|
toBuilder()
public InstanceSettingsServiceSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
InstanceSettingsServiceSettings.Builder |
|