InstanceSettings (Google Cloud 0.90.0-alpha API)

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

```
@Generated(value="by gapic-generator")
 @BetaApi
public class InstanceSettings
extends ClientSettings<InstanceSettings>
```
Settings class to configure an instance of InstanceClient.
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 addAccessConfigInstance to 30 seconds:
```
 
 InstanceSettings.Builder instanceSettingsBuilder =
     InstanceSettings.newBuilder();
 instanceSettingsBuilder.addAccessConfigInstanceSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 InstanceSettings instanceSettings = instanceSettingsBuilder.build();
 
 
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class InstanceSettings.Builder
Builder for InstanceSettings.

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected InstanceSettings(InstanceSettings.Builder settingsBuilder)

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UnaryCallSettings<AddAccessConfigInstanceHttpRequest,Operation>`	`addAccessConfigInstanceSettings()` Returns the object with the settings used for calls to addAccessConfigInstance.
`PagedCallSettings<AggregatedListInstancesHttpRequest,InstanceAggregatedList,InstanceClient.AggregatedListInstancesPagedResponse>`	`aggregatedListInstancesSettings()` Returns the object with the settings used for calls to aggregatedListInstances.
`UnaryCallSettings<AttachDiskInstanceHttpRequest,Operation>`	`attachDiskInstanceSettings()` Returns the object with the settings used for calls to attachDiskInstance.
`static InstanceSettings`	`create(InstanceStubSettings 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<DeleteAccessConfigInstanceHttpRequest,Operation>`	`deleteAccessConfigInstanceSettings()` Returns the object with the settings used for calls to deleteAccessConfigInstance.
`UnaryCallSettings<DeleteInstanceHttpRequest,Operation>`	`deleteInstanceSettings()` Returns the object with the settings used for calls to deleteInstance.
`UnaryCallSettings<DetachDiskInstanceHttpRequest,Operation>`	`detachDiskInstanceSettings()` Returns the object with the settings used for calls to detachDiskInstance.
`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<GetIamPolicyInstanceHttpRequest,Policy>`	`getIamPolicyInstanceSettings()` Returns the object with the settings used for calls to getIamPolicyInstance.
`UnaryCallSettings<GetInstanceHttpRequest,Instance>`	`getInstanceSettings()` Returns the object with the settings used for calls to getInstance.
`UnaryCallSettings<GetSerialPortOutputInstanceHttpRequest,SerialPortOutput>`	`getSerialPortOutputInstanceSettings()` Returns the object with the settings used for calls to getSerialPortOutputInstance.
`UnaryCallSettings<GetShieldedInstanceIdentityInstanceHttpRequest,ShieldedInstanceIdentity>`	`getShieldedInstanceIdentityInstanceSettings()` Returns the object with the settings used for calls to getShieldedInstanceIdentityInstance.
`UnaryCallSettings<InsertInstanceHttpRequest,Operation>`	`insertInstanceSettings()` Returns the object with the settings used for calls to insertInstance.
`PagedCallSettings<ListInstancesHttpRequest,InstanceList,InstanceClient.ListInstancesPagedResponse>`	`listInstancesSettings()` Returns the object with the settings used for calls to listInstances.
`PagedCallSettings<ListReferrersInstancesHttpRequest,InstanceListReferrers,InstanceClient.ListReferrersInstancesPagedResponse>`	`listReferrersInstancesSettings()` Returns the object with the settings used for calls to listReferrersInstances.
`static InstanceSettings.Builder`	`newBuilder()` Returns a new builder for this class.
`static InstanceSettings.Builder`	`newBuilder(ClientContext clientContext)` Returns a new builder for this class.
`UnaryCallSettings<ResetInstanceHttpRequest,Operation>`	`resetInstanceSettings()` Returns the object with the settings used for calls to resetInstance.
`UnaryCallSettings<SetDeletionProtectionInstanceHttpRequest,Operation>`	`setDeletionProtectionInstanceSettings()` Returns the object with the settings used for calls to setDeletionProtectionInstance.
`UnaryCallSettings<SetDiskAutoDeleteInstanceHttpRequest,Operation>`	`setDiskAutoDeleteInstanceSettings()` Returns the object with the settings used for calls to setDiskAutoDeleteInstance.
`UnaryCallSettings<SetIamPolicyInstanceHttpRequest,Policy>`	`setIamPolicyInstanceSettings()` Returns the object with the settings used for calls to setIamPolicyInstance.
`UnaryCallSettings<SetLabelsInstanceHttpRequest,Operation>`	`setLabelsInstanceSettings()` Returns the object with the settings used for calls to setLabelsInstance.
`UnaryCallSettings<SetMachineResourcesInstanceHttpRequest,Operation>`	`setMachineResourcesInstanceSettings()` Returns the object with the settings used for calls to setMachineResourcesInstance.
`UnaryCallSettings<SetMachineTypeInstanceHttpRequest,Operation>`	`setMachineTypeInstanceSettings()` Returns the object with the settings used for calls to setMachineTypeInstance.
`UnaryCallSettings<SetMetadataInstanceHttpRequest,Operation>`	`setMetadataInstanceSettings()` Returns the object with the settings used for calls to setMetadataInstance.
`UnaryCallSettings<SetMinCpuPlatformInstanceHttpRequest,Operation>`	`setMinCpuPlatformInstanceSettings()` Returns the object with the settings used for calls to setMinCpuPlatformInstance.
`UnaryCallSettings<SetSchedulingInstanceHttpRequest,Operation>`	`setSchedulingInstanceSettings()` Returns the object with the settings used for calls to setSchedulingInstance.
`UnaryCallSettings<SetServiceAccountInstanceHttpRequest,Operation>`	`setServiceAccountInstanceSettings()` Returns the object with the settings used for calls to setServiceAccountInstance.
`UnaryCallSettings<SetShieldedInstanceIntegrityPolicyInstanceHttpRequest,Operation>`	`setShieldedInstanceIntegrityPolicyInstanceSettings()` Returns the object with the settings used for calls to setShieldedInstanceIntegrityPolicyInstance.
`UnaryCallSettings<SetTagsInstanceHttpRequest,Operation>`	`setTagsInstanceSettings()` Returns the object with the settings used for calls to setTagsInstance.
`UnaryCallSettings<SimulateMaintenanceEventInstanceHttpRequest,Operation>`	`simulateMaintenanceEventInstanceSettings()` Returns the object with the settings used for calls to simulateMaintenanceEventInstance.
`UnaryCallSettings<StartInstanceHttpRequest,Operation>`	`startInstanceSettings()` Returns the object with the settings used for calls to startInstance.
`UnaryCallSettings<StartWithEncryptionKeyInstanceHttpRequest,Operation>`	`startWithEncryptionKeyInstanceSettings()` Returns the object with the settings used for calls to startWithEncryptionKeyInstance.
`UnaryCallSettings<StopInstanceHttpRequest,Operation>`	`stopInstanceSettings()` Returns the object with the settings used for calls to stopInstance.
`UnaryCallSettings<TestIamPermissionsInstanceHttpRequest,TestPermissionsResponse>`	`testIamPermissionsInstanceSettings()` Returns the object with the settings used for calls to testIamPermissionsInstance.
`InstanceSettings.Builder`	`toBuilder()` Returns a builder containing all the values of this settings class.
`UnaryCallSettings<UpdateAccessConfigInstanceHttpRequest,Operation>`	`updateAccessConfigInstanceSettings()` Returns the object with the settings used for calls to updateAccessConfigInstance.
`UnaryCallSettings<UpdateNetworkInterfaceInstanceHttpRequest,Operation>`	`updateNetworkInterfaceInstanceSettings()` Returns the object with the settings used for calls to updateNetworkInterfaceInstance.
`UnaryCallSettings<UpdateShieldedInstanceConfigInstanceHttpRequest,Operation>`	`updateShieldedInstanceConfigInstanceSettings()` Returns the object with the settings used for calls to updateShieldedInstanceConfigInstance.

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

