com.google.cloud.compute.v1

Class HealthCheckSettings

java.lang.Object

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

com.google.cloud.compute.v1.HealthCheckSettings

@Generated(value="by gapic-generator")
 @BetaApi
public class HealthCheckSettings
extends com.google.api.gax.rpc.ClientSettings<HealthCheckSettings>

Settings class to configure an instance of HealthCheckClient.

The default instance has everything set to sensible defaults:

• The default service address (https://compute.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 deleteHealthCheck to 30 seconds:

 
 HealthCheckSettings.Builder healthCheckSettingsBuilder =
     HealthCheckSettings.newBuilder();
 healthCheckSettingsBuilder.deleteHealthCheckSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 HealthCheckSettings healthCheckSettings = healthCheckSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.PagedCallSettings<AggregatedListHealthChecksHttpRequest,HealthChecksAggregatedList,HealthCheckClient.AggregatedListHealthChecksPagedResponse>	aggregatedListHealthChecksSettings() Returns the object with the settings used for calls to aggregatedListHealthChecks.
static HealthCheckSettings	create(HealthCheckStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteHealthCheckHttpRequest,Operation>	deleteHealthCheckSettings() Returns the object with the settings used for calls to deleteHealthCheck.
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.
com.google.api.gax.rpc.UnaryCallSettings<GetHealthCheckHttpRequest,HealthCheck>	getHealthCheckSettings() Returns the object with the settings used for calls to getHealthCheck.
com.google.api.gax.rpc.UnaryCallSettings<InsertHealthCheckHttpRequest,Operation>	insertHealthCheckSettings() Returns the object with the settings used for calls to insertHealthCheck.
com.google.api.gax.rpc.PagedCallSettings<ListHealthChecksHttpRequest,HealthCheckList,HealthCheckClient.ListHealthChecksPagedResponse>	listHealthChecksSettings() Returns the object with the settings used for calls to listHealthChecks.
static HealthCheckSettings.Builder	newBuilder() Returns a new builder for this class.
static HealthCheckSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<PatchHealthCheckHttpRequest,Operation>	patchHealthCheckSettings() Returns the object with the settings used for calls to patchHealthCheck.
HealthCheckSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateHealthCheckHttpRequest,Operation>	updateHealthCheckSettings() Returns the object with the settings used for calls to updateHealthCheck.

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

HealthCheckSettings

protected HealthCheckSettings(HealthCheckSettings.Builder settingsBuilder)
                       throws IOException

Throws:

IOException

Method Detail

aggregatedListHealthChecksSettings

public com.google.api.gax.rpc.PagedCallSettings<AggregatedListHealthChecksHttpRequest,HealthChecksAggregatedList,HealthCheckClient.AggregatedListHealthChecksPagedResponse> aggregatedListHealthChecksSettings()

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

deleteHealthCheckSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteHealthCheckHttpRequest,Operation> deleteHealthCheckSettings()

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

getHealthCheckSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetHealthCheckHttpRequest,HealthCheck> getHealthCheckSettings()

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

insertHealthCheckSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertHealthCheckHttpRequest,Operation> insertHealthCheckSettings()

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

listHealthChecksSettings

public com.google.api.gax.rpc.PagedCallSettings<ListHealthChecksHttpRequest,HealthCheckList,HealthCheckClient.ListHealthChecksPagedResponse> listHealthChecksSettings()

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

patchHealthCheckSettings

public com.google.api.gax.rpc.UnaryCallSettings<PatchHealthCheckHttpRequest,Operation> patchHealthCheckSettings()

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

updateHealthCheckSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateHealthCheckHttpRequest,Operation> updateHealthCheckSettings()

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

create

public static final HealthCheckSettings create(HealthCheckStubSettings stub)
                                        throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

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

newBuilder

public static HealthCheckSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static HealthCheckSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public HealthCheckSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<HealthCheckSettings>