Class InstanceAdminSettings (6.25.1)

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:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder();
 instanceAdminSettingsBuilder
     .getInstanceConfigSettings()
     .setRetrySettings(
         instanceAdminSettingsBuilder
             .getInstanceConfigSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 InstanceAdminSettings instanceAdminSettings = instanceAdminSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > InstanceAdminSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

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(InstanceAdminStubSettings stub)

public static final InstanceAdminSettings create(InstanceAdminStubSettings stub)

Parameter
Name	Description
`stub`	`InstanceAdminStubSettings`

Returns
Type	Description
`InstanceAdminSettings`

Exceptions
Type	Description
`IOException`

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

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`

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns a new builder for this class.

Returns
Type	Description
`InstanceAdminSettings.Builder`

newBuilder(ClientContext clientContext)

public static InstanceAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`InstanceAdminSettings.Builder`

Constructors

InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)

protected InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`InstanceAdminSettings.Builder`

Methods

createInstanceOperationSettings()

public OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata> createInstanceOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata>`

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<CreateInstanceRequest,Operation>`

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Empty> deleteInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<DeleteInstanceRequest,Empty>`

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
Type	Description
`UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig>`

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<GetInstanceRequest,Instance>`

listInstanceConfigsSettings()

public PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,InstanceAdminClient.ListInstanceConfigsPagedResponse> listInstanceConfigsSettings()

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

Returns
Type	Description
`PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,ListInstanceConfigsPagedResponse>`

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstanceAdminClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
Type	Description
`PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>`

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
Type	Description
`InstanceAdminSettings.Builder`

Overrides

ClientSettings<SettingsT>.<B>toBuilder()

updateInstanceOperationSettings()

public OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata> updateInstanceOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata>`

updateInstanceSettings()

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<UpdateInstanceRequest,Operation>`