InstanceSettings

protected InstanceSettings(InstanceSettings.Builder settingsBuilder)
                    throws IOException

Throws:: IOException

Method Detail

addAccessConfigInstanceSettings
```
public UnaryCallSettings<AddAccessConfigInstanceHttpRequest,Operation> addAccessConfigInstanceSettings()
```
Returns the object with the settings used for calls to addAccessConfigInstance.

aggregatedListInstancesSettings

public PagedCallSettings<AggregatedListInstancesHttpRequest,InstanceAggregatedList,InstanceClient.AggregatedListInstancesPagedResponse> aggregatedListInstancesSettings()

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

attachDiskInstanceSettings
```
public UnaryCallSettings<AttachDiskInstanceHttpRequest,Operation> attachDiskInstanceSettings()
```
Returns the object with the settings used for calls to attachDiskInstance.

deleteInstanceSettings
```
public UnaryCallSettings<DeleteInstanceHttpRequest,Operation> deleteInstanceSettings()
```
Returns the object with the settings used for calls to deleteInstance.

deleteAccessConfigInstanceSettings
```
public UnaryCallSettings<DeleteAccessConfigInstanceHttpRequest,Operation> deleteAccessConfigInstanceSettings()
```
Returns the object with the settings used for calls to deleteAccessConfigInstance.

