com.google.cloud.bigtable.admin.v2

Class BigtableTableAdminSettings

java.lang.Object

com.google.cloud.bigtable.admin.v2.BigtableTableAdminSettings

public final class BigtableTableAdminSettings
extends Object

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.core.CredentialsProvider	getCredentialsProvider() Gets the credentials provider to use for getting the credentials to make calls with.
String	getInstanceId() Gets the instance ID whose tables the client will manage.
String	getProjectId() Gets the project ID of instance whose tables the client will manage.
BigtableTableAdminStubSettings	getStubSettings() Gets the underlying RPC settings.
static BigtableTableAdminSettings.Builder	newBuilder() Returns a new builder for this class.
static BigtableTableAdminSettings.Builder	newBuilderForEmulator(int port) Create a new builder preconfigured to connect to the Bigtable emulator with port number.
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.
BigtableTableAdminSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class java.lang.Object

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

Method Detail

getProjectId

public String getProjectId()

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

getInstanceId

public String getInstanceId()

Gets the instance ID whose tables the client will manage.

getCredentialsProvider

public com.google.api.gax.core.CredentialsProvider getCredentialsProvider()

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

getStubSettings

public BigtableTableAdminStubSettings getStubSettings()

Gets the underlying RPC settings.

toBuilder

public BigtableTableAdminSettings.Builder toBuilder()

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

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.

newBuilderForEmulator

public static BigtableTableAdminSettings.Builder newBuilderForEmulator(int port)

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

newBuilderForEmulator

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.