Class BackendServicesStubSettings (1.65.0)

Version latest

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 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 BackendServicesStubSettings extends StubSettings<BackendServicesStubSettings>

Settings class to configure an instance of BackendServicesStub.

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
 BackendServicesStubSettings.Builder backendServicesSettingsBuilder =
     BackendServicesStubSettings.newBuilder();
 backendServicesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         backendServicesSettingsBuilder
             .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());
 BackendServicesStubSettings backendServicesSettings = backendServicesSettingsBuilder.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 addSignedUrlKey:

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

Inheritance

java.lang.Object > StubSettings > BackendServicesStubSettings

Inherited Members

StubSettings.getApiKey()

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

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()

Obsolete

Use getEndpoint() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns the default service endpoint.

Returns
Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 BackendServicesStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
BackendServicesStubSettings.Builder

newBuilder(ClientContext clientContext)

public static BackendServicesStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
BackendServicesStubSettings.Builder

Constructors

BackendServicesStubSettings(BackendServicesStubSettings.Builder settingsBuilder)

protected BackendServicesStubSettings(BackendServicesStubSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	BackendServicesStubSettings.Builder

Methods

addSignedUrlKeyOperationSettings()

public OperationCallSettings<AddSignedUrlKeyBackendServiceRequest,Operation,Operation> addSignedUrlKeyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<AddSignedUrlKeyBackendServiceRequest,Operation,Operation>

addSignedUrlKeySettings()

public UnaryCallSettings<AddSignedUrlKeyBackendServiceRequest,Operation> addSignedUrlKeySettings()

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

Returns
Type	Description
UnaryCallSettings<AddSignedUrlKeyBackendServiceRequest,Operation>

aggregatedListSettings()

public PagedCallSettings<AggregatedListBackendServicesRequest,BackendServiceAggregatedList,BackendServicesClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns
Type	Description
PagedCallSettings<AggregatedListBackendServicesRequest,BackendServiceAggregatedList,AggregatedListPagedResponse>

createStub()

public BackendServicesStub createStub()

Returns
Type	Description
BackendServicesStub

Exceptions
Type	Description
IOException

deleteOperationSettings()

public OperationCallSettings<DeleteBackendServiceRequest,Operation,Operation> deleteOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteBackendServiceRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteBackendServiceRequest,Operation> deleteSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteBackendServiceRequest,Operation>

deleteSignedUrlKeyOperationSettings()

public OperationCallSettings<DeleteSignedUrlKeyBackendServiceRequest,Operation,Operation> deleteSignedUrlKeyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<DeleteSignedUrlKeyBackendServiceRequest,Operation,Operation>

deleteSignedUrlKeySettings()

public UnaryCallSettings<DeleteSignedUrlKeyBackendServiceRequest,Operation> deleteSignedUrlKeySettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteSignedUrlKeyBackendServiceRequest,Operation>

getHealthSettings()

public UnaryCallSettings<GetHealthBackendServiceRequest,BackendServiceGroupHealth> getHealthSettings()

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

Returns
Type	Description
UnaryCallSettings<GetHealthBackendServiceRequest,BackendServiceGroupHealth>

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyBackendServiceRequest,Policy> getIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<GetIamPolicyBackendServiceRequest,Policy>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
String

Overrides

StubSettings<SettingsT>.getServiceName()

getSettings()

public UnaryCallSettings<GetBackendServiceRequest,BackendService> getSettings()

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

Returns
Type	Description
UnaryCallSettings<GetBackendServiceRequest,BackendService>

insertOperationSettings()

public OperationCallSettings<InsertBackendServiceRequest,Operation,Operation> insertOperationSettings()

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

Returns
Type	Description
OperationCallSettings<InsertBackendServiceRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertBackendServiceRequest,Operation> insertSettings()

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

Returns
Type	Description
UnaryCallSettings<InsertBackendServiceRequest,Operation>

listSettings()

public PagedCallSettings<ListBackendServicesRequest,BackendServiceList,BackendServicesClient.ListPagedResponse> listSettings()

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

Returns
Type	Description
PagedCallSettings<ListBackendServicesRequest,BackendServiceList,ListPagedResponse>

listUsableSettings()

public PagedCallSettings<ListUsableBackendServicesRequest,BackendServiceListUsable,BackendServicesClient.ListUsablePagedResponse> listUsableSettings()

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

Returns
Type	Description
PagedCallSettings<ListUsableBackendServicesRequest,BackendServiceListUsable,ListUsablePagedResponse>

patchOperationSettings()

public OperationCallSettings<PatchBackendServiceRequest,Operation,Operation> patchOperationSettings()

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

Returns
Type	Description
OperationCallSettings<PatchBackendServiceRequest,Operation,Operation>

patchSettings()

public UnaryCallSettings<PatchBackendServiceRequest,Operation> patchSettings()

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

Returns
Type	Description
UnaryCallSettings<PatchBackendServiceRequest,Operation>

setEdgeSecurityPolicyOperationSettings()

public OperationCallSettings<SetEdgeSecurityPolicyBackendServiceRequest,Operation,Operation> setEdgeSecurityPolicyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<SetEdgeSecurityPolicyBackendServiceRequest,Operation,Operation>

setEdgeSecurityPolicySettings()

public UnaryCallSettings<SetEdgeSecurityPolicyBackendServiceRequest,Operation> setEdgeSecurityPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<SetEdgeSecurityPolicyBackendServiceRequest,Operation>

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyBackendServiceRequest,Policy> setIamPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<SetIamPolicyBackendServiceRequest,Policy>

setSecurityPolicyOperationSettings()

public OperationCallSettings<SetSecurityPolicyBackendServiceRequest,Operation,Operation> setSecurityPolicyOperationSettings()

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

Returns
Type	Description
OperationCallSettings<SetSecurityPolicyBackendServiceRequest,Operation,Operation>

setSecurityPolicySettings()

public UnaryCallSettings<SetSecurityPolicyBackendServiceRequest,Operation> setSecurityPolicySettings()

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

Returns
Type	Description
UnaryCallSettings<SetSecurityPolicyBackendServiceRequest,Operation>

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsBackendServiceRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

Returns
Type	Description
UnaryCallSettings<TestIamPermissionsBackendServiceRequest,TestPermissionsResponse>

toBuilder()

public BackendServicesStubSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type	Description
BackendServicesStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()

updateOperationSettings()

public OperationCallSettings<UpdateBackendServiceRequest,Operation,Operation> updateOperationSettings()

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

Returns
Type	Description
OperationCallSettings<UpdateBackendServiceRequest,Operation,Operation>

updateSettings()

public UnaryCallSettings<UpdateBackendServiceRequest,Operation> updateSettings()

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

Returns
Type	Description
UnaryCallSettings<UpdateBackendServiceRequest,Operation>