detachDiskInstanceSettings
```
public UnaryCallSettings<DetachDiskInstanceHttpRequest,Operation> detachDiskInstanceSettings()
```
Returns the object with the settings used for calls to detachDiskInstance.

getInstanceSettings
```
public UnaryCallSettings<GetInstanceHttpRequest,Instance> getInstanceSettings()
```
Returns the object with the settings used for calls to getInstance.

getIamPolicyInstanceSettings
```
public UnaryCallSettings<GetIamPolicyInstanceHttpRequest,Policy> getIamPolicyInstanceSettings()
```
Returns the object with the settings used for calls to getIamPolicyInstance.

getSerialPortOutputInstanceSettings

public UnaryCallSettings<GetSerialPortOutputInstanceHttpRequest,SerialPortOutput> getSerialPortOutputInstanceSettings()

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

getShieldedInstanceIdentityInstanceSettings

public UnaryCallSettings<GetShieldedInstanceIdentityInstanceHttpRequest,ShieldedInstanceIdentity> getShieldedInstanceIdentityInstanceSettings()

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

insertInstanceSettings
```
public UnaryCallSettings<InsertInstanceHttpRequest,Operation> insertInstanceSettings()
```
Returns the object with the settings used for calls to insertInstance.

listInstancesSettings

public PagedCallSettings<ListInstancesHttpRequest,InstanceList,InstanceClient.ListInstancesPagedResponse> listInstancesSettings()

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

listReferrersInstancesSettings

public PagedCallSettings<ListReferrersInstancesHttpRequest,InstanceListReferrers,InstanceClient.ListReferrersInstancesPagedResponse> listReferrersInstancesSettings()

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

resetInstanceSettings
```
public UnaryCallSettings<ResetInstanceHttpRequest,Operation> resetInstanceSettings()
```
Returns the object with the settings used for calls to resetInstance.

setDeletionProtectionInstanceSettings
```
public UnaryCallSettings<SetDeletionProtectionInstanceHttpRequest,Operation> setDeletionProtectionInstanceSettings()
```
Returns the object with the settings used for calls to setDeletionProtectionInstance.

setDiskAutoDeleteInstanceSettings
```
public UnaryCallSettings<SetDiskAutoDeleteInstanceHttpRequest,Operation> setDiskAutoDeleteInstanceSettings()
```
Returns the object with the settings used for calls to setDiskAutoDeleteInstance.

setIamPolicyInstanceSettings
```
public UnaryCallSettings<SetIamPolicyInstanceHttpRequest,Policy> setIamPolicyInstanceSettings()
```
Returns the object with the settings used for calls to setIamPolicyInstance.

setLabelsInstanceSettings
```
public UnaryCallSettings<SetLabelsInstanceHttpRequest,Operation> setLabelsInstanceSettings()
```
Returns the object with the settings used for calls to setLabelsInstance.

setMachineResourcesInstanceSettings
```
public UnaryCallSettings<SetMachineResourcesInstanceHttpRequest,Operation> setMachineResourcesInstanceSettings()
```
Returns the object with the settings used for calls to setMachineResourcesInstance.

setMachineTypeInstanceSettings
```
public UnaryCallSettings<SetMachineTypeInstanceHttpRequest,Operation> setMachineTypeInstanceSettings()
```
Returns the object with the settings used for calls to setMachineTypeInstance.

setMetadataInstanceSettings
```
public UnaryCallSettings<SetMetadataInstanceHttpRequest,Operation> setMetadataInstanceSettings()
```
Returns the object with the settings used for calls to setMetadataInstance.

setMinCpuPlatformInstanceSettings
```
public UnaryCallSettings<SetMinCpuPlatformInstanceHttpRequest,Operation> setMinCpuPlatformInstanceSettings()
```
Returns the object with the settings used for calls to setMinCpuPlatformInstance.

setSchedulingInstanceSettings
```
public UnaryCallSettings<SetSchedulingInstanceHttpRequest,Operation> setSchedulingInstanceSettings()
```
Returns the object with the settings used for calls to setSchedulingInstance.

