Class BackendServicesSettings (1.8.1)

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

Static Methods

create(BackendServicesStubSettings stub)

public static final BackendServicesSettings create(BackendServicesStubSettings stub)
Parameter
NameDescription
stubBackendServicesStubSettings
Returns Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static BackendServicesSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static BackendServicesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

Constructors

BackendServicesSettings(BackendServicesSettings.Builder settingsBuilder)

protected BackendServicesSettings(BackendServicesSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderBackendServicesSettings.Builder

Methods

addSignedUrlKeyOperationSettings()

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

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

Returns

addSignedUrlKeySettings()

public UnaryCallSettings<AddSignedUrlKeyBackendServiceRequest,Operation> addSignedUrlKeySettings()

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

Returns

aggregatedListSettings()

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

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

Returns

deleteOperationSettings()

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

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

Returns

deleteSettings()

public UnaryCallSettings<DeleteBackendServiceRequest,Operation> deleteSettings()

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

Returns

deleteSignedUrlKeyOperationSettings()

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

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

Returns

deleteSignedUrlKeySettings()

public UnaryCallSettings<DeleteSignedUrlKeyBackendServiceRequest,Operation> deleteSignedUrlKeySettings()

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

Returns

getHealthSettings()

public UnaryCallSettings<GetHealthBackendServiceRequest,BackendServiceGroupHealth> getHealthSettings()

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

Returns

getSettings()

public UnaryCallSettings<GetBackendServiceRequest,BackendService> getSettings()

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

Returns

insertOperationSettings()

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

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

Returns

insertSettings()

public UnaryCallSettings<InsertBackendServiceRequest,Operation> insertSettings()

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

Returns

listSettings()

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

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

Returns

patchOperationSettings()

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

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

Returns

patchSettings()

public UnaryCallSettings<PatchBackendServiceRequest,Operation> patchSettings()

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

Returns

setEdgeSecurityPolicyOperationSettings()

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

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

Returns

setEdgeSecurityPolicySettings()

public UnaryCallSettings<SetEdgeSecurityPolicyBackendServiceRequest,Operation> setEdgeSecurityPolicySettings()

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

Returns

setSecurityPolicyOperationSettings()

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

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

Returns

setSecurityPolicySettings()

public UnaryCallSettings<SetSecurityPolicyBackendServiceRequest,Operation> setSecurityPolicySettings()

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

Returns

toBuilder()

public BackendServicesSettings.Builder toBuilder()

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

Returns Overrides

updateOperationSettings()

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

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

Returns

updateSettings()

public UnaryCallSettings<UpdateBackendServiceRequest,Operation> updateSettings()

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

Returns