Class BigtableTableAdminSettings (2.31.0)

public final class BigtableTableAdminSettings

Settings class to configure an instance of BigtableTableAdminClient.

It must be configured with a project ID and instance ID.

Example usage:


 BigtableTableAdminSettings.Builder tableAdminSettingsBuilder = BigtableTableAdminSettings.newBuilder()
   .setProjectId("my-project")
   .setInstanceId("my-instance");

 tableAdminSettingsBuilder.stubSettings().createTableSettings()
   .setRetrySettings(
     RetrySettings.newBuilder()
       .setTotalTimeout(Duration.ofMinutes(15))
       .build());

 BigtableTableAdminSettings tableAdminSettings = tableAdminSettingsBuilder.build();
 

Inheritance

java.lang.Object > BigtableTableAdminSettings

Static Methods

newBuilder()

public static BigtableTableAdminSettings.Builder newBuilder()

Returns a new builder for this class.

If emulator configuration provided in BIGTABLE_EMULATOR_HOST environment variable then it creates a builder preconfigured to connect to Bigtable using emulator hostname and port number.

Returns
TypeDescription
BigtableTableAdminSettings.Builder

newBuilderForEmulator(int port)

public static BigtableTableAdminSettings.Builder newBuilderForEmulator(int port)

Create a new builder preconfigured to connect to the Bigtable emulator with port number.

Parameter
NameDescription
portint
Returns
TypeDescription
BigtableTableAdminSettings.Builder

newBuilderForEmulator(String hostname, int port)

public static BigtableTableAdminSettings.Builder newBuilderForEmulator(String hostname, int port)

Creates a new builder preconfigured to connect to the Bigtable emulator with host name and port number.

Parameters
NameDescription
hostnameString
portint
Returns
TypeDescription
BigtableTableAdminSettings.Builder

Methods

getCredentialsProvider()

public CredentialsProvider getCredentialsProvider()

Gets the credentials provider to use for getting the credentials to make calls with.

Returns
TypeDescription
CredentialsProvider

getInstanceId()

public String getInstanceId()

Gets the instance ID whose tables the client will manage.

Returns
TypeDescription
String

getProjectId()

public String getProjectId()

Gets the project ID of instance whose tables the client will manage.

Returns
TypeDescription
String

getStubSettings()

public BigtableTableAdminStubSettings getStubSettings()

Gets the underlying RPC settings.

Returns
TypeDescription
BigtableTableAdminStubSettings

toBuilder()

public BigtableTableAdminSettings.Builder toBuilder()

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

Returns
TypeDescription
BigtableTableAdminSettings.Builder

toString()

public String toString()
Returns
TypeDescription
String
Overrides