TargetPoolSettings (Google Cloud 0.90.0-alpha API)

java.lang.Object
- com.google.api.gax.rpc.ClientSettings<TargetPoolSettings>
- - com.google.cloud.compute.v1.TargetPoolSettings

```
@Generated(value="by gapic-generator")
 @BetaApi
public class TargetPoolSettings
extends ClientSettings<TargetPoolSettings>
```
Settings class to configure an instance of TargetPoolClient.
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 addHealthCheckTargetPool to 30 seconds:
```
 
 TargetPoolSettings.Builder targetPoolSettingsBuilder =
     TargetPoolSettings.newBuilder();
 targetPoolSettingsBuilder.addHealthCheckTargetPoolSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 TargetPoolSettings targetPoolSettings = targetPoolSettingsBuilder.build();
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TargetPoolSettings.Builder
Builder for TargetPoolSettings.

Nested Classes
Modifier and Type	Class and Description
`static class`	`TargetPoolSettings.Builder` Builder for TargetPoolSettings.

Constructor Summary

Constructors
Modifier Constructor and Description

protected TargetPoolSettings(TargetPoolSettings.Builder settingsBuilder)

Constructors
Modifier	Constructor and Description
`protected`	`TargetPoolSettings(TargetPoolSettings.Builder settingsBuilder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnaryCallSettings<AddHealthCheckTargetPoolHttpRequest,Operation>`	`addHealthCheckTargetPoolSettings()` Returns the object with the settings used for calls to addHealthCheckTargetPool.
`UnaryCallSettings<AddInstanceTargetPoolHttpRequest,Operation>`	`addInstanceTargetPoolSettings()` Returns the object with the settings used for calls to addInstanceTargetPool.
`PagedCallSettings<AggregatedListTargetPoolsHttpRequest,TargetPoolAggregatedList,TargetPoolClient.AggregatedListTargetPoolsPagedResponse>`	`aggregatedListTargetPoolsSettings()` Returns the object with the settings used for calls to aggregatedListTargetPools.
`static TargetPoolSettings`	`create(TargetPoolStubSettings 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<DeleteTargetPoolHttpRequest,Operation>`	`deleteTargetPoolSettings()` Returns the object with the settings used for calls to deleteTargetPool.
`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<GetHealthTargetPoolHttpRequest,TargetPoolInstanceHealth>`	`getHealthTargetPoolSettings()` Returns the object with the settings used for calls to getHealthTargetPool.
`UnaryCallSettings<GetTargetPoolHttpRequest,TargetPool>`	`getTargetPoolSettings()` Returns the object with the settings used for calls to getTargetPool.
`UnaryCallSettings<InsertTargetPoolHttpRequest,Operation>`	`insertTargetPoolSettings()` Returns the object with the settings used for calls to insertTargetPool.
`PagedCallSettings<ListTargetPoolsHttpRequest,TargetPoolList,TargetPoolClient.ListTargetPoolsPagedResponse>`	`listTargetPoolsSettings()` Returns the object with the settings used for calls to listTargetPools.
`static TargetPoolSettings.Builder`	`newBuilder()` Returns a new builder for this class.
`static TargetPoolSettings.Builder`	`newBuilder(ClientContext clientContext)` Returns a new builder for this class.
`UnaryCallSettings<RemoveHealthCheckTargetPoolHttpRequest,Operation>`	`removeHealthCheckTargetPoolSettings()` Returns the object with the settings used for calls to removeHealthCheckTargetPool.
`UnaryCallSettings<RemoveInstanceTargetPoolHttpRequest,Operation>`	`removeInstanceTargetPoolSettings()` Returns the object with the settings used for calls to removeInstanceTargetPool.
`UnaryCallSettings<SetBackupTargetPoolHttpRequest,Operation>`	`setBackupTargetPoolSettings()` Returns the object with the settings used for calls to setBackupTargetPool.
`TargetPoolSettings.Builder`	`toBuilder()` Returns a builder containing all the values of this settings class.

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

TargetPoolSettings

protected TargetPoolSettings(TargetPoolSettings.Builder settingsBuilder)
                      throws IOException

Throws:: IOException

Method Detail

addHealthCheckTargetPoolSettings
```
public UnaryCallSettings<AddHealthCheckTargetPoolHttpRequest,Operation> addHealthCheckTargetPoolSettings()
```
Returns the object with the settings used for calls to addHealthCheckTargetPool.

addInstanceTargetPoolSettings
```
public UnaryCallSettings<AddInstanceTargetPoolHttpRequest,Operation> addInstanceTargetPoolSettings()
```
Returns the object with the settings used for calls to addInstanceTargetPool.

aggregatedListTargetPoolsSettings

public PagedCallSettings<AggregatedListTargetPoolsHttpRequest,TargetPoolAggregatedList,TargetPoolClient.AggregatedListTargetPoolsPagedResponse> aggregatedListTargetPoolsSettings()

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

deleteTargetPoolSettings
```
public UnaryCallSettings<DeleteTargetPoolHttpRequest,Operation> deleteTargetPoolSettings()
```
Returns the object with the settings used for calls to deleteTargetPool.

getTargetPoolSettings
```
public UnaryCallSettings<GetTargetPoolHttpRequest,TargetPool> getTargetPoolSettings()
```
Returns the object with the settings used for calls to getTargetPool.

getHealthTargetPoolSettings

public UnaryCallSettings<GetHealthTargetPoolHttpRequest,TargetPoolInstanceHealth> getHealthTargetPoolSettings()

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

insertTargetPoolSettings
```
public UnaryCallSettings<InsertTargetPoolHttpRequest,Operation> insertTargetPoolSettings()
```
Returns the object with the settings used for calls to insertTargetPool.

listTargetPoolsSettings

public PagedCallSettings<ListTargetPoolsHttpRequest,TargetPoolList,TargetPoolClient.ListTargetPoolsPagedResponse> listTargetPoolsSettings()

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

removeHealthCheckTargetPoolSettings
```
public UnaryCallSettings<RemoveHealthCheckTargetPoolHttpRequest,Operation> removeHealthCheckTargetPoolSettings()
```
Returns the object with the settings used for calls to removeHealthCheckTargetPool.

removeInstanceTargetPoolSettings
```
public UnaryCallSettings<RemoveInstanceTargetPoolHttpRequest,Operation> removeInstanceTargetPoolSettings()
```
Returns the object with the settings used for calls to removeInstanceTargetPool.

setBackupTargetPoolSettings
```
public UnaryCallSettings<SetBackupTargetPoolHttpRequest,Operation> setBackupTargetPoolSettings()
```
Returns the object with the settings used for calls to setBackupTargetPool.

create

public static final TargetPoolSettings create(TargetPoolStubSettings 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 TargetPoolSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static TargetPoolSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder
```
public TargetPoolSettings.Builder toBuilder()
```
Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class ClientSettings<TargetPoolSettings>

Class TargetPoolSettings

Nested Class Summary

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

TargetPoolSettings

Method Detail

addHealthCheckTargetPoolSettings

addInstanceTargetPoolSettings

aggregatedListTargetPoolsSettings

deleteTargetPoolSettings

getTargetPoolSettings

getHealthTargetPoolSettings

insertTargetPoolSettings

listTargetPoolsSettings

removeHealthCheckTargetPoolSettings

removeInstanceTargetPoolSettings

setBackupTargetPoolSettings

create

defaultExecutorProviderBuilder

getDefaultEndpoint

getDefaultServicePort

getDefaultServiceScopes

defaultCredentialsProviderBuilder

defaultHttpJsonTransportProviderBuilder

defaultTransportChannelProvider

defaultApiClientHeaderProviderBuilder

newBuilder

newBuilder

toBuilder