setServiceAccountInstanceSettings
```
public UnaryCallSettings<SetServiceAccountInstanceHttpRequest,Operation> setServiceAccountInstanceSettings()
```
Returns the object with the settings used for calls to setServiceAccountInstance.

setShieldedInstanceIntegrityPolicyInstanceSettings
```
public UnaryCallSettings<SetShieldedInstanceIntegrityPolicyInstanceHttpRequest,Operation> setShieldedInstanceIntegrityPolicyInstanceSettings()
```
Returns the object with the settings used for calls to setShieldedInstanceIntegrityPolicyInstance.

setTagsInstanceSettings
```
public UnaryCallSettings<SetTagsInstanceHttpRequest,Operation> setTagsInstanceSettings()
```
Returns the object with the settings used for calls to setTagsInstance.

simulateMaintenanceEventInstanceSettings
```
public UnaryCallSettings<SimulateMaintenanceEventInstanceHttpRequest,Operation> simulateMaintenanceEventInstanceSettings()
```
Returns the object with the settings used for calls to simulateMaintenanceEventInstance.

startInstanceSettings
```
public UnaryCallSettings<StartInstanceHttpRequest,Operation> startInstanceSettings()
```
Returns the object with the settings used for calls to startInstance.

startWithEncryptionKeyInstanceSettings
```
public UnaryCallSettings<StartWithEncryptionKeyInstanceHttpRequest,Operation> startWithEncryptionKeyInstanceSettings()
```
Returns the object with the settings used for calls to startWithEncryptionKeyInstance.

stopInstanceSettings
```
public UnaryCallSettings<StopInstanceHttpRequest,Operation> stopInstanceSettings()
```
Returns the object with the settings used for calls to stopInstance.

testIamPermissionsInstanceSettings

public UnaryCallSettings<TestIamPermissionsInstanceHttpRequest,TestPermissionsResponse> testIamPermissionsInstanceSettings()

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

updateAccessConfigInstanceSettings
```
public UnaryCallSettings<UpdateAccessConfigInstanceHttpRequest,Operation> updateAccessConfigInstanceSettings()
```
Returns the object with the settings used for calls to updateAccessConfigInstance.

updateNetworkInterfaceInstanceSettings
```
public UnaryCallSettings<UpdateNetworkInterfaceInstanceHttpRequest,Operation> updateNetworkInterfaceInstanceSettings()
```
Returns the object with the settings used for calls to updateNetworkInterfaceInstance.

updateShieldedInstanceConfigInstanceSettings
```
public UnaryCallSettings<UpdateShieldedInstanceConfigInstanceHttpRequest,Operation> updateShieldedInstanceConfigInstanceSettings()
```
Returns the object with the settings used for calls to updateShieldedInstanceConfigInstance.

create

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

Returns a new builder for this class.

newBuilder

public static InstanceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

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

Specified by:

toBuilder in class ClientSettings<InstanceSettings>

Class InstanceSettings

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

InstanceSettings

Method Detail

addAccessConfigInstanceSettings

aggregatedListInstancesSettings

attachDiskInstanceSettings

deleteInstanceSettings

deleteAccessConfigInstanceSettings

detachDiskInstanceSettings

getInstanceSettings

getIamPolicyInstanceSettings

getSerialPortOutputInstanceSettings

getShieldedInstanceIdentityInstanceSettings

insertInstanceSettings

listInstancesSettings

listReferrersInstancesSettings

resetInstanceSettings

setDeletionProtectionInstanceSettings

setDiskAutoDeleteInstanceSettings

setIamPolicyInstanceSettings

setLabelsInstanceSettings

setMachineResourcesInstanceSettings

setMachineTypeInstanceSettings

setMetadataInstanceSettings

setMinCpuPlatformInstanceSettings

setSchedulingInstanceSettings

setServiceAccountInstanceSettings

setShieldedInstanceIntegrityPolicyInstanceSettings

setTagsInstanceSettings

simulateMaintenanceEventInstanceSettings

startInstanceSettings

startWithEncryptionKeyInstanceSettings

stopInstanceSettings

testIamPermissionsInstanceSettings

updateAccessConfigInstanceSettings

updateNetworkInterfaceInstanceSettings

updateShieldedInstanceConfigInstanceSettings

create

defaultExecutorProviderBuilder

getDefaultEndpoint

getDefaultServicePort

getDefaultServiceScopes

defaultCredentialsProviderBuilder

defaultHttpJsonTransportProviderBuilder

defaultTransportChannelProvider

defaultApiClientHeaderProviderBuilder

newBuilder

newBuilder

toBuilder