Class BackendServicesSettings (1.6.0-beta)

public class BackendServicesSettings extends ClientSettings<BackendServicesSettings>

Settings class to configure an instance of BackendServicesClient.

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 total timeout of get to 30 seconds:


 BackendServicesSettings.Builder backendServicesSettingsBuilder =
     BackendServicesSettings.newBuilder();
 backendServicesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         backendServicesSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BackendServicesSettings backendServicesSettings = backendServicesSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > BackendServicesSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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)

Constructors

BackendServicesSettings(BackendServicesSettings.Builder settingsBuilder)

protected BackendServicesSettings(BackendServicesSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`BackendServicesSettings.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>

create(BackendServicesStubSettings stub)

public static final BackendServicesSettings create(BackendServicesStubSettings stub)

Parameter

Name	Description
stub	`BackendServicesStubSettings`

Returns

Type	Description
BackendServicesSettings

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

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

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>

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>

getHealthSettings()

public UnaryCallSettings<GetHealthBackendServiceRequest,BackendServiceGroupHealth> getHealthSettings()

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

Returns

Type	Description
UnaryCallSettings<GetHealthBackendServiceRequest,BackendServiceGroupHealth>

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>

newBuilder()

public static BackendServicesSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
BackendServicesSettings.Builder

newBuilder(ClientContext clientContext)

public static BackendServicesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
BackendServicesSettings.Builder

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>

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>

toBuilder()

public BackendServicesSettings.Builder toBuilder()

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

Returns

Type	Description
BackendServicesSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>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>