Class BigtableInstanceAdminStubSettings (2.44.0)

public class BigtableInstanceAdminStubSettings extends StubSettings<BigtableInstanceAdminStubSettings>

Settings class to configure an instance of BigtableInstanceAdminStub.

The default instance has everything set to sensible defaults:

The default service address (bigtableadmin.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 getInstance:


 // 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
 BigtableInstanceAdminStubSettings.Builder baseBigtableInstanceAdminSettingsBuilder =
     BigtableInstanceAdminStubSettings.newBuilder();
 baseBigtableInstanceAdminSettingsBuilder
     .getInstanceSettings()
     .setRetrySettings(
         baseBigtableInstanceAdminSettingsBuilder
             .getInstanceSettings()
             .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());
 BigtableInstanceAdminStubSettings baseBigtableInstanceAdminSettings =
     baseBigtableInstanceAdminSettingsBuilder.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 createInstance:


 // 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
 BigtableInstanceAdminStubSettings.Builder baseBigtableInstanceAdminSettingsBuilder =
     BigtableInstanceAdminStubSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 baseBigtableInstanceAdminSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > StubSettings > BigtableInstanceAdminStubSettings

Inherited Members

StubSettings.getBackgroundExecutorProvider()

StubSettings.getClock()

StubSettings.getCredentialsProvider()

StubSettings.getEndpoint()

StubSettings.getExecutorProvider()

StubSettings.getGdchApiAudience()

StubSettings.getHeaderProvider()

StubSettings.getInternalHeaderProvider()

StubSettings.getMtlsEndpoint()

StubSettings.getQuotaProjectId()

StubSettings.getServiceName()

StubSettings.getStreamWatchdogCheckInterval()

StubSettings.getStreamWatchdogCheckIntervalDuration()

StubSettings.getStreamWatchdogProvider()

StubSettings.getTracerFactory()

StubSettings.getTransportChannelProvider()

StubSettings.getUniverseDomain()

StubSettings.toBuilder()

StubSettings.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

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`

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS 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 BigtableInstanceAdminStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type	Description
`BigtableInstanceAdminStubSettings.Builder`

newBuilder(ClientContext clientContext)

public static BigtableInstanceAdminStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name	Description
`clientContext`	`ClientContext`

Returns
Type	Description
`BigtableInstanceAdminStubSettings.Builder`

Constructors

BigtableInstanceAdminStubSettings(BigtableInstanceAdminStubSettings.Builder settingsBuilder)

protected BigtableInstanceAdminStubSettings(BigtableInstanceAdminStubSettings.Builder settingsBuilder)

Parameter
Name	Description
`settingsBuilder`	`BigtableInstanceAdminStubSettings.Builder`

Methods

createAppProfileSettings()

public UnaryCallSettings<CreateAppProfileRequest,AppProfile> createAppProfileSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.CreateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>`

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,CreateClusterMetadata> createClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.CreateClusterMetadata>`

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.CreateClusterRequest,Operation>`

createInstanceOperationSettings()

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

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.CreateInstanceMetadata>`

createInstanceSettings()

public UnaryCallSettings<CreateInstanceRequest,Operation> createInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.CreateInstanceRequest,Operation>`

createStub()

public BigtableInstanceAdminStub createStub()

Returns
Type	Description
`com.google.cloud.bigtable.admin.v2.stub.BigtableInstanceAdminStub`

Exceptions
Type	Description
`IOException`

deleteAppProfileSettings()

public UnaryCallSettings<DeleteAppProfileRequest,Empty> deleteAppProfileSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.DeleteAppProfileRequest,Empty>`

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Empty> deleteClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.DeleteClusterRequest,Empty>`

deleteInstanceSettings()

public UnaryCallSettings<DeleteInstanceRequest,Empty> deleteInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.DeleteInstanceRequest,Empty>`

getAppProfileSettings()

public UnaryCallSettings<GetAppProfileRequest,AppProfile> getAppProfileSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.GetAppProfileRequest,com.google.bigtable.admin.v2.AppProfile>`

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.GetClusterRequest,com.google.bigtable.admin.v2.Cluster>`

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>`

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.GetInstanceRequest,com.google.bigtable.admin.v2.Instance>`

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type	Description
`String`

Overrides

StubSettings<SettingsT>.getServiceName()

listAppProfilesSettings()

public PagedCallSettings<ListAppProfilesRequest,ListAppProfilesResponse,BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse> listAppProfilesSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.bigtable.admin.v2.ListAppProfilesRequest,com.google.bigtable.admin.v2.ListAppProfilesResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient.ListAppProfilesPagedResponse>`

listClustersSettings()

public UnaryCallSettings<ListClustersRequest,ListClustersResponse> listClustersSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.ListClustersRequest,com.google.bigtable.admin.v2.ListClustersResponse>`

listHotTabletsSettings()

public PagedCallSettings<ListHotTabletsRequest,ListHotTabletsResponse,BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse> listHotTabletsSettings()

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

Returns
Type	Description
`PagedCallSettings<com.google.bigtable.admin.v2.ListHotTabletsRequest,com.google.bigtable.admin.v2.ListHotTabletsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableInstanceAdminClient.ListHotTabletsPagedResponse>`

listInstancesSettings()

public UnaryCallSettings<ListInstancesRequest,ListInstancesResponse> listInstancesSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.ListInstancesRequest,com.google.bigtable.admin.v2.ListInstancesResponse>`

partialUpdateClusterOperationSettings()

public OperationCallSettings<PartialUpdateClusterRequest,Cluster,PartialUpdateClusterMetadata> partialUpdateClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.PartialUpdateClusterRequest,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.PartialUpdateClusterMetadata>`

partialUpdateClusterSettings()

public UnaryCallSettings<PartialUpdateClusterRequest,Operation> partialUpdateClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.PartialUpdateClusterRequest,Operation>`

partialUpdateInstanceOperationSettings()

public OperationCallSettings<PartialUpdateInstanceRequest,Instance,UpdateInstanceMetadata> partialUpdateInstanceOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.UpdateInstanceMetadata>`

partialUpdateInstanceSettings()

public UnaryCallSettings<PartialUpdateInstanceRequest,Operation> partialUpdateInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.PartialUpdateInstanceRequest,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 BigtableInstanceAdminStubSettings.Builder toBuilder()

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

Returns
Type	Description
`BigtableInstanceAdminStubSettings.Builder`

Overrides

StubSettings<SettingsT>.toBuilder()

updateAppProfileOperationSettings()

public OperationCallSettings<UpdateAppProfileRequest,AppProfile,UpdateAppProfileMetadata> updateAppProfileOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,com.google.bigtable.admin.v2.AppProfile,com.google.bigtable.admin.v2.UpdateAppProfileMetadata>`

updateAppProfileSettings()

public UnaryCallSettings<UpdateAppProfileRequest,Operation> updateAppProfileSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.UpdateAppProfileRequest,Operation>`

updateClusterOperationSettings()

public OperationCallSettings<Cluster,Cluster,UpdateClusterMetadata> updateClusterOperationSettings()

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

Returns
Type	Description
`OperationCallSettings<com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.Cluster,com.google.bigtable.admin.v2.UpdateClusterMetadata>`

updateClusterSettings()

public UnaryCallSettings<Cluster,Operation> updateClusterSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.Cluster,Operation>`

updateInstanceSettings()

public UnaryCallSettings<Instance,Instance> updateInstanceSettings()

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

Returns
Type	Description
`UnaryCallSettings<com.google.bigtable.admin.v2.Instance,com.google.bigtable.admin.v2.Instance>`