- 1.63.0 (latest)
- 1.62.0
- 1.61.0
- 1.59.0
- 1.58.0
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.0
- 1.53.0
- 1.52.0
- 1.51.0
- 1.50.0
- 1.49.0
- 1.47.0
- 1.46.0
- 1.45.0
- 1.44.0
- 1.43.0
- 1.42.0
- 1.41.0
- 1.40.0
- 1.39.0
- 1.38.0
- 1.37.0
- 1.34.0
- 1.33.0
- 1.32.0
- 1.31.0
- 1.30.0
- 1.29.0
- 1.28.0
- 1.27.0
- 1.26.0
- 1.25.0
- 1.24.0
- 1.23.0
- 1.22.0
- 1.21.0
- 1.20.0
- 1.19.0
- 1.18.0
- 1.17.0
- 1.16.0
- 1.15.0
- 1.14.0
- 1.13.0
- 1.12.1
- 1.11.0
- 1.9.1
- 1.8.1
- 1.7.2
- 1.6.0-beta
public class InstanceGroupManagersSettings extends ClientSettings<InstanceGroupManagersSettings>Settings class to configure an instance of InstanceGroupManagersClient.
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 RetrySettings of get:
// 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
InstanceGroupManagersSettings.Builder instanceGroupManagersSettingsBuilder =
InstanceGroupManagersSettings.newBuilder();
instanceGroupManagersSettingsBuilder
.getSettings()
.setRetrySettings(
instanceGroupManagersSettingsBuilder
.getSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
InstanceGroupManagersSettings instanceGroupManagersSettings =
instanceGroupManagersSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for abandonInstances:
// 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
InstanceGroupManagersSettings.Builder instanceGroupManagersSettingsBuilder =
InstanceGroupManagersSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelay(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
instanceGroupManagersSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
Static Methods
create(InstanceGroupManagersStubSettings stub)
public static final InstanceGroupManagersSettings create(InstanceGroupManagersStubSettings stub)| Parameter | |
|---|---|
| Name | Description |
stub |
InstanceGroupManagersStubSettings |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagersSettings |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
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 |
|
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()Returns the default service scopes.
| Returns | |
|---|---|
| Type | Description |
List<String> |
|
newBuilder()
public static InstanceGroupManagersSettings.Builder newBuilder()Returns a new builder for this class.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagersSettings.Builder |
|
newBuilder(ClientContext clientContext)
public static InstanceGroupManagersSettings.Builder newBuilder(ClientContext clientContext)Returns a new builder for this class.
| Parameter | |
|---|---|
| Name | Description |
clientContext |
ClientContext |
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagersSettings.Builder |
|
Constructors
InstanceGroupManagersSettings(InstanceGroupManagersSettings.Builder settingsBuilder)
protected InstanceGroupManagersSettings(InstanceGroupManagersSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
InstanceGroupManagersSettings.Builder |
Methods
abandonInstancesOperationSettings()
public OperationCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation> abandonInstancesOperationSettings()Returns the object with the settings used for calls to abandonInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation> |
|
abandonInstancesSettings()
public UnaryCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation> abandonInstancesSettings()Returns the object with the settings used for calls to abandonInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation> |
|
aggregatedListSettings()
public PagedCallSettings<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList,InstanceGroupManagersClient.AggregatedListPagedResponse> aggregatedListSettings()Returns the object with the settings used for calls to aggregatedList.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList,AggregatedListPagedResponse> |
|
applyUpdatesToInstancesOperationSettings()
public OperationCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation> applyUpdatesToInstancesOperationSettings()Returns the object with the settings used for calls to applyUpdatesToInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation> |
|
applyUpdatesToInstancesSettings()
public UnaryCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation> applyUpdatesToInstancesSettings()Returns the object with the settings used for calls to applyUpdatesToInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation> |
|
createInstancesOperationSettings()
public OperationCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation,Operation> createInstancesOperationSettings()Returns the object with the settings used for calls to createInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation,Operation> |
|
createInstancesSettings()
public UnaryCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation> createInstancesSettings()Returns the object with the settings used for calls to createInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation> |
|
deleteInstancesOperationSettings()
public OperationCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation> deleteInstancesOperationSettings()Returns the object with the settings used for calls to deleteInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation> |
|
deleteInstancesSettings()
public UnaryCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation> deleteInstancesSettings()Returns the object with the settings used for calls to deleteInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation> |
|
deleteOperationSettings()
public OperationCallSettings<DeleteInstanceGroupManagerRequest,Operation,Operation> deleteOperationSettings()Returns the object with the settings used for calls to delete.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeleteInstanceGroupManagerRequest,Operation,Operation> |
|
deletePerInstanceConfigsOperationSettings()
public OperationCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> deletePerInstanceConfigsOperationSettings()Returns the object with the settings used for calls to deletePerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> |
|
deletePerInstanceConfigsSettings()
public UnaryCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation> deletePerInstanceConfigsSettings()Returns the object with the settings used for calls to deletePerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation> |
|
deleteSettings()
public UnaryCallSettings<DeleteInstanceGroupManagerRequest,Operation> deleteSettings()Returns the object with the settings used for calls to delete.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstanceGroupManagerRequest,Operation> |
|
getSettings()
public UnaryCallSettings<GetInstanceGroupManagerRequest,InstanceGroupManager> getSettings()Returns the object with the settings used for calls to get.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceGroupManagerRequest,InstanceGroupManager> |
|
insertOperationSettings()
public OperationCallSettings<InsertInstanceGroupManagerRequest,Operation,Operation> insertOperationSettings()Returns the object with the settings used for calls to insert.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<InsertInstanceGroupManagerRequest,Operation,Operation> |
|
insertSettings()
public UnaryCallSettings<InsertInstanceGroupManagerRequest,Operation> insertSettings()Returns the object with the settings used for calls to insert.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<InsertInstanceGroupManagerRequest,Operation> |
|
listErrorsSettings()
public PagedCallSettings<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse,InstanceGroupManagersClient.ListErrorsPagedResponse> listErrorsSettings()Returns the object with the settings used for calls to listErrors.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse,ListErrorsPagedResponse> |
|
listManagedInstancesSettings()
public PagedCallSettings<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse,InstanceGroupManagersClient.ListManagedInstancesPagedResponse> listManagedInstancesSettings()Returns the object with the settings used for calls to listManagedInstances.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse,ListManagedInstancesPagedResponse> |
|
listPerInstanceConfigsSettings()
public PagedCallSettings<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp,InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse> listPerInstanceConfigsSettings()Returns the object with the settings used for calls to listPerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp,ListPerInstanceConfigsPagedResponse> |
|
listSettings()
public PagedCallSettings<ListInstanceGroupManagersRequest,InstanceGroupManagerList,InstanceGroupManagersClient.ListPagedResponse> listSettings()Returns the object with the settings used for calls to list.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstanceGroupManagersRequest,InstanceGroupManagerList,ListPagedResponse> |
|
patchOperationSettings()
public OperationCallSettings<PatchInstanceGroupManagerRequest,Operation,Operation> patchOperationSettings()Returns the object with the settings used for calls to patch.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<PatchInstanceGroupManagerRequest,Operation,Operation> |
|
patchPerInstanceConfigsOperationSettings()
public OperationCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> patchPerInstanceConfigsOperationSettings()Returns the object with the settings used for calls to patchPerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> |
|
patchPerInstanceConfigsSettings()
public UnaryCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation> patchPerInstanceConfigsSettings()Returns the object with the settings used for calls to patchPerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation> |
|
patchSettings()
public UnaryCallSettings<PatchInstanceGroupManagerRequest,Operation> patchSettings()Returns the object with the settings used for calls to patch.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<PatchInstanceGroupManagerRequest,Operation> |
|
recreateInstancesOperationSettings()
public OperationCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation> recreateInstancesOperationSettings()Returns the object with the settings used for calls to recreateInstances.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation> |
|
recreateInstancesSettings()
public UnaryCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation> recreateInstancesSettings()Returns the object with the settings used for calls to recreateInstances.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation> |
|
resizeOperationSettings()
public OperationCallSettings<ResizeInstanceGroupManagerRequest,Operation,Operation> resizeOperationSettings()Returns the object with the settings used for calls to resize.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<ResizeInstanceGroupManagerRequest,Operation,Operation> |
|
resizeSettings()
public UnaryCallSettings<ResizeInstanceGroupManagerRequest,Operation> resizeSettings()Returns the object with the settings used for calls to resize.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<ResizeInstanceGroupManagerRequest,Operation> |
|
setInstanceTemplateOperationSettings()
public OperationCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation> setInstanceTemplateOperationSettings()Returns the object with the settings used for calls to setInstanceTemplate.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation> |
|
setInstanceTemplateSettings()
public UnaryCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation> setInstanceTemplateSettings()Returns the object with the settings used for calls to setInstanceTemplate.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation> |
|
setTargetPoolsOperationSettings()
public OperationCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation> setTargetPoolsOperationSettings()Returns the object with the settings used for calls to setTargetPools.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation> |
|
setTargetPoolsSettings()
public UnaryCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation> setTargetPoolsSettings()Returns the object with the settings used for calls to setTargetPools.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation> |
|
toBuilder()
public InstanceGroupManagersSettings.Builder toBuilder()Returns a builder containing all the values of this settings class.
| Returns | |
|---|---|
| Type | Description |
InstanceGroupManagersSettings.Builder |
|
updatePerInstanceConfigsOperationSettings()
public OperationCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> updatePerInstanceConfigsOperationSettings()Returns the object with the settings used for calls to updatePerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> |
|
updatePerInstanceConfigsSettings()
public UnaryCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation> updatePerInstanceConfigsSettings()Returns the object with the settings used for calls to updatePerInstanceConfigs.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation> |
|