Class ReachabilityServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ReachabilityServiceSettings>
com.google.cloud.networkmanagement.v1.ReachabilityServiceSettings
@Generated("by gapic-generator-java")
public class ReachabilityServiceSettings
extends ClientSettings<ReachabilityServiceSettings>
Settings class to configure an instance of
ReachabilityServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (networkmanagement.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 getConnectivityTest:
// 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
ReachabilityServiceSettings.Builder reachabilityServiceSettingsBuilder =
ReachabilityServiceSettings.newBuilder();
reachabilityServiceSettingsBuilder
.getConnectivityTestSettings()
.setRetrySettings(
reachabilityServiceSettingsBuilder
.getConnectivityTestSettings()
.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());
ReachabilityServiceSettings reachabilityServiceSettings =
reachabilityServiceSettingsBuilder.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 createConnectivityTest:
// 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
ReachabilityServiceSettings.Builder reachabilityServiceSettingsBuilder =
ReachabilityServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
reachabilityServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ReachabilityServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ReachabilityServiceSettingsReturns the object with the settings used for calls to createConnectivityTest.Returns the object with the settings used for calls to createConnectivityTest.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<DeleteConnectivityTestRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteConnectivityTest.Returns the object with the settings used for calls to deleteConnectivityTest.Returns the object with the settings used for calls to getConnectivityTest.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse, ReachabilityServiceClient.ListConnectivityTestsPagedResponse> Returns the object with the settings used for calls to listConnectivityTests.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ReachabilityServiceClient.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 rerunConnectivityTest.Returns the object with the settings used for calls to rerunConnectivityTest.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateConnectivityTest.Returns the object with the settings used for calls to updateConnectivityTest.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
-
ReachabilityServiceSettings
protected ReachabilityServiceSettings(ReachabilityServiceSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listConnectivityTestsSettings
public PagedCallSettings<ListConnectivityTestsRequest,ListConnectivityTestsResponse, listConnectivityTestsSettings()ReachabilityServiceClient.ListConnectivityTestsPagedResponse> Returns the object with the settings used for calls to listConnectivityTests. -
getConnectivityTestSettings
Returns the object with the settings used for calls to getConnectivityTest. -
createConnectivityTestSettings
Returns the object with the settings used for calls to createConnectivityTest. -
createConnectivityTestOperationSettings
public OperationCallSettings<CreateConnectivityTestRequest,ConnectivityTest, createConnectivityTestOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createConnectivityTest. -
updateConnectivityTestSettings
Returns the object with the settings used for calls to updateConnectivityTest. -
updateConnectivityTestOperationSettings
public OperationCallSettings<UpdateConnectivityTestRequest,ConnectivityTest, updateConnectivityTestOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateConnectivityTest. -
rerunConnectivityTestSettings
Returns the object with the settings used for calls to rerunConnectivityTest. -
rerunConnectivityTestOperationSettings
public OperationCallSettings<RerunConnectivityTestRequest,ConnectivityTest, rerunConnectivityTestOperationSettings()OperationMetadata> Returns the object with the settings used for calls to rerunConnectivityTest. -
deleteConnectivityTestSettings
Returns the object with the settings used for calls to deleteConnectivityTest. -
deleteConnectivityTestOperationSettings
public OperationCallSettings<DeleteConnectivityTestRequest,com.google.protobuf.Empty, deleteConnectivityTestOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteConnectivityTest. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ReachabilityServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
public static final ReachabilityServiceSettings create(ReachabilityServiceStubSettings stub) throws IOException - 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<ReachabilityServiceSettings>
-