Send feedback Class InstanceAdminSettings Stay organized with collections Save and categorize content based on your preferences.
Version 6.14.1keyboard_arrow_down
public class InstanceAdminSettings extends ClientSettings<InstanceAdminSettings> Settings class to configure an instance of InstanceAdminClient .
The default instance has everything set to sensible defaults:
The default service address (spanner.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 getInstanceConfig to 30 seconds:
InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder();
instanceAdminSettingsBuilder
.getInstanceConfigSettings()
.setRetrySettings(
instanceAdminSettingsBuilder
.getInstanceConfigSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
InstanceAdminSettings instanceAdminSettings = instanceAdminSettingsBuilder.build();
Constructors InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)
protected InstanceAdminSettings ( InstanceAdminSettings . Builder settingsBuilder ) Parameter Methods create(InstanceAdminStubSettings stub)
public static final InstanceAdminSettings create ( InstanceAdminStubSettings stub ) Parameter Returns Exceptions createInstanceOperationSettings()
public OperationCallSettings<CreateInstanceRequest , Instance , CreateInstanceMetadata > createInstanceOperationSettings () Returns the object with the settings used for calls to createInstance.
Returns createInstanceSettings()
public UnaryCallSettings<CreateInstanceRequest , Operation > createInstanceSettings () Returns the object with the settings used for calls to createInstance.
Returns
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder () Returns defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider . Builder defaultCredentialsProviderBuilder () Returns a builder for the default credentials for this service.
Returns defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider . Builder defaultExecutorProviderBuilder () Returns a builder for the default ExecutorProvider for this service.
Returns defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder () Returns a builder for the default ChannelProvider for this service.
Returns defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider () Returns deleteInstanceSettings()
public UnaryCallSettings<DeleteInstanceRequest , Empty > deleteInstanceSettings () Returns the object with the settings used for calls to deleteInstance.
Returns getDefaultEndpoint()
public static String getDefaultEndpoint () Returns the default service endpoint.
Returns getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes () Returns the default service scopes.
Returns getIamPolicySettings()
public UnaryCallSettings<GetIamPolicyRequest , Policy > getIamPolicySettings () Returns the object with the settings used for calls to getIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.GetIamPolicyRequest ,com.google.iam.v1.Policy >
getInstanceConfigSettings()
public UnaryCallSettings<GetInstanceConfigRequest , InstanceConfig > getInstanceConfigSettings () Returns the object with the settings used for calls to getInstanceConfig.
Returns getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest , Instance > getInstanceSettings () Returns the object with the settings used for calls to getInstance.
Returns listInstanceConfigsSettings()
public PagedCallSettings<ListInstanceConfigsRequest , ListInstanceConfigsResponse , InstanceAdminClient . ListInstanceConfigsPagedResponse > listInstanceConfigsSettings () Returns the object with the settings used for calls to listInstanceConfigs.
Returns listInstancesSettings()
public PagedCallSettings<ListInstancesRequest , ListInstancesResponse , InstanceAdminClient . ListInstancesPagedResponse > listInstancesSettings () Returns the object with the settings used for calls to listInstances.
Returns newBuilder()
public static InstanceAdminSettings . Builder newBuilder () Returns a new builder for this class.
Returns newBuilder(ClientContext clientContext)
public static InstanceAdminSettings . Builder newBuilder ( ClientContext clientContext ) Returns a new builder for this class.
Parameter Returns setIamPolicySettings()
public UnaryCallSettings<SetIamPolicyRequest , Policy > setIamPolicySettings () Returns the object with the settings used for calls to setIamPolicy.
Returns Type Description UnaryCallSettings <com.google.iam.v1.SetIamPolicyRequest ,com.google.iam.v1.Policy >
testIamPermissionsSettings()
public UnaryCallSettings<TestIamPermissionsRequest , TestIamPermissionsResponse > testIamPermissionsSettings () Returns the object with the settings used for calls to testIamPermissions.
Returns Type Description UnaryCallSettings <com.google.iam.v1.TestIamPermissionsRequest ,com.google.iam.v1.TestIamPermissionsResponse >
toBuilder()
public InstanceAdminSettings . Builder toBuilder () Returns a builder containing all the values of this settings class.
Returns Overrides updateInstanceOperationSettings()
public OperationCallSettings<UpdateInstanceRequest , Instance , UpdateInstanceMetadata > updateInstanceOperationSettings () Returns the object with the settings used for calls to updateInstance.
Returns updateInstanceSettings()
public UnaryCallSettings<UpdateInstanceRequest , Operation > updateInstanceSettings () Returns the object with the settings used for calls to updateInstance.
Returns Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-06-10 UTC.
Need to tell us more? [[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-06-10 UTC."],[],[]]