com.google.cloud.bigtable.admin.v2.stub

Class BigtableTableAdminStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<BigtableTableAdminStubSettings>

com.google.cloud.bigtable.admin.v2.stub.BigtableTableAdminStubSettings

@Generated(value="by gapic-generator-java")
public class BigtableTableAdminStubSettings
extends com.google.api.gax.rpc.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();
 

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<CheckConsistencyRequest,CheckConsistencyResponse>	checkConsistencySettings() Returns the object with the settings used for calls to checkConsistency.
com.google.api.gax.rpc.OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata>	createBackupOperationSettings() Returns the object with the settings used for calls to createBackup.
com.google.api.gax.rpc.UnaryCallSettings<CreateBackupRequest,com.google.longrunning.Operation>	createBackupSettings() Returns the object with the settings used for calls to createBackup.
com.google.cloud.bigtable.admin.v2.stub.BigtableTableAdminStub	createStub()
com.google.api.gax.rpc.OperationCallSettings<CreateTableFromSnapshotRequest,Table,CreateTableFromSnapshotMetadata>	createTableFromSnapshotOperationSettings() Returns the object with the settings used for calls to createTableFromSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<CreateTableFromSnapshotRequest,com.google.longrunning.Operation>	createTableFromSnapshotSettings() Returns the object with the settings used for calls to createTableFromSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<CreateTableRequest,Table>	createTableSettings() Returns the object with the settings used for calls to createTable.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<DeleteBackupRequest,com.google.protobuf.Empty>	deleteBackupSettings() Returns the object with the settings used for calls to deleteBackup.
com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty>	deleteSnapshotSettings() Returns the object with the settings used for calls to deleteSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<DeleteTableRequest,com.google.protobuf.Empty>	deleteTableSettings() Returns the object with the settings used for calls to deleteTable.
com.google.api.gax.rpc.UnaryCallSettings<DropRowRangeRequest,com.google.protobuf.Empty>	dropRowRangeSettings() Returns the object with the settings used for calls to dropRowRange.
com.google.api.gax.rpc.UnaryCallSettings<GenerateConsistencyTokenRequest,GenerateConsistencyTokenResponse>	generateConsistencyTokenSettings() Returns the object with the settings used for calls to generateConsistencyToken.
com.google.api.gax.rpc.UnaryCallSettings<GetBackupRequest,Backup>	getBackupSettings() Returns the object with the settings used for calls to getBackup.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>	getIamPolicySettings() Returns the object with the settings used for calls to getIamPolicy.
com.google.api.gax.rpc.UnaryCallSettings<GetSnapshotRequest,Snapshot>	getSnapshotSettings() Returns the object with the settings used for calls to getSnapshot.
com.google.api.gax.rpc.UnaryCallSettings<GetTableRequest,Table>	getTableSettings() Returns the object with the settings used for calls to getTable.
com.google.api.gax.rpc.PagedCallSettings<ListBackupsRequest,ListBackupsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListBackupsPagedResponse>	listBackupsSettings() Returns the object with the settings used for calls to listBackups.
com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListSnapshotsPagedResponse>	listSnapshotsSettings() Returns the object with the settings used for calls to listSnapshots.
com.google.api.gax.rpc.PagedCallSettings<ListTablesRequest,ListTablesResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListTablesPagedResponse>	listTablesSettings() Returns the object with the settings used for calls to listTables.
com.google.api.gax.rpc.UnaryCallSettings<ModifyColumnFamiliesRequest,Table>	modifyColumnFamiliesSettings() Returns the object with the settings used for calls to modifyColumnFamilies.
static BigtableTableAdminStubSettings.Builder	newBuilder() Returns a new builder for this class.
static BigtableTableAdminStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.OperationCallSettings<RestoreTableRequest,Table,RestoreTableMetadata>	restoreTableOperationSettings() Returns the object with the settings used for calls to restoreTable.
com.google.api.gax.rpc.UnaryCallSettings<RestoreTableRequest,com.google.longrunning.Operation>	restoreTableSettings() Returns the object with the settings used for calls to restoreTable.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>	setIamPolicySettings() Returns the object with the settings used for calls to setIamPolicy.
com.google.api.gax.rpc.OperationCallSettings<SnapshotTableRequest,Snapshot,SnapshotTableMetadata>	snapshotTableOperationSettings() Returns the object with the settings used for calls to snapshotTable.
com.google.api.gax.rpc.UnaryCallSettings<SnapshotTableRequest,com.google.longrunning.Operation>	snapshotTableSettings() Returns the object with the settings used for calls to snapshotTable.
com.google.api.gax.rpc.UnaryCallSettings<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>	testIamPermissionsSettings() Returns the object with the settings used for calls to testIamPermissions.
BigtableTableAdminStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.OperationCallSettings<UndeleteTableRequest,Table,UndeleteTableMetadata>	undeleteTableOperationSettings() Returns the object with the settings used for calls to undeleteTable.
com.google.api.gax.rpc.UnaryCallSettings<UndeleteTableRequest,com.google.longrunning.Operation>	undeleteTableSettings() Returns the object with the settings used for calls to undeleteTable.
com.google.api.gax.rpc.UnaryCallSettings<UpdateBackupRequest,Backup>	updateBackupSettings() Returns the object with the settings used for calls to updateBackup.
com.google.api.gax.rpc.OperationCallSettings<UpdateTableRequest,Table,UpdateTableMetadata>	updateTableOperationSettings() Returns the object with the settings used for calls to updateTable.
com.google.api.gax.rpc.UnaryCallSettings<UpdateTableRequest,com.google.longrunning.Operation>	updateTableSettings() Returns the object with the settings used for calls to updateTable.

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

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

