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 RetrySettings of getInstanceConfig:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder();
instanceAdminSettingsBuilder
.getInstanceConfigSettings()
.setRetrySettings(
instanceAdminSettingsBuilder
.getInstanceConfigSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
InstanceAdminSettings instanceAdminSettings = instanceAdminSettingsBuilder.build();
Please refer to the Client Side Retry Guide for additional support in setting retries.
To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for createInstanceConfig:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
InstanceAdminSettings.Builder instanceAdminSettingsBuilder = InstanceAdminSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
instanceAdminSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
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 gRPC ChannelProvider for this service.
| Returns | |
|---|---|
| Type | Description |
Builder |
|
defaultHttpJsonTransportProviderBuilder()
public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST 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 gRPC 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 |
|
newHttpJsonBuilder()
public static InstanceAdminSettings.Builder newHttpJsonBuilder()Returns a new REST builder for this class.
| Returns | |
|---|---|
| Type | Description |
InstanceAdminSettings.Builder |
|
Constructors
InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)
protected InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)| Parameter | |
|---|---|
| Name | Description |
settingsBuilder |
InstanceAdminSettings.Builder |
Methods
createInstanceConfigOperationSettings()
public OperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata> createInstanceConfigOperationSettings()Returns the object with the settings used for calls to createInstanceConfig.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata> |
|
createInstanceConfigSettings()
public UnaryCallSettings<CreateInstanceConfigRequest,Operation> createInstanceConfigSettings()Returns the object with the settings used for calls to createInstanceConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstanceConfigRequest,Operation> |
|
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> |
|
createInstancePartitionOperationSettings()
public OperationCallSettings<CreateInstancePartitionRequest,InstancePartition,CreateInstancePartitionMetadata> createInstancePartitionOperationSettings()Returns the object with the settings used for calls to createInstancePartition.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<CreateInstancePartitionRequest,InstancePartition,CreateInstancePartitionMetadata> |
|
createInstancePartitionSettings()
public UnaryCallSettings<CreateInstancePartitionRequest,Operation> createInstancePartitionSettings()Returns the object with the settings used for calls to createInstancePartition.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstancePartitionRequest,Operation> |
|
createInstanceSettings()
public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()Returns the object with the settings used for calls to createInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<CreateInstanceRequest,Operation> |
|
deleteInstanceConfigSettings()
public UnaryCallSettings<DeleteInstanceConfigRequest,Empty> deleteInstanceConfigSettings()Returns the object with the settings used for calls to deleteInstanceConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstanceConfigRequest,Empty> |
|
deleteInstancePartitionSettings()
public UnaryCallSettings<DeleteInstancePartitionRequest,Empty> deleteInstancePartitionSettings()Returns the object with the settings used for calls to deleteInstancePartition.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<DeleteInstancePartitionRequest,Empty> |
|
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> |
|
getInstancePartitionSettings()
public UnaryCallSettings<GetInstancePartitionRequest,InstancePartition> getInstancePartitionSettings()Returns the object with the settings used for calls to getInstancePartition.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstancePartitionRequest,InstancePartition> |
|
getInstanceSettings()
public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()Returns the object with the settings used for calls to getInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<GetInstanceRequest,Instance> |
|
listInstanceConfigOperationsSettings()
public PagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,InstanceAdminClient.ListInstanceConfigOperationsPagedResponse> listInstanceConfigOperationsSettings()Returns the object with the settings used for calls to listInstanceConfigOperations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,ListInstanceConfigOperationsPagedResponse> |
|
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> |
|
listInstancePartitionOperationsSettings()
public PagedCallSettings<ListInstancePartitionOperationsRequest,ListInstancePartitionOperationsResponse,InstanceAdminClient.ListInstancePartitionOperationsPagedResponse> listInstancePartitionOperationsSettings()Returns the object with the settings used for calls to listInstancePartitionOperations.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstancePartitionOperationsRequest,ListInstancePartitionOperationsResponse,ListInstancePartitionOperationsPagedResponse> |
|
listInstancePartitionsSettings()
public PagedCallSettings<ListInstancePartitionsRequest,ListInstancePartitionsResponse,InstanceAdminClient.ListInstancePartitionsPagedResponse> listInstancePartitionsSettings()Returns the object with the settings used for calls to listInstancePartitions.
| Returns | |
|---|---|
| Type | Description |
PagedCallSettings<ListInstancePartitionsRequest,ListInstancePartitionsResponse,ListInstancePartitionsPagedResponse> |
|
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> |
|
moveInstanceOperationSettings()
public OperationCallSettings<MoveInstanceRequest,MoveInstanceResponse,MoveInstanceMetadata> moveInstanceOperationSettings()Returns the object with the settings used for calls to moveInstance.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<MoveInstanceRequest,MoveInstanceResponse,MoveInstanceMetadata> |
|
moveInstanceSettings()
public UnaryCallSettings<MoveInstanceRequest,Operation> moveInstanceSettings()Returns the object with the settings used for calls to moveInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<MoveInstanceRequest,Operation> |
|
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 |
|
updateInstanceConfigOperationSettings()
public OperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata> updateInstanceConfigOperationSettings()Returns the object with the settings used for calls to updateInstanceConfig.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata> |
|
updateInstanceConfigSettings()
public UnaryCallSettings<UpdateInstanceConfigRequest,Operation> updateInstanceConfigSettings()Returns the object with the settings used for calls to updateInstanceConfig.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateInstanceConfigRequest,Operation> |
|
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> |
|
updateInstancePartitionOperationSettings()
public OperationCallSettings<UpdateInstancePartitionRequest,InstancePartition,UpdateInstancePartitionMetadata> updateInstancePartitionOperationSettings()Returns the object with the settings used for calls to updateInstancePartition.
| Returns | |
|---|---|
| Type | Description |
OperationCallSettings<UpdateInstancePartitionRequest,InstancePartition,UpdateInstancePartitionMetadata> |
|
updateInstancePartitionSettings()
public UnaryCallSettings<UpdateInstancePartitionRequest,Operation> updateInstancePartitionSettings()Returns the object with the settings used for calls to updateInstancePartition.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateInstancePartitionRequest,Operation> |
|
updateInstanceSettings()
public UnaryCallSettings<UpdateInstanceRequest,Operation> updateInstanceSettings()Returns the object with the settings used for calls to updateInstance.
| Returns | |
|---|---|
| Type | Description |
UnaryCallSettings<UpdateInstanceRequest,Operation> |
|