Class BigtableTableAdminSettings (2.28.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

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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
Type	Description
`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
Name	Description
`port`	`int`

Returns
Type	Description
`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
Name	Description
`hostname`	`String`
`port`	`int`

Returns
Type	Description
`BigtableTableAdminSettings.Builder`

Methods

getCredentialsProvider()

public CredentialsProvider getCredentialsProvider()

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

Returns
Type	Description
`CredentialsProvider`

getInstanceId()

public String getInstanceId()

Gets the instance ID whose tables the client will manage.

Returns
Type	Description
`String`

getProjectId()

public String getProjectId()

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

Returns
Type	Description
`String`

getStubSettings()

public BigtableTableAdminStubSettings getStubSettings()

Gets the underlying RPC settings.

Returns
Type	Description
`BigtableTableAdminStubSettings`

toBuilder()

public BigtableTableAdminSettings.Builder toBuilder()

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

Returns
Type	Description
`BigtableTableAdminSettings.Builder`

toString()

public String toString()

Returns
Type	Description
`String`

Overrides

Object.toString()