Class DepServiceSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<DepServiceSettings>
com.google.cloud.networkservices.v1.DepServiceSettings
@Generated("by gapic-generator-java")
public class DepServiceSettings
extends ClientSettings<DepServiceSettings>
Settings class to configure an instance of
DepServiceClient.
The default instance has everything set to sensible defaults:
- The default service address (networkservices.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 getLbTrafficExtension:
// 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
DepServiceSettings.Builder depServiceSettingsBuilder = DepServiceSettings.newBuilder();
depServiceSettingsBuilder
.getLbTrafficExtensionSettings()
.setRetrySettings(
depServiceSettingsBuilder
.getLbTrafficExtensionSettings()
.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());
DepServiceSettings depServiceSettings = depServiceSettingsBuilder.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 createLbTrafficExtension:
// 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
DepServiceSettings.Builder depServiceSettingsBuilder = DepServiceSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
depServiceSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for DepServiceSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDepServiceSettings(DepServiceSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final DepServiceSettingscreate(DepServiceStubSettings stub) Returns the object with the settings used for calls to createAuthzExtension.Returns the object with the settings used for calls to createAuthzExtension.Returns the object with the settings used for calls to createLbEdgeExtension.Returns the object with the settings used for calls to createLbEdgeExtension.Returns the object with the settings used for calls to createLbRouteExtension.Returns the object with the settings used for calls to createLbRouteExtension.Returns the object with the settings used for calls to createLbTrafficExtension.Returns the object with the settings used for calls to createLbTrafficExtension.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<DeleteAuthzExtensionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteAuthzExtension.Returns the object with the settings used for calls to deleteAuthzExtension.OperationCallSettings<DeleteLbEdgeExtensionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteLbEdgeExtension.Returns the object with the settings used for calls to deleteLbEdgeExtension.OperationCallSettings<DeleteLbRouteExtensionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteLbRouteExtension.Returns the object with the settings used for calls to deleteLbRouteExtension.OperationCallSettings<DeleteLbTrafficExtensionRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteLbTrafficExtension.Returns the object with the settings used for calls to deleteLbTrafficExtension.Returns the object with the settings used for calls to getAuthzExtension.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 getLbEdgeExtension.Returns the object with the settings used for calls to getLbRouteExtension.Returns the object with the settings used for calls to getLbTrafficExtension.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListAuthzExtensionsRequest,ListAuthzExtensionsResponse, DepServiceClient.ListAuthzExtensionsPagedResponse> Returns the object with the settings used for calls to listAuthzExtensions.PagedCallSettings<ListLbEdgeExtensionsRequest,ListLbEdgeExtensionsResponse, DepServiceClient.ListLbEdgeExtensionsPagedResponse> Returns the object with the settings used for calls to listLbEdgeExtensions.PagedCallSettings<ListLbRouteExtensionsRequest,ListLbRouteExtensionsResponse, DepServiceClient.ListLbRouteExtensionsPagedResponse> Returns the object with the settings used for calls to listLbRouteExtensions.PagedCallSettings<ListLbTrafficExtensionsRequest,ListLbTrafficExtensionsResponse, DepServiceClient.ListLbTrafficExtensionsPagedResponse> Returns the object with the settings used for calls to listLbTrafficExtensions.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, DepServiceClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.static DepServiceSettings.BuilderReturns a new gRPC builder for this class.static DepServiceSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static DepServiceSettings.BuilderReturns a new REST builder for this class.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 updateAuthzExtension.Returns the object with the settings used for calls to updateAuthzExtension.Returns the object with the settings used for calls to updateLbEdgeExtension.Returns the object with the settings used for calls to updateLbEdgeExtension.Returns the object with the settings used for calls to updateLbRouteExtension.Returns the object with the settings used for calls to updateLbRouteExtension.Returns the object with the settings used for calls to updateLbTrafficExtension.Returns the object with the settings used for calls to updateLbTrafficExtension.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
-
DepServiceSettings
- Throws:
IOException
-
-
Method Details
-
listLbTrafficExtensionsSettings
public PagedCallSettings<ListLbTrafficExtensionsRequest,ListLbTrafficExtensionsResponse, listLbTrafficExtensionsSettings()DepServiceClient.ListLbTrafficExtensionsPagedResponse> Returns the object with the settings used for calls to listLbTrafficExtensions. -
getLbTrafficExtensionSettings
public UnaryCallSettings<GetLbTrafficExtensionRequest,LbTrafficExtension> getLbTrafficExtensionSettings()Returns the object with the settings used for calls to getLbTrafficExtension. -
createLbTrafficExtensionSettings
public UnaryCallSettings<CreateLbTrafficExtensionRequest,Operation> createLbTrafficExtensionSettings()Returns the object with the settings used for calls to createLbTrafficExtension. -
createLbTrafficExtensionOperationSettings
public OperationCallSettings<CreateLbTrafficExtensionRequest,LbTrafficExtension, createLbTrafficExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createLbTrafficExtension. -
updateLbTrafficExtensionSettings
public UnaryCallSettings<UpdateLbTrafficExtensionRequest,Operation> updateLbTrafficExtensionSettings()Returns the object with the settings used for calls to updateLbTrafficExtension. -
updateLbTrafficExtensionOperationSettings
public OperationCallSettings<UpdateLbTrafficExtensionRequest,LbTrafficExtension, updateLbTrafficExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateLbTrafficExtension. -
deleteLbTrafficExtensionSettings
public UnaryCallSettings<DeleteLbTrafficExtensionRequest,Operation> deleteLbTrafficExtensionSettings()Returns the object with the settings used for calls to deleteLbTrafficExtension. -
deleteLbTrafficExtensionOperationSettings
public OperationCallSettings<DeleteLbTrafficExtensionRequest,com.google.protobuf.Empty, deleteLbTrafficExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteLbTrafficExtension. -
listLbRouteExtensionsSettings
public PagedCallSettings<ListLbRouteExtensionsRequest,ListLbRouteExtensionsResponse, listLbRouteExtensionsSettings()DepServiceClient.ListLbRouteExtensionsPagedResponse> Returns the object with the settings used for calls to listLbRouteExtensions. -
getLbRouteExtensionSettings
Returns the object with the settings used for calls to getLbRouteExtension. -
createLbRouteExtensionSettings
Returns the object with the settings used for calls to createLbRouteExtension. -
createLbRouteExtensionOperationSettings
public OperationCallSettings<CreateLbRouteExtensionRequest,LbRouteExtension, createLbRouteExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createLbRouteExtension. -
updateLbRouteExtensionSettings
Returns the object with the settings used for calls to updateLbRouteExtension. -
updateLbRouteExtensionOperationSettings
public OperationCallSettings<UpdateLbRouteExtensionRequest,LbRouteExtension, updateLbRouteExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateLbRouteExtension. -
deleteLbRouteExtensionSettings
Returns the object with the settings used for calls to deleteLbRouteExtension. -
deleteLbRouteExtensionOperationSettings
public OperationCallSettings<DeleteLbRouteExtensionRequest,com.google.protobuf.Empty, deleteLbRouteExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteLbRouteExtension. -
listLbEdgeExtensionsSettings
public PagedCallSettings<ListLbEdgeExtensionsRequest,ListLbEdgeExtensionsResponse, listLbEdgeExtensionsSettings()DepServiceClient.ListLbEdgeExtensionsPagedResponse> Returns the object with the settings used for calls to listLbEdgeExtensions. -
getLbEdgeExtensionSettings
Returns the object with the settings used for calls to getLbEdgeExtension. -
createLbEdgeExtensionSettings
Returns the object with the settings used for calls to createLbEdgeExtension. -
createLbEdgeExtensionOperationSettings
public OperationCallSettings<CreateLbEdgeExtensionRequest,LbEdgeExtension, createLbEdgeExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createLbEdgeExtension. -
updateLbEdgeExtensionSettings
Returns the object with the settings used for calls to updateLbEdgeExtension. -
updateLbEdgeExtensionOperationSettings
public OperationCallSettings<UpdateLbEdgeExtensionRequest,LbEdgeExtension, updateLbEdgeExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateLbEdgeExtension. -
deleteLbEdgeExtensionSettings
Returns the object with the settings used for calls to deleteLbEdgeExtension. -
deleteLbEdgeExtensionOperationSettings
public OperationCallSettings<DeleteLbEdgeExtensionRequest,com.google.protobuf.Empty, deleteLbEdgeExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteLbEdgeExtension. -
listAuthzExtensionsSettings
public PagedCallSettings<ListAuthzExtensionsRequest,ListAuthzExtensionsResponse, listAuthzExtensionsSettings()DepServiceClient.ListAuthzExtensionsPagedResponse> Returns the object with the settings used for calls to listAuthzExtensions. -
getAuthzExtensionSettings
Returns the object with the settings used for calls to getAuthzExtension. -
createAuthzExtensionSettings
Returns the object with the settings used for calls to createAuthzExtension. -
createAuthzExtensionOperationSettings
public OperationCallSettings<CreateAuthzExtensionRequest,AuthzExtension, createAuthzExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createAuthzExtension. -
updateAuthzExtensionSettings
Returns the object with the settings used for calls to updateAuthzExtension. -
updateAuthzExtensionOperationSettings
public OperationCallSettings<UpdateAuthzExtensionRequest,AuthzExtension, updateAuthzExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateAuthzExtension. -
deleteAuthzExtensionSettings
Returns the object with the settings used for calls to deleteAuthzExtension. -
deleteAuthzExtensionOperationSettings
public OperationCallSettings<DeleteAuthzExtensionRequest,com.google.protobuf.Empty, deleteAuthzExtensionOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteAuthzExtension. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()DepServiceClient.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
- 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<DepServiceSettings>
-