Class InstancesSettings (1.9.1)

public class InstancesSettings extends ClientSettings<InstancesSettings>

Settings class to configure an instance of InstancesClient.

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:


 InstancesSettings.Builder instancesSettingsBuilder = InstancesSettings.newBuilder();
 instancesSettingsBuilder
     .getSettings()
     .setRetrySettings(
         instancesSettingsBuilder
             .getSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 InstancesSettings instancesSettings = instancesSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > InstancesSettings

Static Methods

create(InstancesStubSettings stub)

public static final InstancesSettings create(InstancesStubSettings stub)
Parameter
NameDescription
stubInstancesStubSettings
Returns
TypeDescription
InstancesSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static InstancesSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

newBuilder(ClientContext clientContext)

public static InstancesSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns

Constructors

InstancesSettings(InstancesSettings.Builder settingsBuilder)

protected InstancesSettings(InstancesSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderInstancesSettings.Builder

Methods

addAccessConfigOperationSettings()

public OperationCallSettings<AddAccessConfigInstanceRequest,Operation,Operation> addAccessConfigOperationSettings()

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

Returns

addAccessConfigSettings()

public UnaryCallSettings<AddAccessConfigInstanceRequest,Operation> addAccessConfigSettings()

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

Returns

addResourcePoliciesOperationSettings()

public OperationCallSettings<AddResourcePoliciesInstanceRequest,Operation,Operation> addResourcePoliciesOperationSettings()

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

Returns

addResourcePoliciesSettings()

public UnaryCallSettings<AddResourcePoliciesInstanceRequest,Operation> addResourcePoliciesSettings()

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

Returns

aggregatedListSettings()

public PagedCallSettings<AggregatedListInstancesRequest,InstanceAggregatedList,InstancesClient.AggregatedListPagedResponse> aggregatedListSettings()

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

Returns

attachDiskOperationSettings()

public OperationCallSettings<AttachDiskInstanceRequest,Operation,Operation> attachDiskOperationSettings()

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

Returns

attachDiskSettings()

public UnaryCallSettings<AttachDiskInstanceRequest,Operation> attachDiskSettings()

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

Returns

bulkInsertOperationSettings()

public OperationCallSettings<BulkInsertInstanceRequest,Operation,Operation> bulkInsertOperationSettings()

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

Returns

bulkInsertSettings()

public UnaryCallSettings<BulkInsertInstanceRequest,Operation> bulkInsertSettings()

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

Returns

deleteAccessConfigOperationSettings()

public OperationCallSettings<DeleteAccessConfigInstanceRequest,Operation,Operation> deleteAccessConfigOperationSettings()

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

Returns

deleteAccessConfigSettings()

public UnaryCallSettings<DeleteAccessConfigInstanceRequest,Operation> deleteAccessConfigSettings()

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

Returns

deleteOperationSettings()

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

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

Returns

deleteSettings()

public UnaryCallSettings<DeleteInstanceRequest,Operation> deleteSettings()

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

Returns

detachDiskOperationSettings()

public OperationCallSettings<DetachDiskInstanceRequest,Operation,Operation> detachDiskOperationSettings()

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

Returns

detachDiskSettings()

public UnaryCallSettings<DetachDiskInstanceRequest,Operation> detachDiskSettings()

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

Returns

getEffectiveFirewallsSettings()

public UnaryCallSettings<GetEffectiveFirewallsInstanceRequest,InstancesGetEffectiveFirewallsResponse> getEffectiveFirewallsSettings()

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

Returns

getGuestAttributesSettings()

public UnaryCallSettings<GetGuestAttributesInstanceRequest,GuestAttributes> getGuestAttributesSettings()

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

Returns

getIamPolicySettings()

public UnaryCallSettings<GetIamPolicyInstanceRequest,Policy> getIamPolicySettings()

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

Returns

getScreenshotSettings()

public UnaryCallSettings<GetScreenshotInstanceRequest,Screenshot> getScreenshotSettings()

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

Returns

getSerialPortOutputSettings()

public UnaryCallSettings<GetSerialPortOutputInstanceRequest,SerialPortOutput> getSerialPortOutputSettings()

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

Returns

getSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getSettings()

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

Returns

getShieldedInstanceIdentitySettings()

public UnaryCallSettings<GetShieldedInstanceIdentityInstanceRequest,ShieldedInstanceIdentity> getShieldedInstanceIdentitySettings()

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

Returns

insertOperationSettings()

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

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

Returns

insertSettings()

public UnaryCallSettings<InsertInstanceRequest,Operation> insertSettings()

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

Returns

listReferrersSettings()

public PagedCallSettings<ListReferrersInstancesRequest,InstanceListReferrers,InstancesClient.ListReferrersPagedResponse> listReferrersSettings()

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

Returns

listSettings()

public PagedCallSettings<ListInstancesRequest,InstanceList,InstancesClient.ListPagedResponse> listSettings()

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

Returns

removeResourcePoliciesOperationSettings()

public OperationCallSettings<RemoveResourcePoliciesInstanceRequest,Operation,Operation> removeResourcePoliciesOperationSettings()

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

Returns

removeResourcePoliciesSettings()

public UnaryCallSettings<RemoveResourcePoliciesInstanceRequest,Operation> removeResourcePoliciesSettings()

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

Returns

resetOperationSettings()

public OperationCallSettings<ResetInstanceRequest,Operation,Operation> resetOperationSettings()

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

Returns

resetSettings()

public UnaryCallSettings<ResetInstanceRequest,Operation> resetSettings()

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

Returns

resumeOperationSettings()

public OperationCallSettings<ResumeInstanceRequest,Operation,Operation> resumeOperationSettings()

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

Returns

resumeSettings()

public UnaryCallSettings<ResumeInstanceRequest,Operation> resumeSettings()

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

Returns

sendDiagnosticInterruptSettings()

public UnaryCallSettings<SendDiagnosticInterruptInstanceRequest,SendDiagnosticInterruptInstanceResponse> sendDiagnosticInterruptSettings()

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

Returns

setDeletionProtectionOperationSettings()

public OperationCallSettings<SetDeletionProtectionInstanceRequest,Operation,Operation> setDeletionProtectionOperationSettings()

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

Returns

setDeletionProtectionSettings()

public UnaryCallSettings<SetDeletionProtectionInstanceRequest,Operation> setDeletionProtectionSettings()

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

Returns

setDiskAutoDeleteOperationSettings()

public OperationCallSettings<SetDiskAutoDeleteInstanceRequest,Operation,Operation> setDiskAutoDeleteOperationSettings()

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

Returns

setDiskAutoDeleteSettings()

public UnaryCallSettings<SetDiskAutoDeleteInstanceRequest,Operation> setDiskAutoDeleteSettings()

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

Returns

setIamPolicySettings()

public UnaryCallSettings<SetIamPolicyInstanceRequest,Policy> setIamPolicySettings()

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

Returns

setLabelsOperationSettings()

public OperationCallSettings<SetLabelsInstanceRequest,Operation,Operation> setLabelsOperationSettings()

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

Returns

setLabelsSettings()

public UnaryCallSettings<SetLabelsInstanceRequest,Operation> setLabelsSettings()

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

Returns

setMachineResourcesOperationSettings()

public OperationCallSettings<SetMachineResourcesInstanceRequest,Operation,Operation> setMachineResourcesOperationSettings()

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

Returns

setMachineResourcesSettings()

public UnaryCallSettings<SetMachineResourcesInstanceRequest,Operation> setMachineResourcesSettings()

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

Returns

setMachineTypeOperationSettings()

public OperationCallSettings<SetMachineTypeInstanceRequest,Operation,Operation> setMachineTypeOperationSettings()

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

Returns

setMachineTypeSettings()

public UnaryCallSettings<SetMachineTypeInstanceRequest,Operation> setMachineTypeSettings()

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

Returns

setMetadataOperationSettings()

public OperationCallSettings<SetMetadataInstanceRequest,Operation,Operation> setMetadataOperationSettings()

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

Returns

setMetadataSettings()

public UnaryCallSettings<SetMetadataInstanceRequest,Operation> setMetadataSettings()

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

Returns

setMinCpuPlatformOperationSettings()

public OperationCallSettings<SetMinCpuPlatformInstanceRequest,Operation,Operation> setMinCpuPlatformOperationSettings()

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

Returns

setMinCpuPlatformSettings()

public UnaryCallSettings<SetMinCpuPlatformInstanceRequest,Operation> setMinCpuPlatformSettings()

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

Returns

setSchedulingOperationSettings()

public OperationCallSettings<SetSchedulingInstanceRequest,Operation,Operation> setSchedulingOperationSettings()

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

Returns

setSchedulingSettings()

public UnaryCallSettings<SetSchedulingInstanceRequest,Operation> setSchedulingSettings()

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

Returns

setServiceAccountOperationSettings()

public OperationCallSettings<SetServiceAccountInstanceRequest,Operation,Operation> setServiceAccountOperationSettings()

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

Returns

setServiceAccountSettings()

public UnaryCallSettings<SetServiceAccountInstanceRequest,Operation> setServiceAccountSettings()

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

Returns

setShieldedInstanceIntegrityPolicyOperationSettings()

public OperationCallSettings<SetShieldedInstanceIntegrityPolicyInstanceRequest,Operation,Operation> setShieldedInstanceIntegrityPolicyOperationSettings()

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

Returns

setShieldedInstanceIntegrityPolicySettings()

public UnaryCallSettings<SetShieldedInstanceIntegrityPolicyInstanceRequest,Operation> setShieldedInstanceIntegrityPolicySettings()

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

Returns

setTagsOperationSettings()

public OperationCallSettings<SetTagsInstanceRequest,Operation,Operation> setTagsOperationSettings()

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

Returns

setTagsSettings()

public UnaryCallSettings<SetTagsInstanceRequest,Operation> setTagsSettings()

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

Returns

simulateMaintenanceEventOperationSettings()

public OperationCallSettings<SimulateMaintenanceEventInstanceRequest,Operation,Operation> simulateMaintenanceEventOperationSettings()

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

Returns

simulateMaintenanceEventSettings()

public UnaryCallSettings<SimulateMaintenanceEventInstanceRequest,Operation> simulateMaintenanceEventSettings()

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

Returns

startOperationSettings()

public OperationCallSettings<StartInstanceRequest,Operation,Operation> startOperationSettings()

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

Returns

startSettings()

public UnaryCallSettings<StartInstanceRequest,Operation> startSettings()

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

Returns

startWithEncryptionKeyOperationSettings()

public OperationCallSettings<StartWithEncryptionKeyInstanceRequest,Operation,Operation> startWithEncryptionKeyOperationSettings()

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

Returns

startWithEncryptionKeySettings()

public UnaryCallSettings<StartWithEncryptionKeyInstanceRequest,Operation> startWithEncryptionKeySettings()

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

Returns

stopOperationSettings()

public OperationCallSettings<StopInstanceRequest,Operation,Operation> stopOperationSettings()

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

Returns

stopSettings()

public UnaryCallSettings<StopInstanceRequest,Operation> stopSettings()

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

Returns

suspendOperationSettings()

public OperationCallSettings<SuspendInstanceRequest,Operation,Operation> suspendOperationSettings()

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

Returns

suspendSettings()

public UnaryCallSettings<SuspendInstanceRequest,Operation> suspendSettings()

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

Returns

testIamPermissionsSettings()

public UnaryCallSettings<TestIamPermissionsInstanceRequest,TestPermissionsResponse> testIamPermissionsSettings()

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

Returns

toBuilder()

public InstancesSettings.Builder toBuilder()

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

Returns Overrides

updateAccessConfigOperationSettings()

public OperationCallSettings<UpdateAccessConfigInstanceRequest,Operation,Operation> updateAccessConfigOperationSettings()

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

Returns

updateAccessConfigSettings()

public UnaryCallSettings<UpdateAccessConfigInstanceRequest,Operation> updateAccessConfigSettings()

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

Returns

updateDisplayDeviceOperationSettings()

public OperationCallSettings<UpdateDisplayDeviceInstanceRequest,Operation,Operation> updateDisplayDeviceOperationSettings()

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

Returns

updateDisplayDeviceSettings()

public UnaryCallSettings<UpdateDisplayDeviceInstanceRequest,Operation> updateDisplayDeviceSettings()

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

Returns

updateNetworkInterfaceOperationSettings()

public OperationCallSettings<UpdateNetworkInterfaceInstanceRequest,Operation,Operation> updateNetworkInterfaceOperationSettings()

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

Returns

updateNetworkInterfaceSettings()

public UnaryCallSettings<UpdateNetworkInterfaceInstanceRequest,Operation> updateNetworkInterfaceSettings()

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

Returns

updateOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Operation,Operation> updateOperationSettings()

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

Returns

updateSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateSettings()

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

Returns

updateShieldedInstanceConfigOperationSettings()

public OperationCallSettings<UpdateShieldedInstanceConfigInstanceRequest,Operation,Operation> updateShieldedInstanceConfigOperationSettings()

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

Returns

updateShieldedInstanceConfigSettings()

public UnaryCallSettings<UpdateShieldedInstanceConfigInstanceRequest,Operation> updateShieldedInstanceConfigSettings()

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

Returns