Class InstanceGroupManagersStubSettings (1.68.0)

public class InstanceGroupManagersStubSettings extends StubSettings<InstanceGroupManagersStubSettings>

Settings class to configure an instance of InstanceGroupManagersStub.

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
 InstanceGroupManagersStubSettings.Builder instanceGroupManagersSettingsBuilder =
     InstanceGroupManagersStubSettings.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());
 InstanceGroupManagersStubSettings 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
 InstanceGroupManagersStubSettings.Builder instanceGroupManagersSettingsBuilder =
     InstanceGroupManagersStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelayDuration(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 instanceGroupManagersSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();
 

Inheritance

java.lang.Object > StubSettings > InstanceGroupManagersStubSettings

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 InstanceGroupManagersStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder(ClientContext clientContext)

public static InstanceGroupManagersStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext

Constructors

InstanceGroupManagersStubSettings(InstanceGroupManagersStubSettings.Builder settingsBuilder)

protected InstanceGroupManagersStubSettings(InstanceGroupManagersStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder InstanceGroupManagersStubSettings.Builder

Methods

abandonInstancesOperationSettings()

public OperationCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation,Operation> abandonInstancesOperationSettings()

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

abandonInstancesSettings()

public UnaryCallSettings<AbandonInstancesInstanceGroupManagerRequest,Operation> abandonInstancesSettings()

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

aggregatedListSettings()

public PagedCallSettings<AggregatedListInstanceGroupManagersRequest,InstanceGroupManagerAggregatedList,InstanceGroupManagersClient.AggregatedListPagedResponse> aggregatedListSettings()

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

applyUpdatesToInstancesOperationSettings()

public OperationCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation,Operation> applyUpdatesToInstancesOperationSettings()

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

applyUpdatesToInstancesSettings()

public UnaryCallSettings<ApplyUpdatesToInstancesInstanceGroupManagerRequest,Operation> applyUpdatesToInstancesSettings()

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

createInstancesOperationSettings()

public OperationCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation,Operation> createInstancesOperationSettings()

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

createInstancesSettings()

public UnaryCallSettings<CreateInstancesInstanceGroupManagerRequest,Operation> createInstancesSettings()

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

createStub()

public InstanceGroupManagersStub createStub()
Returns
Type Description
InstanceGroupManagersStub
Exceptions
Type Description
IOException

deleteInstancesOperationSettings()

public OperationCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation,Operation> deleteInstancesOperationSettings()

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

deleteInstancesSettings()

public UnaryCallSettings<DeleteInstancesInstanceGroupManagerRequest,Operation> deleteInstancesSettings()

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

deleteOperationSettings()

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

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

deletePerInstanceConfigsOperationSettings()

public OperationCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> deletePerInstanceConfigsOperationSettings()

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

deletePerInstanceConfigsSettings()

public UnaryCallSettings<DeletePerInstanceConfigsInstanceGroupManagerRequest,Operation> deletePerInstanceConfigsSettings()

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

deleteSettings()

public UnaryCallSettings<DeleteInstanceGroupManagerRequest,Operation> deleteSettings()

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

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSettings()

public UnaryCallSettings<GetInstanceGroupManagerRequest,InstanceGroupManager> getSettings()

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

insertOperationSettings()

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

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

insertSettings()

public UnaryCallSettings<InsertInstanceGroupManagerRequest,Operation> insertSettings()

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

listErrorsSettings()

public PagedCallSettings<ListErrorsInstanceGroupManagersRequest,InstanceGroupManagersListErrorsResponse,InstanceGroupManagersClient.ListErrorsPagedResponse> listErrorsSettings()

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

listManagedInstancesSettings()

public PagedCallSettings<ListManagedInstancesInstanceGroupManagersRequest,InstanceGroupManagersListManagedInstancesResponse,InstanceGroupManagersClient.ListManagedInstancesPagedResponse> listManagedInstancesSettings()

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

listPerInstanceConfigsSettings()

public PagedCallSettings<ListPerInstanceConfigsInstanceGroupManagersRequest,InstanceGroupManagersListPerInstanceConfigsResp,InstanceGroupManagersClient.ListPerInstanceConfigsPagedResponse> listPerInstanceConfigsSettings()

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

listSettings()

public PagedCallSettings<ListInstanceGroupManagersRequest,InstanceGroupManagerList,InstanceGroupManagersClient.ListPagedResponse> listSettings()

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

patchOperationSettings()

public OperationCallSettings<PatchInstanceGroupManagerRequest,Operation,Operation> patchOperationSettings()

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

patchPerInstanceConfigsOperationSettings()

public OperationCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> patchPerInstanceConfigsOperationSettings()

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

patchPerInstanceConfigsSettings()

public UnaryCallSettings<PatchPerInstanceConfigsInstanceGroupManagerRequest,Operation> patchPerInstanceConfigsSettings()

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

patchSettings()

public UnaryCallSettings<PatchInstanceGroupManagerRequest,Operation> patchSettings()

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

recreateInstancesOperationSettings()

public OperationCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation,Operation> recreateInstancesOperationSettings()

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

recreateInstancesSettings()

public UnaryCallSettings<RecreateInstancesInstanceGroupManagerRequest,Operation> recreateInstancesSettings()

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

resizeOperationSettings()

public OperationCallSettings<ResizeInstanceGroupManagerRequest,Operation,Operation> resizeOperationSettings()

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

resizeSettings()

public UnaryCallSettings<ResizeInstanceGroupManagerRequest,Operation> resizeSettings()

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

resumeInstancesOperationSettings()

public OperationCallSettings<ResumeInstancesInstanceGroupManagerRequest,Operation,Operation> resumeInstancesOperationSettings()

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

resumeInstancesSettings()

public UnaryCallSettings<ResumeInstancesInstanceGroupManagerRequest,Operation> resumeInstancesSettings()

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

setInstanceTemplateOperationSettings()

public OperationCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation,Operation> setInstanceTemplateOperationSettings()

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

setInstanceTemplateSettings()

public UnaryCallSettings<SetInstanceTemplateInstanceGroupManagerRequest,Operation> setInstanceTemplateSettings()

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

setTargetPoolsOperationSettings()

public OperationCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation,Operation> setTargetPoolsOperationSettings()

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

setTargetPoolsSettings()

public UnaryCallSettings<SetTargetPoolsInstanceGroupManagerRequest,Operation> setTargetPoolsSettings()

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

startInstancesOperationSettings()

public OperationCallSettings<StartInstancesInstanceGroupManagerRequest,Operation,Operation> startInstancesOperationSettings()

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

startInstancesSettings()

public UnaryCallSettings<StartInstancesInstanceGroupManagerRequest,Operation> startInstancesSettings()

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

stopInstancesOperationSettings()

public OperationCallSettings<StopInstancesInstanceGroupManagerRequest,Operation,Operation> stopInstancesOperationSettings()

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

stopInstancesSettings()

public UnaryCallSettings<StopInstancesInstanceGroupManagerRequest,Operation> stopInstancesSettings()

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

suspendInstancesOperationSettings()

public OperationCallSettings<SuspendInstancesInstanceGroupManagerRequest,Operation,Operation> suspendInstancesOperationSettings()

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

suspendInstancesSettings()

public UnaryCallSettings<SuspendInstancesInstanceGroupManagerRequest,Operation> suspendInstancesSettings()

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

toBuilder()

public InstanceGroupManagersStubSettings.Builder toBuilder()

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

Overrides

updatePerInstanceConfigsOperationSettings()

public OperationCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation,Operation> updatePerInstanceConfigsOperationSettings()

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

updatePerInstanceConfigsSettings()

public UnaryCallSettings<UpdatePerInstanceConfigsInstanceGroupManagerRequest,Operation> updatePerInstanceConfigsSettings()

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