BigtableTableAdminStubSettings

protected BigtableTableAdminStubSettings(BigtableTableAdminStubSettings.Builder settingsBuilder)
                                  throws IOException

Throws:

IOException

Method Detail

createTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTableRequest,Table> createTableSettings()

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

createTableFromSnapshotSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateTableFromSnapshotRequest,com.google.longrunning.Operation> createTableFromSnapshotSettings()

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

createTableFromSnapshotOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateTableFromSnapshotRequest,Table,CreateTableFromSnapshotMetadata> createTableFromSnapshotOperationSettings()

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

listTablesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListTablesRequest,ListTablesResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListTablesPagedResponse> listTablesSettings()

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

getTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetTableRequest,Table> getTableSettings()

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

updateTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateTableRequest,com.google.longrunning.Operation> updateTableSettings()

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

updateTableOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UpdateTableRequest,Table,UpdateTableMetadata> updateTableOperationSettings()

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

deleteTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteTableRequest,com.google.protobuf.Empty> deleteTableSettings()

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

undeleteTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<UndeleteTableRequest,com.google.longrunning.Operation> undeleteTableSettings()

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

undeleteTableOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<UndeleteTableRequest,Table,UndeleteTableMetadata> undeleteTableOperationSettings()

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

modifyColumnFamiliesSettings

public com.google.api.gax.rpc.UnaryCallSettings<ModifyColumnFamiliesRequest,Table> modifyColumnFamiliesSettings()

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

dropRowRangeSettings

public com.google.api.gax.rpc.UnaryCallSettings<DropRowRangeRequest,com.google.protobuf.Empty> dropRowRangeSettings()

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

generateConsistencyTokenSettings

public com.google.api.gax.rpc.UnaryCallSettings<GenerateConsistencyTokenRequest,GenerateConsistencyTokenResponse> generateConsistencyTokenSettings()

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

checkConsistencySettings

public com.google.api.gax.rpc.UnaryCallSettings<CheckConsistencyRequest,CheckConsistencyResponse> checkConsistencySettings()

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

snapshotTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<SnapshotTableRequest,com.google.longrunning.Operation> snapshotTableSettings()

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

snapshotTableOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<SnapshotTableRequest,Snapshot,SnapshotTableMetadata> snapshotTableOperationSettings()

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

getSnapshotSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetSnapshotRequest,Snapshot> getSnapshotSettings()

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

listSnapshotsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListSnapshotsRequest,ListSnapshotsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListSnapshotsPagedResponse> listSnapshotsSettings()

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

deleteSnapshotSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteSnapshotRequest,com.google.protobuf.Empty> deleteSnapshotSettings()

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

createBackupSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateBackupRequest,com.google.longrunning.Operation> createBackupSettings()

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

createBackupOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<CreateBackupRequest,Backup,CreateBackupMetadata> createBackupOperationSettings()

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

getBackupSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetBackupRequest,Backup> getBackupSettings()

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

updateBackupSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateBackupRequest,Backup> updateBackupSettings()

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

deleteBackupSettings

public com.google.api.gax.rpc.UnaryCallSettings<DeleteBackupRequest,com.google.protobuf.Empty> deleteBackupSettings()

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

listBackupsSettings

public com.google.api.gax.rpc.PagedCallSettings<ListBackupsRequest,ListBackupsResponse,com.google.cloud.bigtable.admin.v2.BaseBigtableTableAdminClient.ListBackupsPagedResponse> listBackupsSettings()

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

restoreTableSettings

public com.google.api.gax.rpc.UnaryCallSettings<RestoreTableRequest,com.google.longrunning.Operation> restoreTableSettings()

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

restoreTableOperationSettings

public com.google.api.gax.rpc.OperationCallSettings<RestoreTableRequest,Table,RestoreTableMetadata> restoreTableOperationSettings()

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

getIamPolicySettings

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

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

setIamPolicySettings

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

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

testIamPermissionsSettings

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

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

createStub

public com.google.cloud.bigtable.admin.v2.stub.BigtableTableAdminStub createStub()
                                                                          throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static BigtableTableAdminStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static BigtableTableAdminStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BigtableTableAdminStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<BigtableTableAdminStubSettings>