Class InstanceGroupsSettings (1.42.0)

Version 1.42.0

• 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 InstanceGroupsSettings extends ClientSettings<InstanceGroupsSettings>

Settings class to configure an instance of InstanceGroupsClient.

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
 InstanceGroupsSettings.Builder instanceGroupsSettingsBuilder =
     InstanceGroupsSettings.newBuilder();
 instanceGroupsSettingsBuilder
     .getSettings()
     .setRetrySettings(
         instanceGroupsSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 InstanceGroupsSettings instanceGroupsSettings = instanceGroupsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > InstanceGroupsSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getGdchApiAudience()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.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

create(InstanceGroupsStubSettings stub)

public static final InstanceGroupsSettings create(InstanceGroupsStubSettings stub)

Parameter
Name	Description
stub	InstanceGroupsStubSettings

Returns
Type	Description
InstanceGroupsSettings

Exceptions
Type	Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Beta

The surface for customizing headers is not stable yet and may change in the future.

This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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

Returns a new builder for this class.

Returns
Type	Description
InstanceGroupsSettings.Builder

newBuilder(ClientContext clientContext)

public static InstanceGroupsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
clientContext	ClientContext

Returns
Type	Description
InstanceGroupsSettings.Builder

Constructors

InstanceGroupsSettings(InstanceGroupsSettings.Builder settingsBuilder)

protected InstanceGroupsSettings(InstanceGroupsSettings.Builder settingsBuilder)

Parameter
Name	Description
settingsBuilder	InstanceGroupsSettings.Builder

Methods

addInstancesOperationSettings()

public OperationCallSettings<AddInstancesInstanceGroupRequest,Operation,Operation> addInstancesOperationSettings()

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

Returns
Type	Description
OperationCallSettings<AddInstancesInstanceGroupRequest,Operation,Operation>

addInstancesSettings()

public UnaryCallSettings<AddInstancesInstanceGroupRequest,Operation> addInstancesSettings()

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

Returns
Type	Description
UnaryCallSettings<AddInstancesInstanceGroupRequest,Operation>

aggregatedListSettings()

public PagedCallSettings<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList,InstanceGroupsClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns
Type	Description
PagedCallSettings<AggregatedListInstanceGroupsRequest,InstanceGroupAggregatedList,AggregatedListPagedResponse>

deleteOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<DeleteInstanceGroupRequest,Operation,Operation>

deleteSettings()

public UnaryCallSettings<DeleteInstanceGroupRequest,Operation> deleteSettings()

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

Returns
Type	Description
UnaryCallSettings<DeleteInstanceGroupRequest,Operation>

getSettings()

public UnaryCallSettings<GetInstanceGroupRequest,InstanceGroup> getSettings()

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

Returns
Type	Description
UnaryCallSettings<GetInstanceGroupRequest,InstanceGroup>

insertOperationSettings()

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

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

Returns
Type	Description
OperationCallSettings<InsertInstanceGroupRequest,Operation,Operation>

insertSettings()

public UnaryCallSettings<InsertInstanceGroupRequest,Operation> insertSettings()

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

Returns
Type	Description
UnaryCallSettings<InsertInstanceGroupRequest,Operation>

listInstancesSettings()

public PagedCallSettings<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances,InstanceGroupsClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
Type	Description
PagedCallSettings<ListInstancesInstanceGroupsRequest,InstanceGroupsListInstances,ListInstancesPagedResponse>

listSettings()

public PagedCallSettings<ListInstanceGroupsRequest,InstanceGroupList,InstanceGroupsClient.ListPagedResponse> listSettings()

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

Returns
Type	Description
PagedCallSettings<ListInstanceGroupsRequest,InstanceGroupList,ListPagedResponse>

removeInstancesOperationSettings()

public OperationCallSettings<RemoveInstancesInstanceGroupRequest,Operation,Operation> removeInstancesOperationSettings()

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

Returns
Type	Description
OperationCallSettings<RemoveInstancesInstanceGroupRequest,Operation,Operation>

removeInstancesSettings()

public UnaryCallSettings<RemoveInstancesInstanceGroupRequest,Operation> removeInstancesSettings()

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

Returns
Type	Description
UnaryCallSettings<RemoveInstancesInstanceGroupRequest,Operation>

setNamedPortsOperationSettings()

public OperationCallSettings<SetNamedPortsInstanceGroupRequest,Operation,Operation> setNamedPortsOperationSettings()

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

Returns
Type	Description
OperationCallSettings<SetNamedPortsInstanceGroupRequest,Operation,Operation>

setNamedPortsSettings()

public UnaryCallSettings<SetNamedPortsInstanceGroupRequest,Operation> setNamedPortsSettings()

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

Returns
Type	Description
UnaryCallSettings<SetNamedPortsInstanceGroupRequest,Operation>

toBuilder()

public InstanceGroupsSettings.Builder toBuilder()

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

Returns
Type	Description
InstanceGroupsSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()