com.google.cloud.compute.v1

Class InstanceSettings

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 com.google.api.gax.rpc.ClientSettings<InstanceSettings>

Settings class to configure an instance of InstanceClient.

The default instance has everything set to sensible defaults:

• The default service address (https://compute.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.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<AddAccessConfigInstanceHttpRequest,Operation>	addAccessConfigInstanceSettings() Returns the object with the settings used for calls to addAccessConfigInstance.
com.google.api.gax.rpc.PagedCallSettings<AggregatedListInstancesHttpRequest,InstanceAggregatedList,InstanceClient.AggregatedListInstancesPagedResponse>	aggregatedListInstancesSettings() Returns the object with the settings used for calls to aggregatedListInstances.
com.google.api.gax.rpc.UnaryCallSettings<AttachDiskInstanceHttpRequest,Operation>	attachDiskInstanceSettings() Returns the object with the settings used for calls to attachDiskInstance.
static InstanceSettings	create(InstanceStubSettings stub)
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteAccessConfigInstanceHttpRequest,Operation>	deleteAccessConfigInstanceSettings() Returns the object with the settings used for calls to deleteAccessConfigInstance.
com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceHttpRequest,Operation>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<GetGuestAttributesInstanceHttpRequest,GuestAttributes>	getGuestAttributesInstanceSettings() Returns the object with the settings used for calls to getGuestAttributesInstance.
com.google.api.gax.rpc.UnaryCallSettings<GetIamPolicyInstanceHttpRequest,Policy>	getIamPolicyInstanceSettings() Returns the object with the settings used for calls to getIamPolicyInstance.
com.google.api.gax.rpc.UnaryCallSettings<GetInstanceHttpRequest,Instance>	getInstanceSettings() Returns the object with the settings used for calls to getInstance.
com.google.api.gax.rpc.UnaryCallSettings<GetSerialPortOutputInstanceHttpRequest,SerialPortOutput>	getSerialPortOutputInstanceSettings() Returns the object with the settings used for calls to getSerialPortOutputInstance.
com.google.api.gax.rpc.UnaryCallSettings<GetShieldedInstanceIdentityInstanceHttpRequest,ShieldedInstanceIdentity>	getShieldedInstanceIdentityInstanceSettings() Returns the object with the settings used for calls to getShieldedInstanceIdentityInstance.
com.google.api.gax.rpc.UnaryCallSettings<InsertInstanceHttpRequest,Operation>	insertInstanceSettings() Returns the object with the settings used for calls to insertInstance.
com.google.api.gax.rpc.PagedCallSettings<ListInstancesHttpRequest,InstanceList,InstanceClient.ListInstancesPagedResponse>	listInstancesSettings() Returns the object with the settings used for calls to listInstances.
com.google.api.gax.rpc.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(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.UnaryCallSettings<ResetInstanceHttpRequest,Operation>	resetInstanceSettings() Returns the object with the settings used for calls to resetInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetDeletionProtectionInstanceHttpRequest,Operation>	setDeletionProtectionInstanceSettings() Returns the object with the settings used for calls to setDeletionProtectionInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetDiskAutoDeleteInstanceHttpRequest,Operation>	setDiskAutoDeleteInstanceSettings() Returns the object with the settings used for calls to setDiskAutoDeleteInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetIamPolicyInstanceHttpRequest,Policy>	setIamPolicyInstanceSettings() Returns the object with the settings used for calls to setIamPolicyInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetLabelsInstanceHttpRequest,Operation>	setLabelsInstanceSettings() Returns the object with the settings used for calls to setLabelsInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetMachineResourcesInstanceHttpRequest,Operation>	setMachineResourcesInstanceSettings() Returns the object with the settings used for calls to setMachineResourcesInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetMachineTypeInstanceHttpRequest,Operation>	setMachineTypeInstanceSettings() Returns the object with the settings used for calls to setMachineTypeInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetMetadataInstanceHttpRequest,Operation>	setMetadataInstanceSettings() Returns the object with the settings used for calls to setMetadataInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetMinCpuPlatformInstanceHttpRequest,Operation>	setMinCpuPlatformInstanceSettings() Returns the object with the settings used for calls to setMinCpuPlatformInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetSchedulingInstanceHttpRequest,Operation>	setSchedulingInstanceSettings() Returns the object with the settings used for calls to setSchedulingInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetServiceAccountInstanceHttpRequest,Operation>	setServiceAccountInstanceSettings() Returns the object with the settings used for calls to setServiceAccountInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetShieldedInstanceIntegrityPolicyInstanceHttpRequest,Operation>	setShieldedInstanceIntegrityPolicyInstanceSettings() Returns the object with the settings used for calls to setShieldedInstanceIntegrityPolicyInstance.
com.google.api.gax.rpc.UnaryCallSettings<SetTagsInstanceHttpRequest,Operation>	setTagsInstanceSettings() Returns the object with the settings used for calls to setTagsInstance.
com.google.api.gax.rpc.UnaryCallSettings<SimulateMaintenanceEventInstanceHttpRequest,Operation>	simulateMaintenanceEventInstanceSettings() Returns the object with the settings used for calls to simulateMaintenanceEventInstance.
com.google.api.gax.rpc.UnaryCallSettings<StartInstanceHttpRequest,Operation>	startInstanceSettings() Returns the object with the settings used for calls to startInstance.
com.google.api.gax.rpc.UnaryCallSettings<StartWithEncryptionKeyInstanceHttpRequest,Operation>	startWithEncryptionKeyInstanceSettings() Returns the object with the settings used for calls to startWithEncryptionKeyInstance.
com.google.api.gax.rpc.UnaryCallSettings<StopInstanceHttpRequest,Operation>	stopInstanceSettings() Returns the object with the settings used for calls to stopInstance.
com.google.api.gax.rpc.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.
com.google.api.gax.rpc.UnaryCallSettings<UpdateAccessConfigInstanceHttpRequest,Operation>	updateAccessConfigInstanceSettings() Returns the object with the settings used for calls to updateAccessConfigInstance.
com.google.api.gax.rpc.UnaryCallSettings<UpdateDisplayDeviceInstanceHttpRequest,Operation>	updateDisplayDeviceInstanceSettings() Returns the object with the settings used for calls to updateDisplayDeviceInstance.
com.google.api.gax.rpc.UnaryCallSettings<UpdateNetworkInterfaceInstanceHttpRequest,Operation>	updateNetworkInterfaceInstanceSettings() Returns the object with the settings used for calls to updateNetworkInterfaceInstance.
com.google.api.gax.rpc.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 com.google.api.gax.rpc.UnaryCallSettings<AddAccessConfigInstanceHttpRequest,Operation> addAccessConfigInstanceSettings()

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

aggregatedListInstancesSettings

public com.google.api.gax.rpc.PagedCallSettings<AggregatedListInstancesHttpRequest,InstanceAggregatedList,InstanceClient.AggregatedListInstancesPagedResponse> aggregatedListInstancesSettings()

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

attachDiskInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<AttachDiskInstanceHttpRequest,Operation> attachDiskInstanceSettings()

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

deleteInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteInstanceHttpRequest,Operation> deleteInstanceSettings()

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

deleteAccessConfigInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteAccessConfigInstanceHttpRequest,Operation> deleteAccessConfigInstanceSettings()

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

detachDiskInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<DetachDiskInstanceHttpRequest,Operation> detachDiskInstanceSettings()

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

getInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetInstanceHttpRequest,Instance> getInstanceSettings()

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

getGuestAttributesInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetGuestAttributesInstanceHttpRequest,GuestAttributes> getGuestAttributesInstanceSettings()

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

getIamPolicyInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetIamPolicyInstanceHttpRequest,Policy> getIamPolicyInstanceSettings()

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

getSerialPortOutputInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSerialPortOutputInstanceHttpRequest,SerialPortOutput> getSerialPortOutputInstanceSettings()

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

getShieldedInstanceIdentityInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetShieldedInstanceIdentityInstanceHttpRequest,ShieldedInstanceIdentity> getShieldedInstanceIdentityInstanceSettings()

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

insertInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<InsertInstanceHttpRequest,Operation> insertInstanceSettings()

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

listInstancesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListInstancesHttpRequest,InstanceList,InstanceClient.ListInstancesPagedResponse> listInstancesSettings()

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

listReferrersInstancesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListReferrersInstancesHttpRequest,InstanceListReferrers,InstanceClient.ListReferrersInstancesPagedResponse> listReferrersInstancesSettings()

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

resetInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<ResetInstanceHttpRequest,Operation> resetInstanceSettings()

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

setDeletionProtectionInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetDeletionProtectionInstanceHttpRequest,Operation> setDeletionProtectionInstanceSettings()

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

setDiskAutoDeleteInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetDiskAutoDeleteInstanceHttpRequest,Operation> setDiskAutoDeleteInstanceSettings()

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

setIamPolicyInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetIamPolicyInstanceHttpRequest,Policy> setIamPolicyInstanceSettings()

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

setLabelsInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetLabelsInstanceHttpRequest,Operation> setLabelsInstanceSettings()

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

setMachineResourcesInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetMachineResourcesInstanceHttpRequest,Operation> setMachineResourcesInstanceSettings()

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

setMachineTypeInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetMachineTypeInstanceHttpRequest,Operation> setMachineTypeInstanceSettings()

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

setMetadataInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetMetadataInstanceHttpRequest,Operation> setMetadataInstanceSettings()

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

setMinCpuPlatformInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetMinCpuPlatformInstanceHttpRequest,Operation> setMinCpuPlatformInstanceSettings()

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

setSchedulingInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetSchedulingInstanceHttpRequest,Operation> setSchedulingInstanceSettings()

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

setServiceAccountInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetServiceAccountInstanceHttpRequest,Operation> setServiceAccountInstanceSettings()

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

setShieldedInstanceIntegrityPolicyInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetShieldedInstanceIntegrityPolicyInstanceHttpRequest,Operation> setShieldedInstanceIntegrityPolicyInstanceSettings()

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

setTagsInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SetTagsInstanceHttpRequest,Operation> setTagsInstanceSettings()

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

simulateMaintenanceEventInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<SimulateMaintenanceEventInstanceHttpRequest,Operation> simulateMaintenanceEventInstanceSettings()

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

startInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<StartInstanceHttpRequest,Operation> startInstanceSettings()

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

startWithEncryptionKeyInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<StartWithEncryptionKeyInstanceHttpRequest,Operation> startWithEncryptionKeyInstanceSettings()

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

stopInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<StopInstanceHttpRequest,Operation> stopInstanceSettings()

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

testIamPermissionsInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<TestIamPermissionsInstanceHttpRequest,TestPermissionsResponse> testIamPermissionsInstanceSettings()

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

updateAccessConfigInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateAccessConfigInstanceHttpRequest,Operation> updateAccessConfigInstanceSettings()

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

updateDisplayDeviceInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateDisplayDeviceInstanceHttpRequest,Operation> updateDisplayDeviceInstanceSettings()

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

updateNetworkInterfaceInstanceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateNetworkInterfaceInstanceHttpRequest,Operation> updateNetworkInterfaceInstanceSettings()

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

updateShieldedInstanceConfigInstanceSettings

public com.google.api.gax.rpc.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 com.google.api.gax.core.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 com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultHttpJsonTransportProviderBuilder

public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static InstanceSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static InstanceSettings.Builder newBuilder(com.google.api.gax.rpc.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 com.google.api.gax.rpc.ClientSettings<InstanceSettings>