Class InstanceAdminSettings (6.89.0)

publicclassInstanceAdminSettingsextendsClientSettings<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_libraryInstanceAdminSettings.BuilderinstanceAdminSettingsBuilder=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());InstanceAdminSettingsinstanceAdminSettings=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_libraryInstanceAdminSettings.BuilderinstanceAdminSettingsBuilder=InstanceAdminSettings.newBuilder();TimedRetryAlgorithmtimedRetryAlgorithm=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();

Inheritance

java.lang.Object > ClientSettings > InstanceAdminSettings

Static Methods

create(InstanceAdminStubSettings stub)

publicstaticfinalInstanceAdminSettingscreate(InstanceAdminStubSettingsstub)
Parameter
NameDescription
stubInstanceAdminStubSettings
Returns
TypeDescription
InstanceAdminSettings
Exceptions
TypeDescription
IOException

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

publicstaticInstanceAdminSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
TypeDescription
InstanceAdminSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticInstanceAdminSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
InstanceAdminSettings.Builder

newHttpJsonBuilder()

publicstaticInstanceAdminSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
TypeDescription
InstanceAdminSettings.Builder

Constructors

InstanceAdminSettings(InstanceAdminSettings.Builder settingsBuilder)

protectedInstanceAdminSettings(InstanceAdminSettings.BuildersettingsBuilder)
Parameter
NameDescription
settingsBuilderInstanceAdminSettings.Builder

Methods

createInstanceConfigOperationSettings()

publicOperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata>createInstanceConfigOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateInstanceConfigRequest,InstanceConfig,CreateInstanceConfigMetadata>

createInstanceConfigSettings()

publicUnaryCallSettings<CreateInstanceConfigRequest,Operation>createInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstanceConfigRequest,Operation>

createInstanceOperationSettings()

publicOperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata>createInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateInstanceRequest,Instance,CreateInstanceMetadata>

createInstancePartitionOperationSettings()

publicOperationCallSettings<CreateInstancePartitionRequest,InstancePartition,CreateInstancePartitionMetadata>createInstancePartitionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<CreateInstancePartitionRequest,InstancePartition,CreateInstancePartitionMetadata>

createInstancePartitionSettings()

publicUnaryCallSettings<CreateInstancePartitionRequest,Operation>createInstancePartitionSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstancePartitionRequest,Operation>

createInstanceSettings()

publicUnaryCallSettings<CreateInstanceRequest,Operation>createInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateInstanceRequest,Operation>

deleteInstanceConfigSettings()

publicUnaryCallSettings<DeleteInstanceConfigRequest,Empty>deleteInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstanceConfigRequest,Empty>

deleteInstancePartitionSettings()

publicUnaryCallSettings<DeleteInstancePartitionRequest,Empty>deleteInstancePartitionSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstancePartitionRequest,Empty>

deleteInstanceSettings()

publicUnaryCallSettings<DeleteInstanceRequest,Empty>deleteInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteInstanceRequest,Empty>

getIamPolicySettings()

publicUnaryCallSettings<GetIamPolicyRequest,Policy>getIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getInstanceConfigSettings()

publicUnaryCallSettings<GetInstanceConfigRequest,InstanceConfig>getInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceConfigRequest,InstanceConfig>

getInstancePartitionSettings()

publicUnaryCallSettings<GetInstancePartitionRequest,InstancePartition>getInstancePartitionSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstancePartitionRequest,InstancePartition>

getInstanceSettings()

publicUnaryCallSettings<GetInstanceRequest,Instance>getInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetInstanceRequest,Instance>

listInstanceConfigOperationsSettings()

publicPagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,InstanceAdminClient.ListInstanceConfigOperationsPagedResponse>listInstanceConfigOperationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstanceConfigOperationsRequest,ListInstanceConfigOperationsResponse,ListInstanceConfigOperationsPagedResponse>

listInstanceConfigsSettings()

publicPagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,InstanceAdminClient.ListInstanceConfigsPagedResponse>listInstanceConfigsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstanceConfigsRequest,ListInstanceConfigsResponse,ListInstanceConfigsPagedResponse>

listInstancePartitionOperationsSettings()

publicPagedCallSettings<ListInstancePartitionOperationsRequest,ListInstancePartitionOperationsResponse,InstanceAdminClient.ListInstancePartitionOperationsPagedResponse>listInstancePartitionOperationsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstancePartitionOperationsRequest,ListInstancePartitionOperationsResponse,ListInstancePartitionOperationsPagedResponse>

listInstancePartitionsSettings()

publicPagedCallSettings<ListInstancePartitionsRequest,ListInstancePartitionsResponse,InstanceAdminClient.ListInstancePartitionsPagedResponse>listInstancePartitionsSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstancePartitionsRequest,ListInstancePartitionsResponse,ListInstancePartitionsPagedResponse>

listInstancesSettings()

publicPagedCallSettings<ListInstancesRequest,ListInstancesResponse,InstanceAdminClient.ListInstancesPagedResponse>listInstancesSettings()

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

Returns
TypeDescription
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

moveInstanceOperationSettings()

publicOperationCallSettings<MoveInstanceRequest,MoveInstanceResponse,MoveInstanceMetadata>moveInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<MoveInstanceRequest,MoveInstanceResponse,MoveInstanceMetadata>

moveInstanceSettings()

publicUnaryCallSettings<MoveInstanceRequest,Operation>moveInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<MoveInstanceRequest,Operation>

setIamPolicySettings()

publicUnaryCallSettings<SetIamPolicyRequest,Policy>setIamPolicySettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

testIamPermissionsSettings()

publicUnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse>testIamPermissionsSettings()

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

Returns
TypeDescription
UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

toBuilder()

publicInstanceAdminSettings.BuildertoBuilder()

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

Returns
TypeDescription
InstanceAdminSettings.Builder
Overrides

updateInstanceConfigOperationSettings()

publicOperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata>updateInstanceConfigOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateInstanceConfigRequest,InstanceConfig,UpdateInstanceConfigMetadata>

updateInstanceConfigSettings()

publicUnaryCallSettings<UpdateInstanceConfigRequest,Operation>updateInstanceConfigSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceConfigRequest,Operation>

updateInstanceOperationSettings()

publicOperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata>updateInstanceOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateInstanceRequest,Instance,UpdateInstanceMetadata>

updateInstancePartitionOperationSettings()

publicOperationCallSettings<UpdateInstancePartitionRequest,InstancePartition,UpdateInstancePartitionMetadata>updateInstancePartitionOperationSettings()

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

Returns
TypeDescription
OperationCallSettings<UpdateInstancePartitionRequest,InstancePartition,UpdateInstancePartitionMetadata>

updateInstancePartitionSettings()

publicUnaryCallSettings<UpdateInstancePartitionRequest,Operation>updateInstancePartitionSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstancePartitionRequest,Operation>

updateInstanceSettings()

publicUnaryCallSettings<UpdateInstanceRequest,Operation>updateInstanceSettings()

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

Returns
TypeDescription
UnaryCallSettings<UpdateInstanceRequest,Operation>