com.google.cloud.spanner.admin.instance.v1

Class InstanceAdminSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<InstanceAdminSettings>

com.google.cloud.spanner.admin.instance.v1.InstanceAdminSettings

@Generated(value="by gapic-generator-java")
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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InstanceAdminSettings.Builder Builder for InstanceAdminSettings.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static InstanceAdminSettings	create(InstanceAdminStubSettings stub)
OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata>	createInstanceOperationSettings() Returns the object with the settings used for calls to createInstance.
UnaryCallSettings<CreateInstanceRequest,Operation>	createInstanceSettings() Returns the object with the settings used for calls to createInstance.
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 InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteInstanceRequest,Empty>	deleteInstanceSettings() Returns the object with the settings used for calls to deleteInstance.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig>	getInstanceConfigSettings() Returns the object with the settings used for calls to getInstanceConfig.
UnaryCallSettings<GetInstanceRequest,Instance>	getInstanceSettings() Returns the object with the settings used for calls to getInstance.
PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,InstanceAdminClient.ListInstanceConfigsPagedResponse>	listInstanceConfigsSettings() Returns the object with the settings used for calls to listInstanceConfigs.
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstanceAdminClient.ListInstancesPagedResponse>	listInstancesSettings() Returns the object with the settings used for calls to listInstances.
static InstanceAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static InstanceAdminSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
InstanceAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata>	updateInstanceOperationSettings() Returns the object with the settings used for calls to updateInstance.
UnaryCallSettings<UpdateInstanceRequest,Operation>	updateInstanceSettings() Returns the object with the settings used for calls to updateInstance.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InstanceAdminSettings

protected InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

listInstanceConfigsSettings

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

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

getInstanceConfigSettings

public UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig> getInstanceConfigSettings()

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

listInstancesSettings

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

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

getInstanceSettings

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

createInstanceSettings

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

createInstanceOperationSettings

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

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

updateInstanceSettings

public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()

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

updateInstanceOperationSettings

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

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

deleteInstanceSettings

public UnaryCallSettings<DeleteInstanceRequest,Empty> deleteInstanceSettings()

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

setIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy> setIamPolicySettings()

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

getIamPolicySettings

public UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy> getIamPolicySettings()

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

testIamPermissionsSettings

public UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse> testIamPermissionsSettings()

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

create

public static final InstanceAdminSettings create(InstanceAdminStubSettings 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.

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.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

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

Returns a new builder for this class.

newBuilder

public static InstanceAdminSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public InstanceAdminSettings.Builder toBuilder()

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

Specified by:

toBuilder in class ClientSettings<InstanceAdminSettings>