com.google.cloud.compute.v1

Class BackendServiceSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<BackendServiceSettings>

com.google.cloud.compute.v1.BackendServiceSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class BackendServiceSettings
extends ClientSettings<BackendServiceSettings>

Settings class to configure an instance of BackendServiceClient.

The default instance has everything set to sensible defaults:

• The default service address (https://www.googleapis.com/compute/v1/projects/) 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 addSignedUrlKeyBackendService to 30 seconds:

 
 BackendServiceSettings.Builder backendServiceSettingsBuilder =
     BackendServiceSettings.newBuilder();
 backendServiceSettingsBuilder.addSignedUrlKeyBackendServiceSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BackendServiceSettings backendServiceSettings = backendServiceSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackendServiceSettings.Builder Builder for BackendServiceSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BackendServiceSettings(BackendServiceSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<AddSignedUrlKeyBackendServiceHttpRequest,Operation>	addSignedUrlKeyBackendServiceSettings() Returns the object with the settings used for calls to addSignedUrlKeyBackendService.
PagedCallSettings<AggregatedListBackendServicesHttpRequest,BackendServiceAggregatedList,BackendServiceClient.AggregatedListBackendServicesPagedResponse>	aggregatedListBackendServicesSettings() Returns the object with the settings used for calls to aggregatedListBackendServices.
static BackendServiceSettings	create(BackendServiceStubSettings stub)
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteBackendServiceHttpRequest,Operation>	deleteBackendServiceSettings() Returns the object with the settings used for calls to deleteBackendService.
UnaryCallSettings<DeleteSignedUrlKeyBackendServiceHttpRequest,Operation>	deleteSignedUrlKeyBackendServiceSettings() Returns the object with the settings used for calls to deleteSignedUrlKeyBackendService.
UnaryCallSettings<GetBackendServiceHttpRequest,BackendService>	getBackendServiceSettings() Returns the object with the settings used for calls to getBackendService.
static String	getDefaultEndpoint() Returns the default service endpoint.
static int	getDefaultServicePort() Returns the default service port.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetHealthBackendServiceHttpRequest,BackendServiceGroupHealth>	getHealthBackendServiceSettings() Returns the object with the settings used for calls to getHealthBackendService.
UnaryCallSettings<InsertBackendServiceHttpRequest,Operation>	insertBackendServiceSettings() Returns the object with the settings used for calls to insertBackendService.
PagedCallSettings<ListBackendServicesHttpRequest,BackendServiceList,BackendServiceClient.ListBackendServicesPagedResponse>	listBackendServicesSettings() Returns the object with the settings used for calls to listBackendServices.
static BackendServiceSettings.Builder	newBuilder() Returns a new builder for this class.
static BackendServiceSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<PatchBackendServiceHttpRequest,Operation>	patchBackendServiceSettings() Returns the object with the settings used for calls to patchBackendService.
UnaryCallSettings<SetSecurityPolicyBackendServiceHttpRequest,Operation>	setSecurityPolicyBackendServiceSettings() Returns the object with the settings used for calls to setSecurityPolicyBackendService.
BackendServiceSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
UnaryCallSettings<UpdateBackendServiceHttpRequest,Operation>	updateBackendServiceSettings() Returns the object with the settings used for calls to updateBackendService.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BackendServiceSettings

protected BackendServiceSettings(BackendServiceSettings.Builder settingsBuilder)
                          throws IOException

Throws:

IOException

Method Detail

addSignedUrlKeyBackendServiceSettings

public UnaryCallSettings<AddSignedUrlKeyBackendServiceHttpRequest,Operation> addSignedUrlKeyBackendServiceSettings()

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

aggregatedListBackendServicesSettings

public PagedCallSettings<AggregatedListBackendServicesHttpRequest,BackendServiceAggregatedList,BackendServiceClient.AggregatedListBackendServicesPagedResponse> aggregatedListBackendServicesSettings()

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

deleteBackendServiceSettings

public UnaryCallSettings<DeleteBackendServiceHttpRequest,Operation> deleteBackendServiceSettings()

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

deleteSignedUrlKeyBackendServiceSettings

public UnaryCallSettings<DeleteSignedUrlKeyBackendServiceHttpRequest,Operation> deleteSignedUrlKeyBackendServiceSettings()

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

getBackendServiceSettings

public UnaryCallSettings<GetBackendServiceHttpRequest,BackendService> getBackendServiceSettings()

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

getHealthBackendServiceSettings

public UnaryCallSettings<GetHealthBackendServiceHttpRequest,BackendServiceGroupHealth> getHealthBackendServiceSettings()

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

insertBackendServiceSettings

public UnaryCallSettings<InsertBackendServiceHttpRequest,Operation> insertBackendServiceSettings()

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

listBackendServicesSettings

public PagedCallSettings<ListBackendServicesHttpRequest,BackendServiceList,BackendServiceClient.ListBackendServicesPagedResponse> listBackendServicesSettings()

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

patchBackendServiceSettings

public UnaryCallSettings<PatchBackendServiceHttpRequest,Operation> patchBackendServiceSettings()

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

setSecurityPolicyBackendServiceSettings

public UnaryCallSettings<SetSecurityPolicyBackendServiceHttpRequest,Operation> setSecurityPolicyBackendServiceSettings()

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

updateBackendServiceSettings

public UnaryCallSettings<UpdateBackendServiceHttpRequest,Operation> updateBackendServiceSettings()

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

create

public static final BackendServiceSettings create(BackendServiceStubSettings stub)
                                           throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultServicePort

public static int getDefaultServicePort()

Returns the default service port.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static BackendServiceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static BackendServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BackendServiceSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<BackendServiceSettings>