Class ServicesStubSettings (0.53.0)

Settings class to configure an instance of ServicesStub.

The default instance has everything set to sensible defaults:

• The default service address (run.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 getService:

 // 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
 ServicesStubSettings.Builder servicesSettingsBuilder = ServicesStubSettings.newBuilder();
 servicesSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         servicesSettingsBuilder
             .getServiceSettings()
             .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());
 ServicesStubSettings servicesSettings = servicesSettingsBuilder.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 createService:

 // 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
 ServicesStubSettings.Builder servicesSettingsBuilder = ServicesStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 servicesSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

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.

Returns the default service endpoint.

Returns the default mTLS service endpoint.

Returns the default service scopes.

Returns a new gRPC builder for this class.

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 createService.

Returns the object with the settings used for calls to createService.

Returns the object with the settings used for calls to deleteService.

Returns the object with the settings used for calls to deleteService.

Returns the object with the settings used for calls to getIamPolicy.

Returns the default service name.

Returns the object with the settings used for calls to getService.

Returns the object with the settings used for calls to listServices.

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 updateService.

Returns the object with the settings used for calls to updateService.