Class TargetPoolsStubSettings (1.12.1)

public class TargetPoolsStubSettings extends StubSettings<TargetPoolsStubSettings>

Settings class to configure an instance of TargetPoolsStub.

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:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 TargetPoolsStubSettings.Builder targetPoolsSettingsBuilder =
     TargetPoolsStubSettings.newBuilder();
 targetPoolsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         targetPoolsSettingsBuilder.getSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 TargetPoolsStubSettings targetPoolsSettings = targetPoolsSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > TargetPoolsStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.toBuilder()

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

Static Methods

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

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

newBuilder()

public static TargetPoolsStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
TargetPoolsStubSettings.Builder

newBuilder(ClientContext clientContext)

public static TargetPoolsStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
TargetPoolsStubSettings.Builder

Constructors

TargetPoolsStubSettings(TargetPoolsStubSettings.Builder settingsBuilder)

protected TargetPoolsStubSettings(TargetPoolsStubSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`TargetPoolsStubSettings.Builder`

Methods

addHealthCheckOperationSettings()

public OperationCallSettings<AddHealthCheckTargetPoolRequest,Operation,Operation> addHealthCheckOperationSettings()

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

Returns

Type	Description
OperationCallSettings<AddHealthCheckTargetPoolRequest,Operation,Operation>

addHealthCheckSettings()

public UnaryCallSettings<AddHealthCheckTargetPoolRequest,Operation> addHealthCheckSettings()

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

Returns

Type	Description
UnaryCallSettings<AddHealthCheckTargetPoolRequest,Operation>

addInstanceOperationSettings()

public OperationCallSettings<AddInstanceTargetPoolRequest,Operation,Operation> addInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<AddInstanceTargetPoolRequest,Operation,Operation>

addInstanceSettings()

public UnaryCallSettings<AddInstanceTargetPoolRequest,Operation> addInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<AddInstanceTargetPoolRequest,Operation>

aggregatedListSettings()

public PagedCallSettings<AggregatedListTargetPoolsRequest,TargetPoolAggregatedList,TargetPoolsClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns

Type	Description
PagedCallSettings<AggregatedListTargetPoolsRequest,TargetPoolAggregatedList,AggregatedListPagedResponse>

createStub()

public TargetPoolsStub createStub()

Returns

Type	Description
TargetPoolsStub

Exceptions

Type	Description
IOException

deleteOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<DeleteTargetPoolRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteTargetPoolRequest,Operation> deleteSettings()

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

Returns

Type	Description
UnaryCallSettings<DeleteTargetPoolRequest,Operation>

getHealthSettings()

public UnaryCallSettings<GetHealthTargetPoolRequest,TargetPoolInstanceHealth> getHealthSettings()

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

Returns

Type	Description
UnaryCallSettings<GetHealthTargetPoolRequest,TargetPoolInstanceHealth>

getSettings()

public UnaryCallSettings<GetTargetPoolRequest,TargetPool> getSettings()

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

Returns

Type	Description
UnaryCallSettings<GetTargetPoolRequest,TargetPool>

insertOperationSettings()

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

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

Returns

Type	Description
OperationCallSettings<InsertTargetPoolRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertTargetPoolRequest,Operation> insertSettings()

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

Returns

Type	Description
UnaryCallSettings<InsertTargetPoolRequest,Operation>

listSettings()

public PagedCallSettings<ListTargetPoolsRequest,TargetPoolList,TargetPoolsClient.ListPagedResponse> listSettings()

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

Returns

Type	Description
PagedCallSettings<ListTargetPoolsRequest,TargetPoolList,ListPagedResponse>

removeHealthCheckOperationSettings()

public OperationCallSettings<RemoveHealthCheckTargetPoolRequest,Operation,Operation> removeHealthCheckOperationSettings()

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

Returns

Type	Description
OperationCallSettings<RemoveHealthCheckTargetPoolRequest,Operation,Operation>

removeHealthCheckSettings()

public UnaryCallSettings<RemoveHealthCheckTargetPoolRequest,Operation> removeHealthCheckSettings()

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

Returns

Type	Description
UnaryCallSettings<RemoveHealthCheckTargetPoolRequest,Operation>

removeInstanceOperationSettings()

public OperationCallSettings<RemoveInstanceTargetPoolRequest,Operation,Operation> removeInstanceOperationSettings()

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

Returns

Type	Description
OperationCallSettings<RemoveInstanceTargetPoolRequest,Operation,Operation>

removeInstanceSettings()

public UnaryCallSettings<RemoveInstanceTargetPoolRequest,Operation> removeInstanceSettings()

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

Returns

Type	Description
UnaryCallSettings<RemoveInstanceTargetPoolRequest,Operation>

setBackupOperationSettings()

public OperationCallSettings<SetBackupTargetPoolRequest,Operation,Operation> setBackupOperationSettings()

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

Returns

Type	Description
OperationCallSettings<SetBackupTargetPoolRequest,Operation,Operation>

setBackupSettings()

public UnaryCallSettings<SetBackupTargetPoolRequest,Operation> setBackupSettings()

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

Returns

Type	Description
UnaryCallSettings<SetBackupTargetPoolRequest,Operation>

toBuilder()

public TargetPoolsStubSettings.Builder toBuilder()

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

Returns

Type	Description
TargetPoolsStubSettings.Builder

Overrides

StubSettings<SettingsT>.toBuilder()