Class BigtableTableAdminStubSettings (2.39.2) 

public class BigtableTableAdminStubSettings extends StubSettings<BigtableTableAdminStubSettings>

Settings class to configure an instance of BigtableTableAdminStub.

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 total timeout of createTable to 30 seconds:


 // 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
 BigtableTableAdminStubSettings.Builder baseBigtableTableAdminSettingsBuilder =
     BigtableTableAdminStubSettings.newBuilder();
 baseBigtableTableAdminSettingsBuilder
     .createTableSettings()
     .setRetrySettings(
         baseBigtableTableAdminSettingsBuilder
             .createTableSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BigtableTableAdminStubSettings baseBigtableTableAdminSettings =
     baseBigtableTableAdminSettingsBuilder.build();

Inheritance

java.lang.Object > StubSettings > BigtableTableAdminStubSettings

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

Returns a new builder for this class.

Returns
Type Description
BigtableTableAdminStubSettings.Builder

newBuilder(ClientContext clientContext)

public static BigtableTableAdminStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BigtableTableAdminStubSettings.Builder

Constructors

BigtableTableAdminStubSettings(BigtableTableAdminStubSettings.Builder settingsBuilder)

protected BigtableTableAdminStubSettings(BigtableTableAdminStubSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder BigtableTableAdminStubSettings.Builder

Methods

checkConsistencySettings()

public UnaryCallSettings<CheckConsistencyRequest,CheckConsistencyResponse> checkConsistencySettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.CheckConsistencyRequest,com.google.bigtable.admin.v2.CheckConsistencyResponse>

copyBackupOperationSettings()

public OperationCallSettings<CopyBackupRequest,Backup,CopyBackupMetadata> copyBackupOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.CopyBackupRequest,com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CopyBackupMetadata>

copyBackupSettings()

public UnaryCallSettings<CopyBackupRequest,Operation> copyBackupSettings()

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

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

createAuthorizedViewOperationSettings()

public OperationCallSettings<CreateAuthorizedViewRequest,AuthorizedView,CreateAuthorizedViewMetadata> createAuthorizedViewOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.CreateAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.CreateAuthorizedViewMetadata>

createAuthorizedViewSettings()

public UnaryCallSettings<CreateAuthorizedViewRequest,Operation> createAuthorizedViewSettings()

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

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

createBackupOperationSettings()

public OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.CreateBackupRequest,com.google.bigtable.admin.v2.Backup,com.google.bigtable.admin.v2.CreateBackupMetadata>

createBackupSettings()

public UnaryCallSettings<CreateBackupRequest,Operation> createBackupSettings()

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

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

createStub()

public BigtableTableAdminStub createStub()
Returns
Type Description
com.google.cloud.bigtable.admin.v2.stub.BigtableTableAdminStub
Exceptions
Type Description
IOException

createTableFromSnapshotOperationSettings()

public OperationCallSettings<CreateTableFromSnapshotRequest,Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.CreateTableFromSnapshotRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.CreateTableFromSnapshotMetadata>

createTableFromSnapshotSettings()

public UnaryCallSettings<CreateTableFromSnapshotRequest,Operation> createTableFromSnapshotSettings()

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

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

createTableSettings()

public UnaryCallSettings<CreateTableRequest,Table> createTableSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.CreateTableRequest,com.google.bigtable.admin.v2.Table>

deleteAuthorizedViewSettings()

public UnaryCallSettings<DeleteAuthorizedViewRequest,Empty> deleteAuthorizedViewSettings()

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

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

deleteBackupSettings()

public UnaryCallSettings<DeleteBackupRequest,Empty> deleteBackupSettings()

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

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

deleteSnapshotSettings()

public UnaryCallSettings<DeleteSnapshotRequest,Empty> deleteSnapshotSettings()

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

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

deleteTableSettings()

public UnaryCallSettings<DeleteTableRequest,Empty> deleteTableSettings()

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

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

dropRowRangeSettings()

public UnaryCallSettings<DropRowRangeRequest,Empty> dropRowRangeSettings()

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

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

generateConsistencyTokenSettings()

public UnaryCallSettings<GenerateConsistencyTokenRequest,GenerateConsistencyTokenResponse> generateConsistencyTokenSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.GenerateConsistencyTokenRequest,com.google.bigtable.admin.v2.GenerateConsistencyTokenResponse>

getAuthorizedViewSettings()

public UnaryCallSettings<GetAuthorizedViewRequest,AuthorizedView> getAuthorizedViewSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.GetAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView>

getBackupSettings()

public UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.GetBackupRequest,com.google.bigtable.admin.v2.Backup>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
Type Description
String
Overrides

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>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getSnapshotSettings()

public UnaryCallSettings<GetSnapshotRequest,Snapshot> getSnapshotSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.GetSnapshotRequest,com.google.bigtable.admin.v2.Snapshot>

getTableSettings()

public UnaryCallSettings<GetTableRequest,Table> getTableSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.GetTableRequest,com.google.bigtable.admin.v2.Table>

listAuthorizedViewsSettings()

public PagedCallSettings<ListAuthorizedViewsRequest,ListAuthorizedViewsResponse,BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse> listAuthorizedViewsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.bigtable.admin.v2.ListAuthorizedViewsRequest,com.google.bigtable.admin.v2.ListAuthorizedViewsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListAuthorizedViewsPagedResponse>

listBackupsSettings()

public PagedCallSettings<ListBackupsRequest,ListBackupsResponse,BaseBigtableTableAdminClient.ListBackupsPagedResponse> listBackupsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.bigtable.admin.v2.ListBackupsRequest,com.google.bigtable.admin.v2.ListBackupsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListBackupsPagedResponse>

listSnapshotsSettings()

public PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,BaseBigtableTableAdminClient.ListSnapshotsPagedResponse> listSnapshotsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.bigtable.admin.v2.ListSnapshotsRequest,com.google.bigtable.admin.v2.ListSnapshotsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListSnapshotsPagedResponse>

listTablesSettings()

public PagedCallSettings<ListTablesRequest,ListTablesResponse,BaseBigtableTableAdminClient.ListTablesPagedResponse> listTablesSettings()

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

Returns
Type Description
PagedCallSettings<com.google.bigtable.admin.v2.ListTablesRequest,com.google.bigtable.admin.v2.ListTablesResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListTablesPagedResponse>

modifyColumnFamiliesSettings()

public UnaryCallSettings<ModifyColumnFamiliesRequest,Table> modifyColumnFamiliesSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.ModifyColumnFamiliesRequest,com.google.bigtable.admin.v2.Table>

restoreTableOperationSettings()

public OperationCallSettings<RestoreTableRequest,Table,RestoreTableMetadata> restoreTableOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.RestoreTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.RestoreTableMetadata>

restoreTableSettings()

public UnaryCallSettings<RestoreTableRequest,Operation> restoreTableSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.RestoreTableRequest,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>

snapshotTableOperationSettings()

public OperationCallSettings<SnapshotTableRequest,Snapshot,SnapshotTableMetadata> snapshotTableOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.SnapshotTableRequest,com.google.bigtable.admin.v2.Snapshot,com.google.bigtable.admin.v2.SnapshotTableMetadata>

snapshotTableSettings()

public UnaryCallSettings<SnapshotTableRequest,Operation> snapshotTableSettings()

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

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

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 BigtableTableAdminStubSettings.Builder toBuilder()

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

Returns
Type Description
BigtableTableAdminStubSettings.Builder
Overrides

undeleteTableOperationSettings()

public OperationCallSettings<UndeleteTableRequest,Table,UndeleteTableMetadata> undeleteTableOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.UndeleteTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UndeleteTableMetadata>

undeleteTableSettings()

public UnaryCallSettings<UndeleteTableRequest,Operation> undeleteTableSettings()

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

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

updateAuthorizedViewOperationSettings()

public OperationCallSettings<UpdateAuthorizedViewRequest,AuthorizedView,UpdateAuthorizedViewMetadata> updateAuthorizedViewOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.UpdateAuthorizedViewRequest,com.google.bigtable.admin.v2.AuthorizedView,com.google.bigtable.admin.v2.UpdateAuthorizedViewMetadata>

updateAuthorizedViewSettings()

public UnaryCallSettings<UpdateAuthorizedViewRequest,Operation> updateAuthorizedViewSettings()

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

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

updateBackupSettings()

public UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.bigtable.admin.v2.UpdateBackupRequest,com.google.bigtable.admin.v2.Backup>

updateTableOperationSettings()

public OperationCallSettings<UpdateTableRequest,Table,UpdateTableMetadata> updateTableOperationSettings()

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

Returns
Type Description
OperationCallSettings<com.google.bigtable.admin.v2.UpdateTableRequest,com.google.bigtable.admin.v2.Table,com.google.bigtable.admin.v2.UpdateTableMetadata>

updateTableSettings()

public UnaryCallSettings<UpdateTableRequest,Operation> updateTableSettings()

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

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