- 2.55.0 (latest)
- 2.54.0
- 2.53.0
- 2.52.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.4
- 2.2.0
- 2.1.10
- 0.2.0
public class ServicesSettings extends ClientSettings<ServicesSettings>Settings class to configure an instance of ServicesClient.
The default instance has everything set to sensible defaults:
- The default service address (appengine.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
ServicesSettings.Builder servicesSettingsBuilder = ServicesSettings.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());
ServicesSettings 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 updateService:
// 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
ServicesSettings.Builder servicesSettingsBuilder = ServicesSettings.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();
Static Methods
create(ServicesStubSettings stub)
public static final ServicesSettings create(ServicesStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
ServicesStubSettings |
| Returns | |
|---|---|
| Type | Description |
ServicesSettings |
|
| 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 ServicesSettings.Builder newBuilder()Returns a new gRPC builder for this class.
| Returns | |
|---|---|
| Type | Description |
ServicesSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static ServicesSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
ServicesSettings.Builder |
|
newHttpJsonBuilder()
public static ServicesSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
ServicesSettings.Builder |
|
Constructors
ServicesSettings(ServicesSettings.Builder settingsBuilder)
protected ServicesSettings(ServicesSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
ServicesSettings.Builder |
Methods
deleteServiceOperationSettings()
public OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1> deleteServiceOperationSettings()Returns the object with the settings used for calls to deleteService.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteServiceRequest,Empty,OperationMetadataV1> |
|
deleteServiceSettings()
public UnaryCallSettings<DeleteServiceRequest,Operation> deleteServiceSettings()Returns the object with the settings used for calls to deleteService.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteServiceRequest,Operation> |
|
getServiceSettings()
public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()Returns the object with the settings used for calls to getService.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetServiceRequest,Service> |
|
listServicesSettings()
public PagedCallSettings<ListServicesRequest,ListServicesResponse,ServicesClient.ListServicesPagedResponse> listServicesSettings()Returns the object with the settings used for calls to listServices.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse> |
|
toBuilder()
public ServicesSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
ServicesSettings.Builder |
|
updateServiceOperationSettings()
public OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1> updateServiceOperationSettings()Returns the object with the settings used for calls to updateService.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateServiceRequest,Service,OperationMetadataV1> |
|
updateServiceSettings()
public UnaryCallSettings<UpdateServiceRequest,Operation> updateServiceSettings()Returns the object with the settings used for calls to updateService.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateServiceRequest,Operation> |
|